RecordSetProps

class aws_cdk.aws_route53.RecordSetProps(*, zone, comment=None, delete_existing=None, geo_location=None, multi_value_answer=None, record_name=None, region=None, set_identifier=None, ttl=None, weight=None, record_type, target)

Bases: RecordSetOptions

Construction properties for a RecordSet.

Parameters:
  • zone (IHostedZone) – The hosted zone in which to define the new record.

  • comment (Optional[str]) – A comment to add on the record. Default: no comment

  • delete_existing (Optional[bool]) – Whether to delete the same record set in the hosted zone if it already exists (dangerous!). This allows to deploy a new record set while minimizing the downtime because the new record set will be created immediately after the existing one is deleted. It also avoids “manual” actions to delete existing record sets. .. epigraph:: N.B.: this feature is dangerous, use with caution! It can only be used safely when deleteExisting is set to true as soon as the resource is added to the stack. Changing an existing Record Set’s deleteExisting property from false -> true after deployment will delete the record! Default: false

  • geo_location (Optional[GeoLocation]) – The geographical origin for this record to return DNS records based on the user’s location.

  • multi_value_answer (Optional[bool]) – Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries. Default: false

  • record_name (Optional[str]) – The subdomain name for this record. This should be relative to the zone root name. For example, if you want to create a record for acme.example.com, specify “acme”. You can also specify the fully qualified domain name which terminates with a “.”. For example, “acme.example.com.”. Default: zone root

  • region (Optional[str]) – 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. Default: - Do not set latency based routing

  • set_identifier (Optional[str]) – A string used to distinguish between different records with the same combination of DNS name and type. It can only be set when either weight or geoLocation is defined. This parameter must be between 1 and 128 characters in length. Default: - Auto generated string

  • ttl (Optional[Duration]) – The resource record cache time to live (TTL). Default: Duration.minutes(30)

  • weight (Union[int, float, None]) – 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. This value can be a number between 0 and 255. Default: - Do not set weighted routing

  • record_type (RecordType) – The record type.

  • target (RecordTarget) – The target for this record, either RecordTarget.fromValues() or RecordTarget.fromAlias().

ExampleMetadata:

fixture=_generated

Example:

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

# geo_location: route53.GeoLocation
# hosted_zone: route53.HostedZone
# record_target: route53.RecordTarget

record_set_props = route53.RecordSetProps(
    record_type=route53.RecordType.A,
    target=record_target,
    zone=hosted_zone,

    # the properties below are optional
    comment="comment",
    delete_existing=False,
    geo_location=geo_location,
    multi_value_answer=False,
    record_name="recordName",
    region="region",
    set_identifier="setIdentifier",
    ttl=cdk.Duration.minutes(30),
    weight=123
)

Attributes

comment

A comment to add on the record.

Default:

no comment

delete_existing

Whether to delete the same record set in the hosted zone if it already exists (dangerous!).

This allows to deploy a new record set while minimizing the downtime because the new record set will be created immediately after the existing one is deleted. It also avoids “manual” actions to delete existing record sets. .. epigraph:

**N.B.:** this feature is dangerous, use with caution! It can only be used safely when
``deleteExisting`` is set to ``true`` as soon as the resource is added to the stack. Changing
an existing Record Set's ``deleteExisting`` property from ``false -> true`` after deployment
will delete the record!
Default:

false

geo_location

The geographical origin for this record to return DNS records based on the user’s location.

multi_value_answer

Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries.

Default:

false

record_name

The subdomain name for this record. This should be relative to the zone root name.

For example, if you want to create a record for acme.example.com, specify “acme”.

You can also specify the fully qualified domain name which terminates with a “.”. For example, “acme.example.com.”.

Default:

zone root

record_type

The record type.

region

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.

Default:
  • Do not set latency based routing

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordset.html#cfn-route53-recordset-region

set_identifier

A string used to distinguish between different records with the same combination of DNS name and type.

It can only be set when either weight or geoLocation is defined.

This parameter must be between 1 and 128 characters in length.

Default:
  • Auto generated string

target

The target for this record, either RecordTarget.fromValues() or RecordTarget.fromAlias().

ttl

The resource record cache time to live (TTL).

Default:

Duration.minutes(30)

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.

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.

This value can be a number between 0 and 255.

Default:
  • Do not set weighted routing

See:

https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-weighted.html

zone

The hosted zone in which to define the new record.