Class: AWSCDK::Route53::CfnRecordSetGroup::RecordSetProperty

Inherits:

Jsii::Struct

Object
Jsii::Struct
AWSCDK::Route53::CfnRecordSetGroup::RecordSetProperty

show all

Defined in:: route53/cfn_record_set_group.rb

Overview

Information about one record that you want to create.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html

Instance Attribute Summary collapse

#alias_target ⇒ AWSCDK::IResolvable, ... readonly
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.
#cidr_routing_config ⇒ AWSCDK::IResolvable, ... readonly
#failover ⇒ String^? readonly
Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets.
#geo_location ⇒ AWSCDK::IResolvable, ... readonly
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.
#geo_proximity_location ⇒ AWSCDK::IResolvable, ... readonly
A complex type that contains information about a geographic location.
#health_check_id ⇒ String^? readonly
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.
#hosted_zone_id ⇒ String^? readonly
The ID of the hosted zone that you want to create records in.
#hosted_zone_name ⇒ String^? readonly
The name of the hosted zone that you want to create records in.
#multi_value_answer ⇒ Boolean, ... readonly
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 .
#name ⇒ String readonly
The name of the record that you want to create, update, or delete.
#region ⇒ String^? readonly
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to.
#resource_records ⇒ Array<String>^? readonly
Information about the records that you want to create.
#set_identifier ⇒ String^? readonly
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.
#ttl ⇒ String^? readonly
The resource record cache time to live (TTL), in seconds.
#type ⇒ String readonly
The DNS record type.
#weight ⇒ Numeric^? readonly
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.

Class Method Summary collapse

.jsii_properties ⇒ Object

Instance Method Summary collapse

#initialize(name:, type:, alias_target: nil, cidr_routing_config: nil, failover: nil, geo_location: nil, geo_proximity_location: nil, health_check_id: nil, hosted_zone_id: nil, hosted_zone_name: nil, multi_value_answer: nil, region: nil, resource_records: nil, set_identifier: nil, ttl: nil, weight: nil) ⇒ RecordSetProperty constructor
A new instance of RecordSetProperty.
#to_jsii ⇒ Object

Constructor Details

#initialize(name:, type:, alias_target: nil, cidr_routing_config: nil, failover: nil, geo_location: nil, geo_proximity_location: nil, health_check_id: nil, hosted_zone_id: nil, hosted_zone_name: nil, multi_value_answer: nil, region: nil, resource_records: nil, set_identifier: nil, ttl: nil, weight: nil) ⇒ `RecordSetProperty`

Returns a new instance of RecordSetProperty.

Parameters:

