1.204.0

class CnameRecord (construct)

LanguageType name
.NETAmazon.CDK.AWS.Route53.CnameRecord
Javasoftware.amazon.awscdk.services.route53.CnameRecord
Pythonaws_cdk.aws_route53.CnameRecord
TypeScript (source)@aws-cdk/aws-route53 » CnameRecord

Implements IConstruct, IConstruct, IDependable, IResource, IRecordSet

A DNS CNAME record.

Example

import * as acm from '@aws-cdk/aws-certificatemanager';
import * as route53 from '@aws-cdk/aws-route53';

const myDomainName = 'api.example.com';
const certificate = new acm.Certificate(this, 'cert', { domainName: myDomainName });
const api = new appsync.GraphqlApi(this, 'api', {
  name: 'myApi',
  domainName: {
    certificate,
    domainName: myDomainName,
  },
});

// hosted zone and route53 features
declare const hostedZoneId: string;
declare const zoneName = 'example.com';

// hosted zone for adding appsync domain
const zone = route53.HostedZone.fromHostedZoneAttributes(this, `HostedZone`, {
  hostedZoneId,
  zoneName,
});

// create a cname to the appsync domain. will map to something like xxxx.cloudfront.net
new route53.CnameRecord(this, `CnameApiRecord`, {
  recordName: 'api',
  zone,
  domainName: myDomainName,
});

Initializer

new CnameRecord(scope: Construct, id: string, props: CnameRecordProps)

Parameters

Construct Props

NameTypeDescription
domainNamestringThe domain name.
zoneIHostedZoneThe hosted zone in which to define the new record.
comment?stringA comment to add on the record.
recordName?stringThe domain name for this record.
ttl?DurationThe resource record cache time to live (TTL).

domainName

Type: string

The domain name.

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

NameTypeDescription
domainNamestringThe domain name of the record.
envResourceEnvironmentThe environment this resource belongs to.
nodeConstructNodeThe construct tree node associated with this construct.
stackStackThe 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

NameDescription
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

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.

← PreviousNext →