CfnRecordSet

class aws_cdk.aws_route53.CfnRecordSet(scope, id, *, name, type, alias_target=None, cidr_routing_config=None, comment=None, failover=None, geo_location=None, geo_proximity_location=None, health_check_id=None, hosted_zone_id=None, hosted_zone_name=None, multi_value_answer=None, region=None, resource_records=None, set_identifier=None, ttl=None, weight=None)

Bases: CfnResource

Information about the record that you want to create.

The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup .

For more information, see ChangeResourceRecordSets in the Amazon Route 53 API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordset.html
CloudformationResource:: AWS::Route53::RecordSet
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53 as route53

cfn_record_set = route53.CfnRecordSet(self, "MyCfnRecordSet",
    name="name",
    type="type",

    # the properties below are optional
    alias_target=route53.CfnRecordSet.AliasTargetProperty(
        dns_name="dnsName",
        hosted_zone_id="hostedZoneId",

        # the properties below are optional
        evaluate_target_health=False
    ),
    cidr_routing_config=route53.CfnRecordSet.CidrRoutingConfigProperty(
        collection_id="collectionId",
        location_name="locationName"
    ),
    comment="comment",
    failover="failover",
    geo_location=route53.CfnRecordSet.GeoLocationProperty(
        continent_code="continentCode",
        country_code="countryCode",
        subdivision_code="subdivisionCode"
    ),
    geo_proximity_location=route53.CfnRecordSet.GeoProximityLocationProperty(
        aws_region="awsRegion",
        bias=123,
        coordinates=route53.CfnRecordSet.CoordinatesProperty(
            latitude="latitude",
            longitude="longitude"
        ),
        local_zone_group="localZoneGroup"
    ),
    health_check_id="healthCheckId",
    hosted_zone_id="hostedZoneId",
    hosted_zone_name="hostedZoneName",
    multi_value_answer=False,
    region="region",
    resource_records=["resourceRecords"],
    set_identifier="setIdentifier",
    ttl="ttl",
    weight=123
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
name (str) – For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone. ChangeResourceRecordSets Only 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. .. epigraph:: You can’t use the * wildcard for resource records sets that have a type of NS.
type (str) – 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 Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | 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: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT | CAA .. epigraph:: 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 . .. epigraph:: 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.
alias_target (Union[IResolvable, AliasTargetProperty, Dict[str, Any], None]) – 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 .
cidr_routing_config (Union[IResolvable, CidrRoutingConfigProperty, Dict[str, Any], None]) – The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record.
comment (Optional[str]) – Optional: Any comments you want to include about a change batch request.
failover (Optional[str]) –
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 : - Route 53 Health Checks and DNS Failover - Configuring Failover in a Private Hosted Zone
geo_location (Union[IResolvable, GeoLocationProperty, Dict[str, Any], None]) – 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. .. epigraph:: 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.
geo_proximity_location (Union[IResolvable, GeoProximityLocationProperty, Dict[str, Any], None]) – GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources.
health_check_id (Optional[str]) –
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) .. epigraph:: 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 : - How Amazon Route 53 Determines Whether an Endpoint Is Healthy - Route 53 Health Checks and DNS Failover - Configuring Failover in a Private Hosted Zone 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. .. epigraph:: 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 ). .. epigraph:: 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.
hosted_zone_id (Optional[str]) – 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 .
hosted_zone_name (Optional[str]) – 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 cannot 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 .
multi_value_answer (Union[bool, IResolvable, None]) – 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.
region (Optional[str]) – 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.
resource_records (Optional[Sequence[str]]) –
One or more values that correspond with the value that you specified for the Type property. For example, if you specified A for Type , you specify one or more IP addresses in IPv4 format for ResourceRecords . For information about the format of values for each record type, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide . Note the following: - You can specify more than one value for all record types except CNAME and SOA. - The maximum length of a value is 4000 characters. - If you’re creating an alias record, omit ResourceRecords .
set_identifier (Optional[str]) – 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 .
ttl (Optional[str]) – 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 .
weight (Union[int, float, None]) – 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 .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Route53::RecordSet'