name (String) —
The name of the record that you want to create, update, or delete.
type (String) —
The DNS record type.
alias_target (AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSetGroup::AliasTargetProperty, nil) (defaults to: nil) —
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.
cidr_routing_config (AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSetGroup::CIDRRoutingConfigProperty, nil) (defaults to: nil)
failover (String, nil) (defaults to: nil) —
Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets.
geo_location (AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSetGroup::GeoLocationProperty, nil) (defaults to: nil) —
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.
geo_proximity_location (AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSetGroup::GeoProximityLocationProperty, nil) (defaults to: nil) —
A complex type that contains information about a geographic location.
health_check_id (String, nil) (defaults to: nil) —
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.
hosted_zone_id (String, nil) (defaults to: nil) —
The ID of the hosted zone that you want to create records in.
hosted_zone_name (String, nil) (defaults to: nil) —
The name of the hosted zone that you want to create records in.
multi_value_answer (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —
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 .
region (String, nil) (defaults to: nil) —
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to.
resource_records (Array<String>, nil) (defaults to: nil) —
Information about the records that you want to create.
set_identifier (String, nil) (defaults to: nil) —
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. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.
ttl (String, nil) (defaults to: nil) —
The resource record cache time to live (TTL), in seconds. Note the following:.
weight (Numeric, nil) (defaults to: nil) —
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.

# File 'route53/cfn_record_set_group.rb', line 938

def initialize(name:, type:, alias_target: nil, cidr_routing_config: nil, failover: nil, geo_location: nil, geo_proximity_location: nil, health_check_id: nil, hosted_zone_id: nil, hosted_zone_name: nil, multi_value_answer: nil, region: nil, resource_records: nil, set_identifier: nil, ttl: nil, weight: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @alias_target = alias_target.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSetGroup::AliasTargetProperty.new(**alias_target.transform_keys(&:to_sym)) : alias_target
  Jsii::Type.check_type(@alias_target, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLkNmblJlY29yZFNldEdyb3VwLkFsaWFzVGFyZ2V0UHJvcGVydHkifV19fQ==")), "aliasTarget") unless @alias_target.nil?
  @cidr_routing_config = cidr_routing_config.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSetGroup::CIDRRoutingConfigProperty.new(**cidr_routing_config.transform_keys(&:to_sym)) : cidr_routing_config
  Jsii::Type.check_type(@cidr_routing_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLkNmblJlY29yZFNldEdyb3VwLkNpZHJSb3V0aW5nQ29uZmlnUHJvcGVydHkifV19fQ==")), "cidrRoutingConfig") unless @cidr_routing_config.nil?
  @failover = failover
  Jsii::Type.check_type(@failover, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "failover") unless @failover.nil?
  @geo_location = geo_location.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSetGroup::GeoLocationProperty.new(**geo_location.transform_keys(&:to_sym)) : geo_location
  Jsii::Type.check_type(@geo_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLkNmblJlY29yZFNldEdyb3VwLkdlb0xvY2F0aW9uUHJvcGVydHkifV19fQ==")), "geoLocation") unless @geo_location.nil?
  @geo_proximity_location = geo_proximity_location.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSetGroup::GeoProximityLocationProperty.new(**geo_proximity_location.transform_keys(&:to_sym)) : geo_proximity_location
  Jsii::Type.check_type(@geo_proximity_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLkNmblJlY29yZFNldEdyb3VwLkdlb1Byb3hpbWl0eUxvY2F0aW9uUHJvcGVydHkifV19fQ==")), "geoProximityLocation") unless @geo_proximity_location.nil?
  @health_check_id = health_check_id
  Jsii::Type.check_type(@health_check_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "healthCheckId") unless @health_check_id.nil?
  @hosted_zone_id = hosted_zone_id
  Jsii::Type.check_type(@hosted_zone_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostedZoneId") unless @hosted_zone_id.nil?
  @hosted_zone_name = hosted_zone_name
  Jsii::Type.check_type(@hosted_zone_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostedZoneName") unless @hosted_zone_name.nil?
  @multi_value_answer = multi_value_answer
  Jsii::Type.check_type(@multi_value_answer, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "multiValueAnswer") unless @multi_value_answer.nil?
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region") unless @region.nil?
  @resource_records = resource_records
  Jsii::Type.check_type(@resource_records, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resourceRecords") unless @resource_records.nil?
  @set_identifier = set_identifier
  Jsii::Type.check_type(@set_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "setIdentifier") unless @set_identifier.nil?
  @ttl = ttl
  Jsii::Type.check_type(@ttl, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ttl") unless @ttl.nil?
  @weight = weight
  Jsii::Type.check_type(@weight, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "weight") unless @weight.nil?
end

Instance Attribute Details

#alias_target ⇒ `AWSCDK::IResolvable`, ... (readonly)

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.

If you're creating resource records sets for a private hosted zone, note the following:

You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide .

Returns:

(AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSetGroup::AliasTargetProperty, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-aliastarget



1029
1030
1031

# File 'route53/cfn_record_set_group.rb', line 1029

def alias_target
  @alias_target
end

#cidr_routing_config ⇒ `AWSCDK::IResolvable`, ... (readonly)

Returns:

(AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSetGroup::CIDRRoutingConfigProperty, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-cidrroutingconfig



1032
1033
1034

# File 'route53/cfn_record_set_group.rb', line 1032

def cidr_routing_config
  @cidr_routing_config
end

#failover ⇒ `String`^? (readonly)

Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets.

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:

When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
If you omit the HealthCheckId element 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 Name and 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 :

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-failover



1055
1056
1057

# File 'route53/cfn_record_set_group.rb', line 1055

def failover
  @failover
end

#geo_location ⇒ `AWSCDK::IResolvable`, ... (readonly)

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.

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 Type of A and a ContinentCode of AF .

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.

The value * 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 Name and Type elements.

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 CountryCode is * . 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 Name and Type elements as geolocation resource record sets.

Returns:

(AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSetGroup::GeoLocationProperty, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-geolocation



1072
1073
1074

# File 'route53/cfn_record_set_group.rb', line 1072

def geo_location
  @geo_location
end

#geo_proximity_location ⇒ `AWSCDK::IResolvable`, ... (readonly)

A complex type that contains information about a geographic location.

Returns:

(AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSetGroup::GeoProximityLocationProperty, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-geoproximitylocation



1077
1078
1079

# File 'route53/cfn_record_set_group.rb', line 1077

def geo_proximity_location
  @geo_proximity_location
end

#health_check_id ⇒ `String`^? (readonly)

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.

Route 53 determines whether a resource record set is healthy based on one of the following:

By periodically sending a request to the endpoint that is specified in the health check
By aggregating the status of a specified group of health checks (calculated health checks)
By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

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 Value element. When you add a HealthCheckId element 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:

Non-alias resource record sets : You're checking the health of a group of non-alias 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) and you specify health check IDs for all the resource record sets.

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.

Alias resource record sets : You specify the following settings:
You set EvaluateTargetHealth to 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).
You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
You specify a health check ID for the non-alias resource record set.

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.

Geolocation Routing

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 * for CountryCode is * , 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:

The United States
North America
The default resource record set

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 ( www.example.com ).

Health check results will be unpredictable if you do the following:

Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.

Associate that health check with the resource record set.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-healthcheckid



1136
1137
1138

# File 'route53/cfn_record_set_group.rb', line 1136

def health_check_id
  @health_check_id
end

#hosted_zone_id ⇒ `String`^? (readonly)

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 .

Do not provide the HostedZoneId if it is already defined in AWS::Route53::RecordSetGroup . The creation fails if HostedZoneId is defined in both.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-hostedzoneid



1145
1146
1147

# File 'route53/cfn_record_set_group.rb', line 1145

def hosted_zone_id
  @hosted_zone_id
end

#hosted_zone_name ⇒ `String`^? (readonly)

The name of the hosted zone that you want to create records in.

You must include a trailing dot (for example, www.example.com. ) as part of the HostedZoneName .

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.

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 .

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-hostedzonename



1156
1157
1158

# File 'route53/cfn_record_set_group.rb', line 1156

def hosted_zone_name
  @hosted_zone_name
end

#multi_value_answer ⇒ `Boolean`, ... (readonly)

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 .

Note the following:

If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.
If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.
Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.
If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.
When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.
If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

You can't create multivalue answer alias records.

Returns:

(Boolean, AWSCDK::IResolvable, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-multivalueanswer



1172
1173
1174

# File 'route53/cfn_record_set_group.rb', line 1172

def multi_value_answer
  @multi_value_answer
end

#name ⇒ `String` (readonly)

The name of the record that you want to create, update, or delete.

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 a-z , 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:

The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com .
The * can't replace any of the middle labels, for example, marketing.*.example.com.
If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

You can't use the * wildcard for resource records sets that have a type of NS.

Returns:

(String)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-name



989
990
991

# File 'route53/cfn_record_set_group.rb', line 989

def name
  @name
end

#region ⇒ `String`^? (readonly)

Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to.

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.

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:

You can only specify one ResourceRecord per latency resource record set.
You can only create one latency resource record set for each Amazon EC2 Region.
You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-region



1188
1189
1190

# File 'route53/cfn_record_set_group.rb', line 1188

def region
  @region
end

#resource_records ⇒ `Array<String>`^? (readonly)

Information about the records that you want to create.

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 .

Returns:

(Array<String>, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-resourcerecords



1195
1196
1197

# File 'route53/cfn_record_set_group.rb', line 1195

def resource_records
  @resource_records
end

#set_identifier ⇒ `String`^? (readonly)

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. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide .

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-setidentifier



1202
1203
1204

# File 'route53/cfn_record_set_group.rb', line 1202

def set_identifier
  @set_identifier
end

#ttl ⇒ `String`^? (readonly)

The resource record cache time to live (TTL), in seconds. Note the following:.

If you're creating or updating an alias resource record set, omit TTL . Amazon Route 53 uses the value of TTL for the alias target.
If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.
All of the resource record sets in a group of weighted resource record sets must have the same value for TTL .
If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 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 Weight .

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-ttl



1212
1213
1214

# File 'route53/cfn_record_set_group.rb', line 1212

def ttl
  @ttl
end

#type ⇒ `String` (readonly)

The DNS record type.

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: A | AAAA | CAA | CNAME | DS | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT | TLSA | SSHFP | SVCB | HTTPS

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT | TLSA | SSHFP | SVCB | HTTPS . 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: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT | CAA | TLSA | SSHFP | SVCB | HTTPS

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 Type is 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:

Amazon API Gateway custom regional APIs and edge-optimized APIs: A
CloudFront distributions: A

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 AAAA .

Amazon API Gateway environment that has a regionalized subdomain : A
ELB load balancers: A | AAAA
Amazon S3 buckets: A
Amazon Virtual Private Cloud interface VPC endpoints A
Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA .

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 Type is 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.

Returns:

(String)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-type



1019
1020
1021

# File 'route53/cfn_record_set_group.rb', line 1019

def type
  @type
end

#weight ⇒ `Numeric`^? (readonly)

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.

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:

You must specify a value for the Weight element for every weighted resource record set.
You can only specify one ResourceRecord per weighted resource record set.
You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.
You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.
For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for 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 Weight to 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 .

Returns:

(Numeric, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup-recordset.html#cfn-route53-recordsetgroup-recordset-weight



1227
1228
1229

# File 'route53/cfn_record_set_group.rb', line 1227

def weight
  @weight
end

Class Method Details

.jsii_properties ⇒ `Object`

# File 'route53/cfn_record_set_group.rb', line 1229

def self.jsii_properties
  {
    :name => "name",
    :type => "type",
    :alias_target => "aliasTarget",
    :cidr_routing_config => "cidrRoutingConfig",
    :failover => "failover",
    :geo_location => "geoLocation",
    :geo_proximity_location => "geoProximityLocation",
    :health_check_id => "healthCheckId",
    :hosted_zone_id => "hostedZoneId",
    :hosted_zone_name => "hostedZoneName",
    :multi_value_answer => "multiValueAnswer",
    :region => "region",
    :resource_records => "resourceRecords",
    :set_identifier => "setIdentifier",
    :ttl => "ttl",
    :weight => "weight",
  }
end

Instance Method Details

#to_jsii ⇒ `Object`

# File 'route53/cfn_record_set_group.rb', line 1250

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "type" => @type,
    "aliasTarget" => @alias_target,
    "cidrRoutingConfig" => @cidr_routing_config,
    "failover" => @failover,
    "geoLocation" => @geo_location,
    "geoProximityLocation" => @geo_proximity_location,
    "healthCheckId" => @health_check_id,
    "hostedZoneId" => @hosted_zone_id,
    "hostedZoneName" => @hosted_zone_name,
    "multiValueAnswer" => @multi_value_answer,
    "region" => @region,
    "resourceRecords" => @resource_records,
    "setIdentifier" => @set_identifier,
    "ttl" => @ttl,
    "weight" => @weight,
  })
  result.compact
end

Class: AWSCDK::Route53::CfnRecordSetGroup::RecordSetProperty

Overview

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

#alias_target ⇒ AWSCDK::IResolvable, ... (readonly)

#cidr_routing_config ⇒ AWSCDK::IResolvable, ... (readonly)

#failover ⇒ String? (readonly)

#geo_location ⇒ AWSCDK::IResolvable, ... (readonly)

#geo_proximity_location ⇒ AWSCDK::IResolvable, ... (readonly)

#health_check_id ⇒ String? (readonly)

#hosted_zone_id ⇒ String? (readonly)

#hosted_zone_name ⇒ String? (readonly)

#multi_value_answer ⇒ Boolean, ... (readonly)

#name ⇒ String (readonly)

#region ⇒ String? (readonly)

#resource_records ⇒ Array<String>? (readonly)

#set_identifier ⇒ String? (readonly)

#ttl ⇒ String? (readonly)

#type ⇒ String (readonly)

#weight ⇒ Numeric? (readonly)

Class Method Details

.jsii_properties ⇒ Object

Instance Method Details

#to_jsii ⇒ Object

#alias_target ⇒ `AWSCDK::IResolvable`, ... (readonly)

#cidr_routing_config ⇒ `AWSCDK::IResolvable`, ... (readonly)

#failover ⇒ `String`^? (readonly)

#geo_location ⇒ `AWSCDK::IResolvable`, ... (readonly)

#geo_proximity_location ⇒ `AWSCDK::IResolvable`, ... (readonly)

#health_check_id ⇒ `String`^? (readonly)

#hosted_zone_id ⇒ `String`^? (readonly)

#hosted_zone_name ⇒ `String`^? (readonly)

#multi_value_answer ⇒ `Boolean`, ... (readonly)

#name ⇒ `String` (readonly)

#region ⇒ `String`^? (readonly)

#resource_records ⇒ `Array<String>`^? (readonly)

#set_identifier ⇒ `String`^? (readonly)

#ttl ⇒ `String`^? (readonly)

#type ⇒ `String` (readonly)

#weight ⇒ `Numeric`^? (readonly)

.jsii_properties ⇒ `Object`

#to_jsii ⇒ `Object`