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

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

Route53Configuration

为 API 配置 Route53 记录集。

语法

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

YAML

DistributionDomainName: String EvaluateTargetHealth: Boolean HostedZoneId: String HostedZoneName: String IpV6: Boolean Region: String SetIdentifier: String

属性

DistributionDomainName

配置 API 自定义域名的自定义分配。

类型:字符串

必需:否

默认:使用 API Gateway 分配。

Amazon CloudFormation 兼容性:此属性直接传递给 AWS::Route53::RecordSetGroup AliasTarget 资源的 DNSName 属性。

其他说明CloudFront分配的域名。

EvaluateTargetHealth

如果 EvaluateTargetHealth 为 true,则别名记录将继承引用Amazon资源的运行状况,例如 Elastic Load Balancing 负载均衡器或托管区域中的其他记录。

类型:布尔值

必需:否

Amazon CloudFormation 兼容性:此属性直接传递给 AWS::Route53::RecordSetGroup AliasTarget 资源的 EvaluateTargetHealth 属性。

其他说明:当别名目标为 CloudFront 分布时,您不能 EvaluateTargetHealth 将其设置为 true。

HostedZoneId

要在其中创建记录的托管区的 ID。

指定 HostedZoneNameHostedZoneId,但不能同时指定两者。如果您拥有多个使用相同域名的托管区域,则必须使用 HostedZoneId 指定托管区。

类型:字符串

必需:否

Amazon CloudFormation 兼容性:此属性直接传递给 AWS::Route53::RecordSetGroup RecordSet 资源的 HostedZoneId 属性。

HostedZoneName

要在其中创建记录的托管区的名称。

指定 HostedZoneNameHostedZoneId,但不能同时指定两者。如果您拥有多个使用相同域名的托管区域,则必须使用 HostedZoneId 指定托管区。

类型:字符串

必需:否

Amazon CloudFormation 兼容性:此属性直接传递给 AWS::Route53::RecordSetGroup RecordSet 资源的 HostedZoneName 属性。

IpV6

设置此属性后,将Amazon SAM创建一个AWS::Route53::RecordSet资源并将提供的资源的 Type 设置AAAA为 HostedZone。

类型:布尔值

必需:否

Amazon CloudFormation 兼容性:此属性为 Amazon SAM 独有,没有 Amazon CloudFormation 等效属性。

Region

仅基于延迟性的资源记录集:从中创建此资源记录集引用的资源的 Amazon EC2 区域。一般而言,该资源可以是 Amazon 资源,例如,EC2 实例或 ELB 负载均衡器,并由 IP 地址或 DNS 域名引用,具体取决于记录类型。

当 Amazon Route 53 收到查询您已创建的延迟资源记录集的域名和类型的 DNS 查询时,Route 53 会选择在最终用户和相关 Amazon EC2 区域之间延迟时间最短的延迟资源记录集。然后,Route 53 会返回与所选资源记录集相关的值。

请注意以下几点:

  • 您只能为每个延迟资源记录集指定一个 ResourceRecord

  • 您只能为每个 Amazon EC2 区域创建一个延迟资源记录集。

  • 您不必为所有 Amazon EC2 区域创建延迟资源记录集。Route 53 会从您已创建延迟资源记录集的区域中选择延迟性能最佳的区域。

  • 您不能创建 NameType 元素的值与延迟资源记录集相同的非延迟资源记录集。

类型:字符串

必需:否

Amazon CloudFormation 兼容性:此属性直接传递给 AWS::Route53::RecordSetGroup RecordSet 数据类型的 Region 属性。

SetIdentifier

具有简单策略以外的路由策略的资源记录集:用于区分具有相同名称和类型组合的多个资源记录集的标识符,如名为 acme.example.com 且类型为 A 的多个加权资源记录集。在一组具有相同名称和类型的资源记录集中,每个资源记录集的 SetIdentifier 值必须唯一。

有关路由策略的信息,请参阅《Amazon Route 53 开发人员指南》中的选择路由策略

类型:字符串

必需:否

Amazon CloudFormation 兼容性:此属性直接传递给 AWS::Route53::RecordSetGroup RecordSet 数据类型的 SetIdentifier 属性。

示例

基本示例

在此示例中,我们为 API 配置了自定义域和 Route 53 记录集。

YAML

Resources: MyApi: Type: AWS::Serverless::Api Properties: StageName: Prod Domain: DomainName: www.example.com CertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/abcdef12-3456-7890-abcd-ef1234567890 EndpointConfiguration: REGIONAL Route53: HostedZoneId: ABCDEFGHIJKLMNOP