class RecordSet (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Route53.RecordSet`
Java	`software.amazon.awscdk.services.route53.RecordSet`
Python	`aws_cdk.aws_route53.RecordSet`
TypeScript (source)	`@aws-cdk/aws-route53` » `RecordSet`

Implements IConstruct, IConstruct, IDependable, IResource, IRecordSet

A record set.

Example

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

declare const hostedZone: route53.HostedZone;
declare const recordTarget: route53.RecordTarget;
const recordSet = new route53.RecordSet(this, 'MyRecordSet', {
  recordType: route53.RecordType.A,
  target: recordTarget,
  zone: hostedZone,

  // the properties below are optional
  comment: 'comment',
  recordName: 'recordName',
  ttl: cdk.Duration.minutes(30),
});

Initializer

new RecordSet(scope: Construct, id: string, props: RecordSetProps)

Parameters

scope Construct
id string
props RecordSetProps

Construct Props

Name	Type	Description
recordType	`RecordType`	The record type.
target	`RecordTarget`	The target for this record, either `RecordTarget.fromValues()` or `RecordTarget.fromAlias()`.
zone	`IHostedZone`	The hosted zone in which to define the new record.
comment?	`string`	A comment to add on the record.
recordName?	`string`	The domain name for this record.
ttl?	`Duration`	The resource record cache time to live (TTL).

recordType

Type: RecordType

The record type.

target

Type: RecordTarget

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

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.

recordName?

Type: string (optional, default: zone root)

The domain name for this record.

ttl?

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

The resource record cache time to live (TTL).

Properties

Name	Type	Description
domainName	`string`	The domain name of the record.
env	`ResourceEnvironment`	The environment this resource belongs to.
node	`ConstructNode`	The construct tree node associated with this construct.
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: ConstructNode

The construct tree node associated with this construct.

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.