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

AWS::ApiGatewayV2::DomainName

AWS::ApiGatewayV2::DomainName 资源在 Amazon API Gateway (API Gateway) 中为 API 指定自定义域名。

您可以使用自定义域名来提供更直观、更易于记住的 URL。有关使用自定义域名的更多信息,请参阅 API Gateway 开发人员指南中的在 API Gateway 中为 API 设置自定义域名

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::ApiGatewayV2::DomainName", "Properties" : { "DomainName" : String, "DomainNameConfigurations" : [ DomainNameConfiguration, ... ], "Tags" : Json } }

YAML

Type: AWS::ApiGatewayV2::DomainName Properties: DomainName: String DomainNameConfigurations: - DomainNameConfiguration Tags: Json

属性

DomainName

Amazon API Gateway 中的 API 的自定义域名。不支持大写字母。

必需:是

类型:字符串

Update requires: Replacement

DomainNameConfigurations

域名配置。

必需:否

类型DomainNameConfiguration 的列表

Update requires: No interruption

Tags

与域名关联的标签的集合。

必需:否

类型:Json

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回域名,例如 example.mydomain.com

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt 内部函数返回此类型的一个指定属性的值。以下为可用属性和示例返回值。

有关使用 Fn::GetAtt 内部函数的更多信息,请参阅 Fn::GetAtt

RegionalDomainName

与该自定义域名的区域终端节点关联的域名。您可以添加将自定义域名指向该区域域名的 DNS 记录以设置这种关联。

RegionalHostedZoneId

区域终端节点的区域特定的 Amazon Route 53 托管区域 ID。

示例

域名创建示例

以下示例创建一个名为 MyDomainNameDomainName 资源。

JSON

{ "MyDomainName": { "Type": "AWS::ApiGatewayV2::DomainName", "Properties": { "DomainName": "mydomainame.us-east-1.com", "DomainNameConfigurations": [ { "EndpointType": "REGIONAL", "CertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/1a2b3c4d-aaaa-aaaa-aaaa-1a2b3c4d5e6f", "CertificateName": "testCertificate" } ] } } }

YAML

MyDomainName: Type: 'AWS::ApiGatewayV2::DomainName' Properties: DomainName: mydomainame.us-east-1.com DomainNameConfigurations: - EndpointType: REGIONAL CertificateArn: >- arn:aws:acm:us-east-1:123456789012:certificate/1a2b3c4d-aaaa-aaaa-aaaa-1a2b3c4d5e6f CertificateName: testCertificate

另请参阅