本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
HttpApiDomainConfiguration
为 API 配置自定义域。
语法
要在您的 Amazon Serverless Application Model (Amazon SAM) 模板中声明此实体,请使用以下语法。
YAML
BasePath:
List
CertificateArn:String
DomainName:String
EndpointConfiguration:String
MutualTlsAuthentication:MutualTlsAuthentication
OwnershipVerificationCertificateArn:String
Route53:Route53Configuration
SecurityPolicy:String
属性
-
BasePath
-
要使用 Amazon API Gateway 域名配置的基本路径列表。
类型:列表
必需:否
默认值:/
Amazon CloudFormation 兼容性:此属性类似于
AWS::ApiGatewayV2::ApiMapping
资源的ApiMappingKey
属性。Amazon SAM 会创建多个AWS::ApiGatewayV2::ApiMapping
资源,在此属性中指定的每个值都有一个资源。 -
CertificateArn
-
此域名端点的 Amazon 托管证书的 Amazon 资源名称(ARN)。Amazon Certificate Manager 是唯一受支持的源。
类型:字符串
必需:是
Amazon CloudFormation 兼容性:此属性直接传递给
AWS::ApiGateway2::DomainName DomainNameConfiguration
资源的CertificateArn
属性。 -
DomainName
-
API Gateway API 的自定义域名。不支持大写字母。
如果设置了此属性,Amazon SAM 会生成
AWS::ApiGatewayV2::DomainName
资源。有关此场景的更多信息,请参阅DomainName属性已指定。有关生成的 Amazon CloudFormation 资源的信息,请参阅 生成的 Amazon CloudFormation 资源用于 Amazon SAM。类型:字符串
必需:是
Amazon CloudFormation 兼容性:此属性直接传递给
AWS::ApiGateway2::DomainName
资源的DomainName
属性。 -
EndpointConfiguration
-
定义要映射到自定义域的 API Gateway 端点的类型。此属性的值决定了
CertificateArn
属性在 Amazon CloudFormation 中的映射方式。HTTP API 唯一的有效值为
REGIONAL
。类型:字符串
必需:否
默认值:
REGIONAL
Amazon CloudFormation 兼容性:此属性为 Amazon SAM 独有,没有 Amazon CloudFormation 等效属性。
-
MutualTlsAuthentication
-
自定义域名的相互传输层安全性协议(TLS)身份验证配置。
必需:否
Amazon CloudFormation 兼容性:此属性直接传递给
AWS::ApiGatewayV2::DomainName
资源的MutualTlsAuthentication
属性。 -
OwnershipVerificationCertificateArn
-
ACM 颁发的用于验证自定义域所有权的公有证书的 ARN。只有在配置双向 TLS 并且为
CertificateArn
指定了 ACM 导入的或私有 CA 证书 ARN 时才需要。类型:字符串
必需:否
Amazon CloudFormation 兼容性:此属性直接传递给
AWS::ApiGatewayV2::DomainName
DomainNameConfiguration
数据类型的OwnershipVerificationCertificateArn
属性。 -
Route53
-
定义 Amazon Route 53 配置。
必需:否
Amazon CloudFormation 兼容性:此属性为 Amazon SAM 独有,没有 Amazon CloudFormation 等效属性。
-
SecurityPolicy
-
此域名的安全策略的 TLS 版本。
HTTP API 唯一的有效值为
TLS_1_2
。类型:字符串
必需:否
Amazon CloudFormation 兼容性:此属性直接传递给
AWS::ApiGatewayV2::DomainName
DomainNameConfiguration
数据类型的SecurityPolicy
属性。
示例
DomainName
DomainName 示例
YAML
Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: REGIONAL Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - foo - bar