AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

ARecord

A DNS A record.

Import

import { ARecord } from 'aws-cdk-lib/aws-route53';

Or use the module namespace:

import * as route53 from 'aws-cdk-lib/aws-route53';
// route53.ARecord

Properties

Configuration passed to the constructor as ARecordProps.

targetRequired
RecordTarget

The target.

13 properties inherited from RecordSetOptions
zoneRequiredinherited from RecordSetOptions
IHostedZone

The hosted zone in which to define the new record.

cidrRoutingConfigOptionalinherited from RecordSetOptions
CidrRoutingConfig

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.

Default: - No CIDR routing configured

commentOptionalinherited from RecordSetOptions
string

A comment to add on the record.

Default: no comment

deleteExistingOptionalDeprecatedinherited from RecordSetOptions
boolean

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!

Default: false

Deprecated: This property is dangerous and can lead to unintended record deletion in case of deployment failure.

failoverOptionalinherited from RecordSetOptions
Failover

Failover configuration for the record set. 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. You must also include the HealthCheckId element for PRIMARY configurations.

Default: - No failover configuration

geoLocationOptionalinherited from RecordSetOptions
GeoLocation

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

healthCheckOptionalinherited from RecordSetOptions
IHealthCheck

The health check to associate with the record set. Route53 will return this record set in response to DNS queries only if the health check is passing.

Default: - No health check configured

multiValueAnswerOptionalinherited from RecordSetOptions
boolean

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

Default: false

recordNameOptionalinherited from RecordSetOptions
string

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

regionOptionalinherited from RecordSetOptions
string

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

setIdentifierOptionalinherited from RecordSetOptions
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.

Default: - Auto generated string

ttlOptionalinherited from RecordSetOptions
Duration

The resource record cache time to live (TTL).

Default: Duration.minutes(30)

weightOptionalinherited from RecordSetOptions
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. 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

Get the Amazon Route 53 Cheat Sheet

Everything you need to know about Amazon Route 53 on one page. HD quality, print-friendly.

Download Free Infographic