alias_target

Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

Type:: *Alias resource record sets only

attr_id

Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth.

CloudformationAttribute:: Id

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

cidr_routing_config: The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.

comment

Any comments you want to include about a change batch request.

Type:: *Optional

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

failover

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

Type:: *Failover resource record sets only

geo_location

A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.

Type:: *Geolocation resource record sets only

geo_proximity_location

A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources.

Type:: *GeoproximityLocation resource record sets only

health_check_id: 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: The ID of the hosted zone that you want to create records in.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

multi_value_answer

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 .

Type:: Multivalue answer resource record sets only

name: For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

region

The Amazon EC2 Region where you created the resource that this resource record set refers to.

Type:: *Latency-based resource record sets only

resource_records: One or more values that correspond with the value that you specified for the Type property.

set_identifier

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.

Type:: *Resource record sets that have a routing policy other than simple

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

ttl

The resource record cache time to live (TTL), in seconds.

Note the following:.

type: The DNS record type.

weight

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.

Type:: *Weighted resource record sets only

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AliasTargetProperty

class CfnRecordSet.AliasTargetProperty(*, dns_name, hosted_zone_id, evaluate_target_health=None)

Bases: object

Alias records only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

When creating records for a private hosted zone, note the following:

Creating geolocation alias and latency alias records in a private hosted zone is allowed but not supported.
For information about creating failover records in a private hosted zone, see Configuring Failover in a Private Hosted Zone .

Parameters:

dns_name (str) –
Alias records only: The value that you specify depends on where you want to route queries:. - Amazon API Gateway custom regional APIs and edge-optimized APIs - Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names : - For regional APIs, specify the value of regionalDomainName . - For edge-optimized APIs, specify the value of distributionDomainName . This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net . .. epigraph:: The name of the record that you’re creating must match a custom domain name for your API, such as api.example.com . - Amazon Virtual Private Cloud interface VPC endpoint - Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com . For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints . - CloudFront distribution - Specify the domain name that CloudFront assigned when you created your distribution. Your CloudFront distribution must include an alternate domain name that matches the name of the record. For example, if the name of the record is acme.example.com , your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide . You can’t create a record in a private hosted zone to route traffic to a CloudFront distribution. .. epigraph:: For failover alias records, you can’t specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can’t include the same alternate domain name in more than one distribution. - Elastic Beanstalk environment - If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment. *us-west-2* .elasticbeanstalk.com is a regionalized domain name. .. epigraph:: For environments that were created before early 2016, the domain name doesn’t include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can’t create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can’t create a record that routes traffic for example.com to your Elastic Beanstalk environment. For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute: - AWS Management Console : For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide . - Elastic Beanstalk API : Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference . - AWS CLI : Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS CLI . - ELB load balancer - Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console , the ELB API, or the AWS CLI . - AWS Management Console : Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field. If you’re routing traffic to a Classic Load Balancer, get the value that begins with dualstack . If you’re routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA. - Elastic Load Balancing API : Use DescribeLoadBalancers to get the value of DNSName . For more information, see the applicable guide: - Classic Load Balancers: DescribeLoadBalancers - Application and Network Load Balancers: DescribeLoadBalancers - CloudFormation Fn::GetAtt intrinsic function : Use the Fn::GetAtt intrinsic function to get the value of DNSName : - Classic Load Balancers . - Application and Network Load Balancers . - AWS CLI : Use describe-load-balancers to get the value of DNSName . For more information, see the applicable guide: - Classic Load Balancers: describe-load-balancers - Application and Network Load Balancers: describe-load-balancers - Global Accelerator accelerator - Specify the DNS name for your accelerator: - Global Accelerator API : To get the DNS name, use DescribeAccelerator . - AWS CLI : To get the DNS name, use describe-accelerator . - Amazon S3 bucket that is configured as a static website - Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com . For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference . For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide. - Another Route 53 record - Specify the value of the Name element for a record in the current hosted zone. .. epigraph:: If you’re creating an alias record that has the same name as the hosted zone (known as the zone apex), you can’t specify the domain name for a record for which the value of Type is CNAME . This is because the alias record must have the same type as the record that you’re routing traffic to, and creating a CNAME record for the zone apex isn’t supported even for an alias record.
hosted_zone_id (str) –
Alias resource records sets only : The value used depends on where you want to route traffic:. - Amazon API Gateway custom regional APIs and edge-optimized APIs - Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names : - For regional APIs, specify the value of regionalHostedZoneId . - For edge-optimized APIs, specify the value of distributionHostedZoneId . - Amazon Virtual Private Cloud interface VPC endpoint - Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints . - CloudFront distribution - Specify Z2FDTNDATAQYW2 . This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution. .. epigraph:: Alias records for CloudFront can’t be created in a private zone. - Elastic Beanstalk environment - Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk endpoints and quotas in the Amazon Web Services General Reference . - ELB load balancer - Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID: - Service Endpoints table in the “Elastic Load Balancing Endpoints and Quotas” topic in the Amazon Web Services General Reference : Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. - AWS Management Console : Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. - Elastic Load Balancing API : Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide: - Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameID . - Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneID . - CloudFormation Fn::GetAtt intrinsic function : Use the Fn::GetAtt intrinsic function to get the applicable value: - Classic Load Balancers: Get CanonicalHostedZoneNameID . - Application and Network Load Balancers: Get CanonicalHostedZoneID . - AWS CLI : Use describe-load-balancers to get the applicable value. For more information, see the applicable guide: - Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID . - Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneID . - Global Accelerator accelerator - Specify Z2BJ6XQ5FK7U4H . - An Amazon S3 bucket configured as a static website - Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference . - Another Route 53 record in your hosted zone - Specify the hosted zone ID of your hosted zone. (An alias record can’t reference a record in a different hosted zone.)
evaluate_target_health (Union[bool, IResolvable, None]) – Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true , an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone. Note the following: - CloudFront distributions - You can’t set EvaluateTargetHealth to true when the alias target is a CloudFront distribution. - Elastic Beanstalk environments that have regionalized subdomains - If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. If the environment contains a single Amazon EC2 instance, there are no special requirements. - ELB load balancers - Health checking behavior depends on the type of load balancer: - Classic Load Balancers : If you specify an ELB Classic Load Balancer in DNSName , Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. - Application and Network Load Balancers : If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true , Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: - For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources. - A target group that has no registered targets is considered unhealthy. .. epigraph:: When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they’re not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. - S3 buckets - There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket. - Other records in the same hosted zone - If the AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide . For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53 as route53

alias_target_property = route53.CfnRecordSet.AliasTargetProperty(
    dns_name="dnsName",
    hosted_zone_id="hostedZoneId",

    # the properties below are optional
    evaluate_target_health=False
)

Attributes

dns_name

.

Amazon API Gateway custom regional APIs and edge-optimized APIs - Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names :
For regional APIs, specify the value of regionalDomainName .
For edge-optimized APIs, specify the value of distributionDomainName . This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net .

The name of the record that you’re creating must match a custom domain name for your API, such as api.example.com .

Amazon Virtual Private Cloud interface VPC endpoint - Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com . For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints .
CloudFront distribution - Specify the domain name that CloudFront assigned when you created your distribution.

Your CloudFront distribution must include an alternate domain name that matches the name of the record. For example, if the name of the record is acme.example.com , your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide .

You can’t create a record in a private hosted zone to route traffic to a CloudFront distribution. .. epigraph:

For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.

Elastic Beanstalk environment - If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment. *us-west-2* .elasticbeanstalk.com is a regionalized domain name.

For environments that were created before early 2016, the domain name doesn’t include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can’t create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can’t create a record that routes traffic for example.com to your Elastic Beanstalk environment.

For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:

AWS Management Console : For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide .
Elastic Beanstalk API : Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference .
AWS CLI : Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS CLI .
ELB load balancer - Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console , the ELB API, or the AWS CLI .
AWS Management Console : Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.

If you’re routing traffic to a Classic Load Balancer, get the value that begins with dualstack . If you’re routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

