aws-cdk-lib.aws_route53.ARecordProps

interface ARecordProps

LanguageType name
.NETAmazon.CDK.AWS.Route53.ARecordProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsroute53#ARecordProps
Javasoftware.amazon.awscdk.services.route53.ARecordProps
Pythonaws_cdk.aws_route53.ARecordProps
TypeScript (source)aws-cdk-lib » aws_route53 » ARecordProps

Construction properties for a ARecord.

Example

import * as apigw from 'aws-cdk-lib/aws-apigateway';

declare const zone: route53.HostedZone;
declare const restApi: apigw.LambdaRestApi;

new route53.ARecord(this, 'AliasRecord', {
  zone,
  target: route53.RecordTarget.fromAlias(new targets.ApiGateway(restApi)),
  // or - route53.RecordTarget.fromAlias(new alias.ApiGatewayDomain(domainName)),
});

Properties

NameTypeDescription
targetRecordTargetThe target.
zoneIHostedZoneThe hosted zone in which to define the new record.
comment?stringA comment to add on the record.
deleteExisting?booleanWhether to delete the same record set in the hosted zone if it already exists (dangerous!).
recordName?stringThe subdomain name for this record. This should be relative to the zone root name.
ttl?DurationThe resource record cache time to live (TTL).

target

Type: RecordTarget

The target.


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!


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


ttl?

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

The resource record cache time to live (TTL).