DomainConfiguration - Amazon Serverless Application Model
语法属性示例
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

DomainConfiguration

为 API 配置自定义域。

语法

要在Amazon Serverless Application Model (Amazon SAM) 模板中声明此实体，请使用以下语法。

属性

BasePath

要使用Amazon API Gateway 域名配置的基本路径列表。

类型：清单

必需：否

默认：/

Amazon CloudFormation兼容性：此属性类似于AWS::ApiGateway::BasePathMapping资源的BasePath属性。 Amazon SAM创建多个AWS::ApiGateway::BasePathMapping资源，每个资源在此属性中BasePath指定一个。

NormalizeBasePath

指示是否允许在BasePath属性定义的基本路径中使用非字母数字字符。设置为时True，将从基本路径中删除非字母数字字符。

NormalizeBasePath与该BasePath属性一起使用。

类型：布尔值

必需：否

默认：真

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

CertificateArn

此域名的终端节点的 Amazon 资源名称 (ARN)。Amazon Amazon Certificate Manager是唯一受支持的源。

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性类似于AWS::ApiGateway::DomainName资源的CertificateArn属性。如果设置EndpointConfiguration为REGIONAL（默认值），则CertificateArn映射到 i RegionalCertificateArnnAWS::ApiGateway::DomainName。如果设置EndpointConfiguration为，则CertificateArn映射到 i CertificateArnnAWS::ApiGateway::DomainName。EDGE

其他说明：对于终EDGE端节点，您必须在us-east-1Amazon区域中创建证书。

DomainName

API Gateway API 的自定义域名。不支持大写字母。

Amazon SAM设置此属性时生成AWS::ApiGateway::DomainName资源。有关此方案的信息，请参阅指定了 DomainName 属性。有关生成的Amazon CloudFormation资源的信息，请参阅Amazon CloudFormation。

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性直接传递给AWS::ApiGateway::DomainName资源的DomainName属性。

EndpointConfiguration

定义要映射到自定义域的 API Gateway 端点的类型。此属性的值决定了该CertificateArn属性的映射方式Amazon CloudFormation。

有效值：REGIONAL 或 EDGE

类型：字符串

必需：否

默认值：REGIONAL

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

MutualTlsAuthentication

自定义域名的相互 TLS 安全性 (TLS) 身份验证配置。

类型：MutualTlsAuthentication

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::ApiGateway::DomainName资源的MutualTlsAuthentication属性。

OwnershipVerificationCertificateArn

ACM 颁发的用于验证自定义域所有权的公有证书的 ARN。仅在配置双向 TLS 并指定导入或私有 CA 证书 ARN 作为 Arn 时才需要CertificateArn。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::ApiGateway::DomainName资源的OwnershipVerificationCertificateArn属性。

Route53

定义亚马逊 Route 53 配置。

类型：Route53 配置

必需：否

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

SecurityPolicy

TLS 版本加上此域名的密码套件。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::ApiGateway::DomainName资源的SecurityPolicy属性。

示例

DomainName

DomainName 示例

YAML

Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: EDGE
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - foo
    - bar