Elastic Load Balancing API : Use DescribeLoadBalancers to get the value of DNSName . For more information, see the applicable guide:
Classic Load Balancers: DescribeLoadBalancers
Application and Network Load Balancers: DescribeLoadBalancers
CloudFormation Fn::GetAtt intrinsic function : Use the Fn::GetAtt intrinsic function to get the value of DNSName :
Classic Load Balancers .
Application and Network Load Balancers .
AWS CLI : Use describe-load-balancers to get the value of DNSName . For more information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Global Accelerator accelerator - Specify the DNS name for your accelerator:
Global Accelerator API : To get the DNS name, use DescribeAccelerator .
AWS CLI : To get the DNS name, use describe-accelerator .
Amazon S3 bucket that is configured as a static website - Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com . For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference . For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Another Route 53 record - Specify the value of the Name element for a record in the current hosted zone.

If you’re creating an alias record that has the same name as the hosted zone (known as the zone apex), you can’t specify the domain name for a record for which the value of Type is CNAME . This is because the alias record must have the same type as the record that you’re routing traffic to, and creating a CNAME record for the zone apex isn’t supported even for an alias record.

See:

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

Type:

*Alias records only

Type:

The value that you specify depends on where you want to route queries

evaluate_target_health

When EvaluateTargetHealth is true , an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.

Note the following:

CloudFront distributions - You can’t set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
Elastic Beanstalk environments that have regionalized subdomains - If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.

If the environment contains a single Amazon EC2 instance, there are no special requirements.

ELB load balancers - Health checking behavior depends on the type of load balancer:
Classic Load Balancers : If you specify an ELB Classic Load Balancer in DNSName , Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.
Application and Network Load Balancers : If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true , Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:
For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
A target group that has no registered targets is considered unhealthy.

When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they’re not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

S3 buckets - There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.
Other records in the same hosted zone - If the AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide .

For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-aliastarget.html#cfn-route53-recordset-aliastarget-evaluatetargethealth
Type:: *Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets

hosted_zone_id

.

Amazon API Gateway custom regional APIs and edge-optimized APIs - Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names :
For regional APIs, specify the value of regionalHostedZoneId .
For edge-optimized APIs, specify the value of distributionHostedZoneId .
Amazon Virtual Private Cloud interface VPC endpoint - Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints .
CloudFront distribution - Specify Z2FDTNDATAQYW2 . This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution.

Alias records for CloudFront can’t be created in a private zone.

Elastic Beanstalk environment - Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk endpoints and quotas in the Amazon Web Services General Reference .
ELB load balancer - Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
Service Endpoints table in the “Elastic Load Balancing Endpoints and Quotas” topic in the Amazon Web Services General Reference : Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
AWS Management Console : Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API : Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameID .
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneID .
CloudFormation Fn::GetAtt intrinsic function : Use the Fn::GetAtt intrinsic function to get the applicable value:
Classic Load Balancers: Get CanonicalHostedZoneNameID .
Application and Network Load Balancers: Get CanonicalHostedZoneID .
AWS CLI : Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID .
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneID .
Global Accelerator accelerator - Specify Z2BJ6XQ5FK7U4H .
An Amazon S3 bucket configured as a static website - Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference .
Another Route 53 record in your hosted zone - Specify the hosted zone ID of your hosted zone. (An alias record can’t reference a record in a different hosted zone.)

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-aliastarget.html#cfn-route53-recordset-aliastarget-hostedzoneid
Type:: Alias resource records sets only
Type:: The value used depends on where you want to route traffic

CidrRoutingConfigProperty

class CfnRecordSet.CidrRoutingConfigProperty(*, collection_id, location_name)

Bases: object

The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.

A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record.

Parameters:

collection_id (str) – The CIDR collection ID.
location_name (str) – The CIDR collection location name.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53 as route53

cidr_routing_config_property = route53.CfnRecordSet.CidrRoutingConfigProperty(
    collection_id="collectionId",
    location_name="locationName"
)

Attributes

collection_id

