public static interface CfnRecordSetGroup.RecordSetProperty
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.route53.*; RecordSetProperty recordSetProperty = RecordSetProperty.builder() .name("name") .type("type") // the properties below are optional .aliasTarget(AliasTargetProperty.builder() .dnsName("dnsName") .hostedZoneId("hostedZoneId") // the properties below are optional .evaluateTargetHealth(false) .build()) .failover("failover") .geoLocation(GeoLocationProperty.builder() .continentCode("continentCode") .countryCode("countryCode") .subdivisionCode("subdivisionCode") .build()) .healthCheckId("healthCheckId") .hostedZoneId("hostedZoneId") .hostedZoneName("hostedZoneName") .multiValueAnswer(false) .region("region") .resourceRecords(List.of("resourceRecords")) .setIdentifier("setIdentifier") .ttl("ttl") .weight(123) .build();
|Modifier and Type||Interface and Description|
A builder for
An implementation for
|Modifier and Type||Method and Description|
*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets.
*Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the `HealthCheckId` element and specify the ID of the applicable health check.
The ID of the hosted zone that you want to create records in.
The name of the hosted zone that you want to create records in.
*Multivalue answer resource record sets only* : To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify `true` for `MultiValueAnswer` .
For `ChangeResourceRecordSets` requests, the name of the record that you want to create, update, or delete.
*Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to.
Information about the records that you want to create.
*Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A.
The resource record cache time to live (TTL), in seconds.
The DNS record type.
*Weighted resource record sets only:* Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set.
ListResourceRecordSets responses, the name of a record in the specified hosted zone.
Enter a fully qualified domain name, for example,
www.example.com . You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats
www.example.com (without a trailing dot) and
www.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than
0-9 , and
- (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide .
You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example,
*.example.com . Note the following:
You can't use the * wildcard for resource records sets that have a type of NS.
You can use the * wildcard as the leftmost label in a domain name, for example,
*.example.com . You can't use an * for one of the middle labels, for example,
marketing.*.example.com . In addition, the * must replace the entire label; for example, you can't specify
For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide .
Valid values for basic resource record sets:
Values for weighted, latency, geolocation, and failover resource record sets:
TXT . When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.
Valid values for multivalue answer resource record sets:
SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of
SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1 , has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type .
Values for alias resource record sets:
If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of
A and one with a value of
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of
CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
default java.lang.Object getAliasTarget()
If you're creating resource records sets for a private hosted zone, note the following:
default java.lang.String getFailover()
For one resource record set, you specify
PRIMARY as the value for
Failover ; for the other resource record set, you specify
SECONDARY . In addition, you include the
HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you have included the
HealthCheckId element in both resource record sets:
HealthCheckIdelement for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.
You can't create non-failover resource record sets that have the same values for the
Type elements as failover resource record sets.
For failover alias resource record sets, you must also include the
EvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide :
default java.lang.Object getGeoLocation()
For example, if you want all queries from Africa to be routed to a web server with an IP address of
192.0.2.111 , create a resource record set with a
A and a
Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You can't create two geolocation resource record sets that specify the same geographic location.
* in the
CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the
Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of
*. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a
*resource record set, Route 53 returns a "no answer" response for queries from those locations.
You can't create non-geolocation resource record sets that have the same values for the
Type elements as geolocation resource record sets.
default java.lang.String getHealthCheckId()
Route 53 determines whether a resource record set is healthy based on one of the following:
Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the
Valueelement. When you add a
HealthCheckIdelement to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.
For more information, see the following topics in the Amazon Route 53 Developer Guide :
When to Specify HealthCheckId
Specifying a value for
HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:
If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.
If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.
If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.
EvaluateTargetHealthto true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).
If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.
If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.
For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has
* , which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:
Specifying the Health Check Endpoint by Domain Name
If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each
HTTP server that is serving content for
www.example.com . For the value of
FullyQualifiedDomainName , specify the domain name of the server (such as
us-east-2-www.example.com ), not the name of the resource record sets (
Health check results will be unpredictable if you do the following:
- Create a health check that has the same value for
FullyQualifiedDomainNameas the name of a resource record set.
- Associate that health check with the resource record set.
default java.lang.String getHostedZoneId()
HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using
default java.lang.String getHostedZoneName()
You must include a trailing dot (for example,
www.example.com. ) as part of the
When you create a stack using an
AWS::Route53::RecordSet that specifies
HostedZoneName , AWS CloudFormation attempts to find a hosted zone whose name matches the
HostedZoneName . If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.
HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using
default java.lang.Object getMultiValueAnswer()
Note the following:
You can't create multivalue answer alias records.
default java.lang.String getRegion()
The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
ResourceRecordper latency resource record set.
Typeelements as latency resource record sets.
default java.util.List<java.lang.String> getResourceRecords()
Each record should be in the format appropriate for the record type specified by the
Type property. For information about different record types and their record formats, see Values That You Specify When You Create or Edit Amazon Route 53 Records in the Amazon Route 53 Developer Guide .
default java.lang.String getSetIdentifier()
For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide .
default java.lang.String getTtl()
TTL. Amazon Route 53 uses the value of
TTLfor the alias target.
HealthCheckIdelement), we recommend that you specify a
TTLof 60 seconds or less so clients respond quickly to changes in health status.
TTLof 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for
default java.lang.Number getWeight()
Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
Weightelement for every weighted resource record set.
ResourceRecordper weighted resource record set.
Typeelements as weighted resource record sets.
0for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set
0for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.
The effect of setting
0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide .