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

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

HttpApiDomainConfiguration

为 API 配置自定义域。

语法

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

属性

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 的唯一有效值 APIs 是REGIONAL。

类型：字符串

必需：否

默认值：REGIONAL

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

MutualTlsAuthentication

自定义域名的相互传输层安全性协议（TLS）身份验证配置。

类型：MutualTlsAuthentication

必需：否

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

OwnershipVerificationCertificateArn

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

类型：字符串

必需：否

Amazon CloudFormation 兼容性：此属性直接传递给AWS::ApiGatewayV2::DomainNameDomainNameConfiguration数据类型的OwnershipVerificationCertificateArn属性。

Route53

定义 Amazon Route 53 配置。

类型：Route53Configuration

必需：否

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

SecurityPolicy

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

HTTP 的唯一有效值 APIs 是TLS_1_2。

类型：字符串

必需：否

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

示例

DomainName

DomainName 示例

YAML

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