The CIDR collection ID.

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

location_name

The CIDR collection location name.

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

CoordinatesProperty

class CfnRecordSet.CoordinatesProperty(*, latitude, longitude)

Bases: object

A complex type that lists the coordinates for a geoproximity resource record.

Parameters:

latitude (str) – Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90).
longitude (str) – Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180).

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53 as route53

coordinates_property = route53.CfnRecordSet.CoordinatesProperty(
    latitude="latitude",
    longitude="longitude"
)

Attributes

latitude

Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-coordinates.html#cfn-route53-recordset-coordinates-latitude

longitude

Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-coordinates.html#cfn-route53-recordset-coordinates-longitude

GeoLocationProperty

class CfnRecordSet.GeoLocationProperty(*, continent_code=None, country_code=None, subdivision_code=None)

Bases: object

A complex type that contains information about a geographic location.

Parameters:

continent_code (Optional[str]) – For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Route 53 supports the following continent codes:. - AF : Africa - AN : Antarctica - AS : Asia - EU : Europe - OC : Oceania - NA : North America - SA : South America Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
country_code (Optional[str]) – For geolocation resource record sets, the two-letter code for a country. Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2 .
subdivision_code (Optional[str]) – For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn’t support any other values for SubdivisionCode . For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. If you specify subdivisioncode , you must also specify US for CountryCode .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53 as route53

geo_location_property = route53.CfnRecordSet.GeoLocationProperty(
    continent_code="continentCode",
    country_code="countryCode",
    subdivision_code="subdivisionCode"
)

Attributes

continent_code

.

AF : Africa
AN : Antarctica
AS : Asia
EU : Europe
OC : Oceania
NA : North America
SA : South America

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-continentcode
Type:: For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Route 53 supports the following continent codes

country_code

For geolocation resource record sets, the two-letter code for a country.

Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2 .

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

subdivision_code

For geolocation resource record sets, the two-letter code for a state of the United States.

Route 53 doesn’t support any other values for SubdivisionCode . For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.

If you specify subdivisioncode , you must also specify US for CountryCode .

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

GeoProximityLocationProperty

class CfnRecordSet.GeoProximityLocationProperty(*, aws_region=None, bias=None, coordinates=None, local_zone_group=None)

Bases: object

(Resource record sets only): A complex type that lets you specify where your resources are located.

Only one of LocalZoneGroup , Coordinates , or AWS Region is allowed per request at a time.

For more information about geoproximity routing, see Geoproximity routing in the Amazon Route 53 Developer Guide .

Parameters:

aws_region (Optional[str]) – The AWS Region the resource you are directing DNS traffic to, is in.
bias (Union[int, float, None]) – The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource. To use Bias to change the size of the geographic region, specify the applicable value for the bias: - To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions. - To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions.
coordinates (Union[IResolvable, CoordinatesProperty, Dict[str, Any], None]) – Contains the longitude and latitude for a geographic region.
local_zone_group (Optional[str]) – Specifies an AWS Local Zone Group. A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1 . You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command: This command returns: "GroupName": "us-west-2-den-1" , specifying that the Local Zone us-west-2-den-1a belongs to the Local Zone Group us-west-2-den-1 .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53 as route53

geo_proximity_location_property = route53.CfnRecordSet.GeoProximityLocationProperty(
    aws_region="awsRegion",
    bias=123,
    coordinates=route53.CfnRecordSet.CoordinatesProperty(
        latitude="latitude",
        longitude="longitude"
    ),
    local_zone_group="localZoneGroup"
)

Attributes

aws_region

The AWS Region the resource you are directing DNS traffic to, is in.

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

bias

The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource.

To use Bias to change the size of the geographic region, specify the applicable value for the bias:

To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions.
To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions.

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

coordinates

Contains the longitude and latitude for a geographic region.

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

local_zone_group

Specifies an AWS Local Zone Group.

A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1 .

You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command:

This command returns: "GroupName": "us-west-2-den-1" , specifying that the Local Zone us-west-2-den-1a belongs to the Local Zone Group us-west-2-den-1 .

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