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