Route53Configuration

Configures the Route53 record sets for an API.

Syntax

To declare this entity in your AWS Serverless Application Model (AWS SAM) template, use the following syntax.

YAML

  [DistributionDomainName](#sam-httpapi-route53configuration-distributiondomainname): String
  [EvaluateTargetHealth](#sam-httpapi-route53configuration-evaluatetargethealth): Boolean
  [HostedZoneId](#sam-httpapi-route53configuration-hostedzoneid): String
  [HostedZoneName](#sam-httpapi-route53configuration-hostedzonename): String
  [IpV6](#sam-httpapi-route53configuration-ipv6): Boolean

Properties

DistributionDomainName Configures a custom distribution of the API custom domain name.
Type: String
Required: No
Default: Use the API Gateway distribution.
AWS CloudFormation compatibility: This property is passed directly to the [DNSName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html#cfn-route53-aliastarget-dnshostname) property of an AWS::Route53::RecordSetGroup AliasTarget resource.
Additional Notes: The domain name of a CloudFront distribution.

EvaluateTargetHealth When EvaluateTargetHealth is true, an alias record inherits the health of the referenced AWS resource, such as an Elastic Load Balancing load balancer or another record in the hosted zone.
Type: Boolean
Required: No
AWS CloudFormation compatibility: This property is passed directly to the [EvaluateTargetHealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth) property of an AWS::Route53::RecordSetGroup AliasTarget resource.
Additional Notes: You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

HostedZoneId The ID of the hosted zone that you want to create records in.
Specify either HostedZoneName or HostedZoneId, but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId.
Type: String
Required: No
AWS CloudFormation compatibility: This property is passed directly to the [HostedZoneId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzoneid) property of an AWS::Route53::RecordSetGroup RecordSet resource.

HostedZoneName The name of the hosted zone that you want to create records in.
Specify either HostedZoneName or HostedZoneId, but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId.
Type: String
Required: No
AWS CloudFormation compatibility: This property is passed directly to the [HostedZoneName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzonename) property of an AWS::Route53::RecordSetGroup RecordSet resource.

IpV6 When this property is set, AWS SAM creates a AWS::Route53::RecordSet resource and sets Type to AAAA for the provided HostedZone.
Type: Boolean
Required: No
AWS CloudFormation compatibility: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent.

Examples