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

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

HttpApiDomainConfiguration

配置API的自定义域。

语法

在你的 AWS 无服务器应用程序模型 (AWS SAM)模板,使用以下语法。

属性

BasePath

要与 API 网关 域名。

类型:列表

必需: 否

默认值

AWS CloudFormation 相容性: 此属性类似于 BasePath 特性 AWS::ApiGatewayV2::ApiMapping 资源。SAM将创建多个 AWS::ApiGatewayV2::ApiMapping 资源,每个 BasePath 说明。

其他备注: SAM将创建多个 AWS::ApiGatewayV2::ApiMapping 资源,每个 BasePath 说明。

CertificateArn

引用用于此域名的终端的由AW管理的证书。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. 见 CertificateArn 高于。

HttpApis的有效值仅为 REGIONAL.

类型:字符串

必需: 否

默认值REGIONAL

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

Route53

根据定义的值添加route53配置的属性。

类型: 路线53配置

必需: 否

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

示例

DomainName

域名示例

YAML

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