DomainConfiguration - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

DomainConfiguration

为 API 配置自定义域。

Syntax

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

Properties

BasePath

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

类型:List

必需:否

默认值:/

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

CertificateArn

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

类型:String

必需:是

Amazon CloudFormation兼容性:此属性类似于CertificateArn一个的财产AWS::ApiGateway::DomainName资源。如果EndpointConfiguration设置为REGIONAL(默认值),CertificateArn映射到RegionalCertificateArnAWS::ApiGateway::DomainName. 如果EndpointConfiguration设置为EDGECertificateArn映射到CertificateArnAWS::ApiGateway::DomainName.

附加说明:对于EDGE终端节点,您必须在us-east-1 Amazon区域。

DomainName

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

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

类型:String

必需:是

Amazon CloudFormation兼容性:此属性将直接传递给DomainName一个的财产AWS::ApiGateway::DomainName资源。

EndpointConfiguration

定义要映射到自定义域的 API Gateway 终端节点的类型。此属性的价值决定了如何CertificateArn属性被映射在Amazon CloudFormation.

有效值REGIONALEDGE

类型:String

必需:否

默认值REGIONAL

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

MutualTlsAuthentication

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

类型MutualTlsAuthentication

必需:否

Amazon CloudFormation兼容性:此属性将直接传递给MutualTlsAuthentication一个的财产AWS::ApiGateway::DomainName资源。

Route53

定义亚马逊路线 53 配置。

类型Route53 配置

必需:否

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

SecurityPolicy

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

类型:String

必需:否

Amazon CloudFormation兼容性:此属性将直接传递给SecurityPolicy一个的财产AWS::ApiGateway::DomainName资源。

Examples

DomainName

DomainName

YAML

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