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

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

HttpApiDomainConfiguration

为 API 配置自定义域。

语法

在您的 中声明此实体 AWS 无服务器应用程序模型 (AWS SAM) 模板时,请使用以下语法。

属性

BasePath

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

类型:列表

必需: 否

默认值:/

兼容性AWS CloudFormation: 该属性类似于 ApiMappingKey 资源的 AWS::ApiGatewayV2::ApiMapping 属性。AWS SAM 创建多个 AWS::ApiGatewayV2::ApiMapping 资源,在该属性中指定的每个值对应一个资源。

CertificateArn

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

类型: 字符串

必需: 是

兼容性AWS CloudFormation: 此属性直接传递给 CertificateArn 资源的 AWS::ApiGateway2::DomainName DomainNameConfiguration 属性。

DomainName

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

AWS SAM 在设置此属性时生成 AWS::ApiGatewayV2::DomainName 资源。有关此方案的信息,请参阅DomainName 属性已指定。有关生成的 AWS CloudFormation 资源的信息,请参阅已生成 AWS CloudFormation 资源

类型: 字符串

必需: 是

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

EndpointConfiguration

定义要映射到自定义域的 API 网关 终端节点的类型。此属性的值确定如何在 CertificateArn 中映射 AWS CloudFormation 属性。

HTTP APIs 的唯一有效值为 REGIONAL

类型: 字符串

必需: 否

默认值REGIONAL

兼容性AWS CloudFormation: 此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

MutualTlsAuthentication

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

类型: MutualTlsAuthentication

必需: 否

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

Route53

定义 Amazon Route 53 配置。

类型: Route53Configuration

必需: 否

兼容性AWS CloudFormation: 此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

SecurityPolicy

此域名的安全策略的 TLS 版本。

HTTP APIs 的唯一有效值为 TLS_1_2

类型: 字符串

必需: 否

兼容性AWS CloudFormation: 此属性直接传递给 SecurityPolicy AWS::ApiGatewayV2::DomainName 数据类型的 DomainNameConfiguration 属性。

示例

DomainName

DomainName 示例

YAML

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