class CaaRecord (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Route53.CaaRecord
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsroute53#CaaRecord
Java	software.amazon.awscdk.services.route53.CaaRecord
Python	aws_cdk.aws_route53.CaaRecord
TypeScript (source)	aws-cdk-lib » aws_route53 » CaaRecord

Implements IConstruct, IDependable, IResource, IRecordSet

A DNS CAA record.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_route53 as route53 } from 'aws-cdk-lib';

declare const geoLocation: route53.GeoLocation;
declare const hostedZone: route53.HostedZone;
const caaRecord = new route53.CaaRecord(this, 'MyCaaRecord', {
  values: [{
    flag: 123,
    tag: route53.CaaTag.ISSUE,
    value: 'value',
  }],
  zone: hostedZone,

  // the properties below are optional
  comment: 'comment',
  deleteExisting: false,
  geoLocation: geoLocation,
  multiValueAnswer: false,
  recordName: 'recordName',
  region: 'region',
  setIdentifier: 'setIdentifier',
  ttl: cdk.Duration.minutes(30),
  weight: 123,
});

Initializer

new CaaRecord(scope: Construct, id: string, props: CaaRecordProps)

Parameters

• scope Construct
• id string
• props CaaRecordProps

Construct Props

Name	Type	Description
values	CaaRecordValue[]	The values.
zone	IHostedZone	The hosted zone in which to define the new record.
comment?	string	A comment to add on the record.
deleteExisting?	boolean	Whether to delete the same record set in the hosted zone if it already exists (dangerous!).
geoLocation?	GeoLocation	The geographical origin for this record to return DNS records based on the user's location.
multiValueAnswer?	boolean	Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries.
recordName?	string	The subdomain name for this record. This should be relative to the zone root name.
region?	string	The Amazon EC2 Region where you created the resource that this resource record set refers to.
setIdentifier?	string	A string used to distinguish between different records with the same combination of DNS name and type.
ttl?	Duration	The resource record cache time to live (TTL).
weight?	number	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.

---

values

Type: CaaRecordValue[]

The values.

---

zone

Type: IHostedZone

The hosted zone in which to define the new record.

---

comment?

Type: string (optional, default: no comment)

A comment to add on the record.

---

deleteExisting?

Type: boolean (optional, default: false)

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.

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!

---

geoLocation?

Type: GeoLocation (optional)

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

---

multiValueAnswer?

Type: boolean (optional, default: false)

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

---

recordName?

Type: string (optional, default: zone root)

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

---

region?

Type: string (optional, default: Do not set latency based routing)

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.

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

---

setIdentifier?

Type: string (optional, default: Auto generated string)

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.

---

ttl?

Type: Duration (optional, default: Duration.minutes(30))

The resource record cache time to live (TTL).

---

weight?

Type: number (optional, default: Do not set weighted routing)

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.

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

Properties

Name	Type	Description
domainName	string	The domain name of the record.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

domainName

Type: string

The domain name of the record.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.