CaaAmazonRecordProps

class aws_cdk.aws_route53.CaaAmazonRecordProps(*, zone, comment=None, delete_existing=None, record_name=None, ttl=None)

Bases: RecordSetOptions

Construction properties for a CaaAmazonRecord.

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

  • record_name (Optional[str]) – The domain name for this record. Default: zone root

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

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

# hosted_zone: route53.HostedZone

caa_amazon_record_props = route53.CaaAmazonRecordProps(
    zone=hosted_zone,

    # the properties below are optional
    comment="comment",
    delete_existing=False,
    record_name="recordName",
    ttl=cdk.Duration.minutes(30)
)

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

record_name

The domain name for this record.

Default:

zone root

ttl

The resource record cache time to live (TTL).

Default:

Duration.minutes(30)

zone

The hosted zone in which to define the new record.