This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-route53

AWS Route53 Construct Library

To add a public hosted zone:

import route53 = require('@aws-cdk/aws-route53');

new route53.PublicHostedZone(this, 'HostedZone', {
    zoneName: 'fully.qualified.domain.com'
});

To add a private hosted zone, use PrivateHostedZone. Note that enableDnsHostnames and enableDnsSupport must have been enabled for the VPC you’re configuring for private hosted zones.

import ec2 = require('@aws-cdk/aws-ec2');
import route53 = require('@aws-cdk/aws-route53');

const vpc = new ec2.VpcNetwork(this, 'VPC');

const zone = new route53.PrivateHostedZone(this, 'HostedZone', {
    zoneName: 'fully.qualified.domain.com',
    vpc    // At least one VPC has to be added to a Private Hosted Zone.
});

Additional VPCs can be added with zone.addVPC().

Adding Records

To add a TXT record to your zone:

import route53 = require('@aws-cdk/aws-route53');

new route53.TxtRecord(zone, 'TXTRecord', {
    recordName: '_foo',  // If the name ends with a ".", it will be used as-is;
                         // if it ends with a "." followed by the zone name, a trailing "." will be added automatically;
                         // otherwise, a ".", the zone name, and a trailing "." will be added automatically.
    recordValue: 'Bar!', // Will be quoted for you, and " will be escaped automatically.
    ttl: 90,             // Optional - default is 1800
});

Adding records to existing hosted zones

If you know the ID and Name of a Hosted Zone, you can import it directly:

const zone = HostedZone.import(this, 'MyZone', {
    zoneName: 'example.com',
    hostedZoneId: 'ZOJJZC49E0EPZ',
});

If you don’t know the ID of a Hosted Zone, you can use the HostedZoneProvider to discover and import it:

const zone = new HostedZoneProvider(this, {
    domainName: 'example.com'
}).findAndImport(this, 'MyZone');

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.Route53" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.Route53 --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.Route53" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:route53:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="route53" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>route53</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:route53:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='route53', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-route53@0.25.3

package.json:

{
  "@aws-cdk/aws-route53": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-route53@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-route53@0.25.3

package.json:

{
  "@aws-cdk/aws-route53": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-route53@0.25.3

AliasRecord

class @aws-cdk/aws-route53.AliasRecord(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.AliasRecord;
const { AliasRecord } = require('@aws-cdk/aws-route53');
import { AliasRecord } from '@aws-cdk/aws-route53';

A Route53 alias record

Extends:

@aws-cdk/cdk.Construct

Parameters:
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

AliasRecordProps (interface)

class @aws-cdk/aws-route53.AliasRecordProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.AliasRecordProps;
// AliasRecordProps is an interface
import { AliasRecordProps } from '@aws-cdk/aws-route53';
recordName

Name for the record. This can be the FQDN for the record (foo.example.com) or

a subdomain of the parent hosted zone (foo, with example.com as the hosted zone).

Type:string
target

Target for the alias record

Type:IAliasRecordTarget
zone

The zone in which this alias should be defined.

Type:IHostedZone

AliasRecordTargetProps (interface)

class @aws-cdk/aws-route53.AliasRecordTargetProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.AliasRecordTargetProps;
// AliasRecordTargetProps is an interface
import { AliasRecordTargetProps } from '@aws-cdk/aws-route53';

Represents the properties of an alias target destination.

dnsName

DNS name of the target

Type:string
hostedZoneId

Hosted zone ID of the target

Type:string

CfnHealthCheck

class @aws-cdk/aws-route53.CfnHealthCheck(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHealthCheck;
const { CfnHealthCheck } = require('@aws-cdk/aws-route53');
import { CfnHealthCheck } from '@aws-cdk/aws-route53';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
healthCheckId
Type:string (readonly)
propertyOverrides
Type:CfnHealthCheckProps (readonly)
class AlarmIdentifierProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHealthCheck.AlarmIdentifierProperty;
// CfnHealthCheck.AlarmIdentifierProperty is an interface
import { CfnHealthCheck.AlarmIdentifierProperty } from '@aws-cdk/aws-route53';
name

CfnHealthCheck.AlarmIdentifierProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-name

Type:string
region

CfnHealthCheck.AlarmIdentifierProperty.Region

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-region

Type:string
class HealthCheckConfigProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckConfigProperty;
// CfnHealthCheck.HealthCheckConfigProperty is an interface
import { CfnHealthCheck.HealthCheckConfigProperty } from '@aws-cdk/aws-route53';
type

CfnHealthCheck.HealthCheckConfigProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type

Type:string
alarmIdentifier

CfnHealthCheck.HealthCheckConfigProperty.AlarmIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-alarmidentifier

Type:@aws-cdk/cdk.Token or AlarmIdentifierProperty (optional)
childHealthChecks

CfnHealthCheck.HealthCheckConfigProperty.ChildHealthChecks

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-childhealthchecks

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
enableSni

CfnHealthCheck.HealthCheckConfigProperty.EnableSNI

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-enablesni

Type:boolean or @aws-cdk/cdk.Token (optional)
failureThreshold

CfnHealthCheck.HealthCheckConfigProperty.FailureThreshold

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-failurethreshold

Type:number or @aws-cdk/cdk.Token (optional)
fullyQualifiedDomainName

CfnHealthCheck.HealthCheckConfigProperty.FullyQualifiedDomainName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-fullyqualifieddomainname

Type:string (optional)
healthThreshold

CfnHealthCheck.HealthCheckConfigProperty.HealthThreshold

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-healththreshold

Type:number or @aws-cdk/cdk.Token (optional)
insufficientDataHealthStatus

CfnHealthCheck.HealthCheckConfigProperty.InsufficientDataHealthStatus

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-insufficientdatahealthstatus

Type:string (optional)
inverted

CfnHealthCheck.HealthCheckConfigProperty.Inverted

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-inverted

Type:boolean or @aws-cdk/cdk.Token (optional)
ipAddress

CfnHealthCheck.HealthCheckConfigProperty.IPAddress

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-ipaddress

Type:string (optional)
measureLatency

CfnHealthCheck.HealthCheckConfigProperty.MeasureLatency

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-measurelatency

Type:boolean or @aws-cdk/cdk.Token (optional)
port

CfnHealthCheck.HealthCheckConfigProperty.Port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-port

Type:number or @aws-cdk/cdk.Token (optional)
regions

CfnHealthCheck.HealthCheckConfigProperty.Regions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-regions

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
requestInterval

CfnHealthCheck.HealthCheckConfigProperty.RequestInterval

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-requestinterval

Type:number or @aws-cdk/cdk.Token (optional)
resourcePath

CfnHealthCheck.HealthCheckConfigProperty.ResourcePath

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-resourcepath

Type:string (optional)
searchString

CfnHealthCheck.HealthCheckConfigProperty.SearchString

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-searchstring

Type:string (optional)
class HealthCheckTagProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHealthCheck.HealthCheckTagProperty;
// CfnHealthCheck.HealthCheckTagProperty is an interface
import { CfnHealthCheck.HealthCheckTagProperty } from '@aws-cdk/aws-route53';
key

CfnHealthCheck.HealthCheckTagProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthchecktags-key

Type:string
value

CfnHealthCheck.HealthCheckTagProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthchecktags-value

Type:string
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnHealthCheckProps (interface)

class @aws-cdk/aws-route53.CfnHealthCheckProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHealthCheckProps;
// CfnHealthCheckProps is an interface
import { CfnHealthCheckProps } from '@aws-cdk/aws-route53';
healthCheckConfig

AWS::Route53::HealthCheck.HealthCheckConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig

Type:HealthCheckConfigProperty or @aws-cdk/cdk.Token
healthCheckTags

AWS::Route53::HealthCheck.HealthCheckTags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or HealthCheckTagProperty)[] (optional)

CfnHostedZone

class @aws-cdk/aws-route53.CfnHostedZone(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHostedZone;
const { CfnHostedZone } = require('@aws-cdk/aws-route53');
import { CfnHostedZone } from '@aws-cdk/aws-route53';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
hostedZoneId
Type:string (readonly)
hostedZoneNameServers
Type:string[] (readonly)
propertyOverrides
Type:CfnHostedZoneProps (readonly)
class HostedZoneConfigProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHostedZone.HostedZoneConfigProperty;
// CfnHostedZone.HostedZoneConfigProperty is an interface
import { CfnHostedZone.HostedZoneConfigProperty } from '@aws-cdk/aws-route53';
comment

CfnHostedZone.HostedZoneConfigProperty.Comment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html#cfn-route53-hostedzone-hostedzoneconfig-comment

Type:string (optional)
class HostedZoneTagProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHostedZone.HostedZoneTagProperty;
// CfnHostedZone.HostedZoneTagProperty is an interface
import { CfnHostedZone.HostedZoneTagProperty } from '@aws-cdk/aws-route53';
key

CfnHostedZone.HostedZoneTagProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html#cfn-route53-hostedzonetags-key

Type:string
value

CfnHostedZone.HostedZoneTagProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html#cfn-route53-hostedzonetags-value

Type:string
class QueryLoggingConfigProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHostedZone.QueryLoggingConfigProperty;
// CfnHostedZone.QueryLoggingConfigProperty is an interface
import { CfnHostedZone.QueryLoggingConfigProperty } from '@aws-cdk/aws-route53';
cloudWatchLogsLogGroupArn

CfnHostedZone.QueryLoggingConfigProperty.CloudWatchLogsLogGroupArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html#cfn-route53-hostedzone-queryloggingconfig-cloudwatchlogsloggrouparn

Type:string
class VPCProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHostedZone.VPCProperty;
// CfnHostedZone.VPCProperty is an interface
import { CfnHostedZone.VPCProperty } from '@aws-cdk/aws-route53';
vpcId

CfnHostedZone.VPCProperty.VPCId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcid

Type:string
vpcRegion

CfnHostedZone.VPCProperty.VPCRegion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcregion

Type:string
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnHostedZoneProps (interface)

class @aws-cdk/aws-route53.CfnHostedZoneProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnHostedZoneProps;
// CfnHostedZoneProps is an interface
import { CfnHostedZoneProps } from '@aws-cdk/aws-route53';
name

AWS::Route53::HostedZone.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name

Type:string
hostedZoneConfig

AWS::Route53::HostedZone.HostedZoneConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig

Type:@aws-cdk/cdk.Token or HostedZoneConfigProperty (optional)
hostedZoneTags

AWS::Route53::HostedZone.HostedZoneTags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or HostedZoneTagProperty)[] (optional)
queryLoggingConfig

AWS::Route53::HostedZone.QueryLoggingConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig

Type:@aws-cdk/cdk.Token or QueryLoggingConfigProperty (optional)
vpcs

AWS::Route53::HostedZone.VPCs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs

Type:@aws-cdk/cdk.Token or (VPCProperty or @aws-cdk/cdk.Token)[] (optional)

CfnRecordSet

class @aws-cdk/aws-route53.CfnRecordSet(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnRecordSet;
const { CfnRecordSet } = require('@aws-cdk/aws-route53');
import { CfnRecordSet } from '@aws-cdk/aws-route53';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnRecordSetProps (readonly)
recordSetDomainName
Type:string (readonly)
class AliasTargetProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnRecordSet.AliasTargetProperty;
// CfnRecordSet.AliasTargetProperty is an interface
import { CfnRecordSet.AliasTargetProperty } from '@aws-cdk/aws-route53';
dnsName

CfnRecordSet.AliasTargetProperty.DNSName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname

Type:string
hostedZoneId

CfnRecordSet.AliasTargetProperty.HostedZoneId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid

Type:string
evaluateTargetHealth

CfnRecordSet.AliasTargetProperty.EvaluateTargetHealth

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth

Type:boolean or @aws-cdk/cdk.Token (optional)
class GeoLocationProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnRecordSet.GeoLocationProperty;
// CfnRecordSet.GeoLocationProperty is an interface
import { CfnRecordSet.GeoLocationProperty } from '@aws-cdk/aws-route53';
continentCode

CfnRecordSet.GeoLocationProperty.ContinentCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-continentcode

Type:string (optional)
countryCode

CfnRecordSet.GeoLocationProperty.CountryCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode

Type:string (optional)
subdivisionCode

CfnRecordSet.GeoLocationProperty.SubdivisionCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnRecordSetGroup

class @aws-cdk/aws-route53.CfnRecordSetGroup(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnRecordSetGroup;
const { CfnRecordSetGroup } = require('@aws-cdk/aws-route53');
import { CfnRecordSetGroup } from '@aws-cdk/aws-route53';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnRecordSetGroupProps (readonly)
recordSetGroupName
Type:string (readonly)
class AliasTargetProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnRecordSetGroup.AliasTargetProperty;
// CfnRecordSetGroup.AliasTargetProperty is an interface
import { CfnRecordSetGroup.AliasTargetProperty } from '@aws-cdk/aws-route53';
dnsName

CfnRecordSetGroup.AliasTargetProperty.DNSName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname

Type:string
hostedZoneId

CfnRecordSetGroup.AliasTargetProperty.HostedZoneId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid

Type:string
evaluateTargetHealth

CfnRecordSetGroup.AliasTargetProperty.EvaluateTargetHealth

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth

Type:boolean or @aws-cdk/cdk.Token (optional)
class GeoLocationProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnRecordSetGroup.GeoLocationProperty;
// CfnRecordSetGroup.GeoLocationProperty is an interface
import { CfnRecordSetGroup.GeoLocationProperty } from '@aws-cdk/aws-route53';
continentCode

CfnRecordSetGroup.GeoLocationProperty.ContinentCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordsetgroup-geolocation-continentcode

Type:string (optional)
countryCode

CfnRecordSetGroup.GeoLocationProperty.CountryCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode

Type:string (optional)
subdivisionCode

CfnRecordSetGroup.GeoLocationProperty.SubdivisionCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode

Type:string (optional)
class RecordSetProperty

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnRecordSetGroup.RecordSetProperty;
// CfnRecordSetGroup.RecordSetProperty is an interface
import { CfnRecordSetGroup.RecordSetProperty } from '@aws-cdk/aws-route53';
name

CfnRecordSetGroup.RecordSetProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name

Type:string
type

CfnRecordSetGroup.RecordSetProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type

Type:string
aliasTarget

CfnRecordSetGroup.RecordSetProperty.AliasTarget

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget

Type:@aws-cdk/cdk.Token or AliasTargetProperty (optional)
comment

CfnRecordSetGroup.RecordSetProperty.Comment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment

Type:string (optional)
failover

CfnRecordSetGroup.RecordSetProperty.Failover

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover

Type:string (optional)
geoLocation

CfnRecordSetGroup.RecordSetProperty.GeoLocation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation

Type:@aws-cdk/cdk.Token or GeoLocationProperty (optional)
healthCheckId

CfnRecordSetGroup.RecordSetProperty.HealthCheckId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid

Type:string (optional)
hostedZoneId

CfnRecordSetGroup.RecordSetProperty.HostedZoneId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid

Type:string (optional)
hostedZoneName

CfnRecordSetGroup.RecordSetProperty.HostedZoneName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename

Type:string (optional)
multiValueAnswer

CfnRecordSetGroup.RecordSetProperty.MultiValueAnswer

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer

Type:boolean or @aws-cdk/cdk.Token (optional)
region

CfnRecordSetGroup.RecordSetProperty.Region

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region

Type:string (optional)
resourceRecords

CfnRecordSetGroup.RecordSetProperty.ResourceRecords

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
setIdentifier

CfnRecordSetGroup.RecordSetProperty.SetIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier

Type:string (optional)
ttl

CfnRecordSetGroup.RecordSetProperty.TTL

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl

Type:string (optional)
weight

CfnRecordSetGroup.RecordSetProperty.Weight

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight

Type:number or @aws-cdk/cdk.Token (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnRecordSetGroupProps (interface)

class @aws-cdk/aws-route53.CfnRecordSetGroupProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnRecordSetGroupProps;
// CfnRecordSetGroupProps is an interface
import { CfnRecordSetGroupProps } from '@aws-cdk/aws-route53';
comment

AWS::Route53::RecordSetGroup.Comment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment

Type:string (optional)
hostedZoneId

AWS::Route53::RecordSetGroup.HostedZoneId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid

Type:string (optional)
hostedZoneName

AWS::Route53::RecordSetGroup.HostedZoneName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename

Type:string (optional)
recordSets

AWS::Route53::RecordSetGroup.RecordSets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or RecordSetProperty)[] (optional)

CfnRecordSetProps (interface)

class @aws-cdk/aws-route53.CfnRecordSetProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CfnRecordSetProps;
// CfnRecordSetProps is an interface
import { CfnRecordSetProps } from '@aws-cdk/aws-route53';
name

AWS::Route53::RecordSet.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name

Type:string
type

AWS::Route53::RecordSet.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type

Type:string
aliasTarget

AWS::Route53::RecordSet.AliasTarget

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget

Type:@aws-cdk/cdk.Token or AliasTargetProperty (optional)
comment

AWS::Route53::RecordSet.Comment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment

Type:string (optional)
failover

AWS::Route53::RecordSet.Failover

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover

Type:string (optional)
geoLocation

AWS::Route53::RecordSet.GeoLocation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation

Type:@aws-cdk/cdk.Token or GeoLocationProperty (optional)
healthCheckId

AWS::Route53::RecordSet.HealthCheckId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid

Type:string (optional)
hostedZoneId

AWS::Route53::RecordSet.HostedZoneId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid

Type:string (optional)
hostedZoneName

AWS::Route53::RecordSet.HostedZoneName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename

Type:string (optional)
multiValueAnswer

AWS::Route53::RecordSet.MultiValueAnswer

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-multivalueanswer

Type:boolean or @aws-cdk/cdk.Token (optional)
region

AWS::Route53::RecordSet.Region

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region

Type:string (optional)
resourceRecords

AWS::Route53::RecordSet.ResourceRecords

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
setIdentifier

AWS::Route53::RecordSet.SetIdentifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier

Type:string (optional)
ttl

AWS::Route53::RecordSet.TTL

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl

Type:string (optional)
weight

AWS::Route53::RecordSet.Weight

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight

Type:number or @aws-cdk/cdk.Token (optional)

CnameRecord

class @aws-cdk/aws-route53.CnameRecord(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CnameRecord;
const { CnameRecord } = require('@aws-cdk/aws-route53');
import { CnameRecord } from '@aws-cdk/aws-route53';

A DNS CNAME record

Extends:

@aws-cdk/cdk.Construct

Parameters:
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CnameRecordProps (interface)

class @aws-cdk/aws-route53.CnameRecordProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CnameRecordProps;
// CnameRecordProps is an interface
import { CnameRecordProps } from '@aws-cdk/aws-route53';
recordName

The domain name for this record set.

Type:string
recordValue

The value for this record set.

Type:string
zone

The hosted zone in which to define the new TXT record.

Type:IHostedZone
ttl

The resource record cache time to live (TTL) in seconds.

Type:number (optional)
Default:1800 seconds

CommonHostedZoneProps (interface)

class @aws-cdk/aws-route53.CommonHostedZoneProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.CommonHostedZoneProps;
// CommonHostedZoneProps is an interface
import { CommonHostedZoneProps } from '@aws-cdk/aws-route53';
zoneName

The name of the domain. For resource record types that include a domain

name, specify a fully qualified domain name.

Type:string
comment

Any comments that you want to include about the hosted zone.

Type:string (optional)
Default:none
queryLogsLogGroupArn

The Amazon Resource Name (ARN) for the log group that you want Amazon Route 53 to send query logs to.

Type:string (optional)
Default:disabled

HostedZone

class @aws-cdk/aws-route53.HostedZone(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.HostedZone;
const { HostedZone } = require('@aws-cdk/aws-route53');
import { HostedZone } from '@aws-cdk/aws-route53';
Extends:

@aws-cdk/cdk.Construct

Implements:

IHostedZone

Parameters:
static import(scope, id, props) → @aws-cdk/aws-route53.IHostedZone

Imports a hosted zone from another stack.

Parameters:
Return type:

IHostedZone

addVpc(vpc)

Add another VPC to this private hosted zone.

Parameters:vpc (@aws-cdk/aws-ec2.IVpcNetwork) – the other VPC to add.
export() → @aws-cdk/aws-route53.HostedZoneImportProps

Implements @aws-cdk/aws-route53.IHostedZone.export()

Export the hosted zone

Return type:HostedZoneImportProps
hostedZoneId

Implements @aws-cdk/aws-route53.IHostedZone.hostedZoneId()

ID of this hosted zone, such as “Z23ABC4XYZL05B”

Type:string (readonly)
vpcs

VPCs to which this hosted zone will be added

Protected property

Type:VPCProperty[] (readonly)
zoneName

Implements @aws-cdk/aws-route53.IHostedZone.zoneName()

FQDN of this hosted zone

Type:string (readonly)
hostedZoneNameServers

Implements @aws-cdk/aws-route53.IHostedZone.hostedZoneNameServers()

Returns the set of name servers for the specific hosted zone. For example:

ns1.example.com.

This attribute will be undefined for private hosted zones or hosted zones imported from another stack.

Type:string[] (optional) (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

HostedZoneImportProps (interface)

class @aws-cdk/aws-route53.HostedZoneImportProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.HostedZoneImportProps;
// HostedZoneImportProps is an interface
import { HostedZoneImportProps } from '@aws-cdk/aws-route53';

Reference to a hosted zone

hostedZoneId

Identifier of the hosted zone

Type:string
zoneName

Name of the hosted zone

Type:string

HostedZoneProps (interface)

class @aws-cdk/aws-route53.HostedZoneProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.HostedZoneProps;
// HostedZoneProps is an interface
import { HostedZoneProps } from '@aws-cdk/aws-route53';

Properties of a new hosted zone

Extends:CommonHostedZoneProps
vpcs

A VPC that you want to associate with this hosted zone. When you specify

this property, a private hosted zone will be created.

You can associate additional VPCs to this private zone using addVpc(vpc).

Type:@aws-cdk/aws-ec2.IVpcNetwork[] (optional)
Default:public (no VPCs associated)
zoneName

Inherited from @aws-cdk/aws-route53.CommonHostedZoneProps

The name of the domain. For resource record types that include a domain

name, specify a fully qualified domain name.

Type:string
comment

Inherited from @aws-cdk/aws-route53.CommonHostedZoneProps

Any comments that you want to include about the hosted zone.

Type:string (optional)
Default:none
queryLogsLogGroupArn

Inherited from @aws-cdk/aws-route53.CommonHostedZoneProps

The Amazon Resource Name (ARN) for the log group that you want Amazon Route 53 to send query logs to.

Type:string (optional)
Default:disabled

HostedZoneProvider

class @aws-cdk/aws-route53.HostedZoneProvider(context, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.HostedZoneProvider;
const { HostedZoneProvider } = require('@aws-cdk/aws-route53');
import { HostedZoneProvider } from '@aws-cdk/aws-route53';

Context provider that will lookup the Hosted Zone ID for the given arguments

Parameters:
findAndImport(scope, id) → @aws-cdk/aws-route53.IHostedZone

This method calls findHostedZone and returns the imported hosted zone

Parameters:
Return type:

IHostedZone

findHostedZone() → @aws-cdk/aws-route53.HostedZoneImportProps

Return the hosted zone meeting the filter

Return type:HostedZoneImportProps

HostedZoneProviderProps (interface)

class @aws-cdk/aws-route53.HostedZoneProviderProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.HostedZoneProviderProps;
// HostedZoneProviderProps is an interface
import { HostedZoneProviderProps } from '@aws-cdk/aws-route53';

Zone properties for looking up the Hosted Zone

domainName

The zone domain e.g. example.com

Type:string
privateZone

Is this a private zone

Type:boolean (optional)
vpcId

If this is a private zone which VPC is assocaitated

Type:string (optional)

IAliasRecordTarget (interface)

class @aws-cdk/aws-route53.IAliasRecordTarget

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.IAliasRecordTarget;
// IAliasRecordTarget is an interface
import { IAliasRecordTarget } from '@aws-cdk/aws-route53';

Classes that are valid alias record targets, like CloudFront distributions and load

balancers, should implement this interface.

asAliasRecordTarget() → @aws-cdk/aws-route53.AliasRecordTargetProps

Return hosted zone ID and DNS name, usable for Route53 alias targets

Return type:AliasRecordTargetProps
Abstract:Yes

IHostedZone (interface)

class @aws-cdk/aws-route53.IHostedZone

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.IHostedZone;
// IHostedZone is an interface
import { IHostedZone } from '@aws-cdk/aws-route53';

Imported or created hosted zone

Extends:@aws-cdk/cdk.IConstruct
hostedZoneId

ID of this hosted zone, such as “Z23ABC4XYZL05B”

Type:string (readonly)
zoneName

FQDN of this hosted zone

Type:string (readonly)
hostedZoneNameServers

Returns the set of name servers for the specific hosted zone. For example:

ns1.example.com.

This attribute will be undefined for private hosted zones or hosted zones imported from another stack.

Type:string[] (optional) (readonly)
export() → @aws-cdk/aws-route53.HostedZoneImportProps

Export the hosted zone

Return type:HostedZoneImportProps
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

PrivateHostedZone

class @aws-cdk/aws-route53.PrivateHostedZone(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.PrivateHostedZone;
const { PrivateHostedZone } = require('@aws-cdk/aws-route53');
import { PrivateHostedZone } from '@aws-cdk/aws-route53';

Create a Route53 private hosted zone for use in one or more VPCs.

Note that enableDnsHostnames and enableDnsSupport must have been enabled

for the VPC you’re configuring for private hosted zones.

Extends:

HostedZone

Parameters:
addVpc(vpc)

Inherited from @aws-cdk/aws-route53.HostedZone

Add another VPC to this private hosted zone.

Parameters:vpc (@aws-cdk/aws-ec2.IVpcNetwork) – the other VPC to add.
export() → @aws-cdk/aws-route53.HostedZoneImportProps

Inherited from @aws-cdk/aws-route53.HostedZone

Export the hosted zone

Return type:HostedZoneImportProps
hostedZoneId

Inherited from @aws-cdk/aws-route53.HostedZone

ID of this hosted zone, such as “Z23ABC4XYZL05B”

Type:string (readonly)
vpcs

Inherited from @aws-cdk/aws-route53.HostedZone

VPCs to which this hosted zone will be added

Protected property

Type:VPCProperty[] (readonly)
zoneName

Inherited from @aws-cdk/aws-route53.HostedZone

FQDN of this hosted zone

Type:string (readonly)
hostedZoneNameServers

Inherited from @aws-cdk/aws-route53.HostedZone

Returns the set of name servers for the specific hosted zone. For example:

ns1.example.com.

This attribute will be undefined for private hosted zones or hosted zones imported from another stack.

Type:string[] (optional) (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

PrivateHostedZoneProps (interface)

class @aws-cdk/aws-route53.PrivateHostedZoneProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.PrivateHostedZoneProps;
// PrivateHostedZoneProps is an interface
import { PrivateHostedZoneProps } from '@aws-cdk/aws-route53';
Extends:CommonHostedZoneProps
vpc

A VPC that you want to associate with this hosted zone.

Private hosted zones must be associated with at least one VPC. You can

associated additional VPCs using addVpc(vpc).

Type:@aws-cdk/aws-ec2.IVpcNetwork
zoneName

Inherited from @aws-cdk/aws-route53.CommonHostedZoneProps

The name of the domain. For resource record types that include a domain

name, specify a fully qualified domain name.

Type:string
comment

Inherited from @aws-cdk/aws-route53.CommonHostedZoneProps

Any comments that you want to include about the hosted zone.

Type:string (optional)
Default:none
queryLogsLogGroupArn

Inherited from @aws-cdk/aws-route53.CommonHostedZoneProps

The Amazon Resource Name (ARN) for the log group that you want Amazon Route 53 to send query logs to.

Type:string (optional)
Default:disabled

PublicHostedZone

class @aws-cdk/aws-route53.PublicHostedZone(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.PublicHostedZone;
const { PublicHostedZone } = require('@aws-cdk/aws-route53');
import { PublicHostedZone } from '@aws-cdk/aws-route53';

Create a Route53 public hosted zone.

Extends:

HostedZone

Parameters:
addDelegation(delegate[, opts])

Adds a delegation from this zone to a designated zone.

Parameters:
addVpc(_vpc)

Overrides @aws-cdk/aws-route53.HostedZone.addVpc()

Add another VPC to this private hosted zone.

Parameters:_vpc (@aws-cdk/aws-ec2.IVpcNetwork) –
export() → @aws-cdk/aws-route53.HostedZoneImportProps

Inherited from @aws-cdk/aws-route53.HostedZone

Export the hosted zone

Return type:HostedZoneImportProps
hostedZoneId

Inherited from @aws-cdk/aws-route53.HostedZone

ID of this hosted zone, such as “Z23ABC4XYZL05B”

Type:string (readonly)
vpcs

Inherited from @aws-cdk/aws-route53.HostedZone

VPCs to which this hosted zone will be added

Protected property

Type:VPCProperty[] (readonly)
zoneName

Inherited from @aws-cdk/aws-route53.HostedZone

FQDN of this hosted zone

Type:string (readonly)
hostedZoneNameServers

Inherited from @aws-cdk/aws-route53.HostedZone

Returns the set of name servers for the specific hosted zone. For example:

ns1.example.com.

This attribute will be undefined for private hosted zones or hosted zones imported from another stack.

Type:string[] (optional) (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

PublicHostedZoneProps (interface)

class @aws-cdk/aws-route53.PublicHostedZoneProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.PublicHostedZoneProps;
// PublicHostedZoneProps is an interface
import { PublicHostedZoneProps } from '@aws-cdk/aws-route53';
Extends:CommonHostedZoneProps
zoneName

Inherited from @aws-cdk/aws-route53.CommonHostedZoneProps

The name of the domain. For resource record types that include a domain

name, specify a fully qualified domain name.

Type:string
comment

Inherited from @aws-cdk/aws-route53.CommonHostedZoneProps

Any comments that you want to include about the hosted zone.

Type:string (optional)
Default:none
queryLogsLogGroupArn

Inherited from @aws-cdk/aws-route53.CommonHostedZoneProps

The Amazon Resource Name (ARN) for the log group that you want Amazon Route 53 to send query logs to.

Type:string (optional)
Default:disabled

TxtRecord

class @aws-cdk/aws-route53.TxtRecord(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.TxtRecord;
const { TxtRecord } = require('@aws-cdk/aws-route53');
import { TxtRecord } from '@aws-cdk/aws-route53';

A DNS TXT record

Extends:

@aws-cdk/cdk.Construct

Parameters:
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

TxtRecordProps (interface)

class @aws-cdk/aws-route53.TxtRecordProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.TxtRecordProps;
// TxtRecordProps is an interface
import { TxtRecordProps } from '@aws-cdk/aws-route53';
recordName

The domain name for this record set.

Type:string
recordValue

The value for this record set.

Type:string
zone

The hosted zone in which to define the new TXT record.

Type:IHostedZone
ttl

The resource record cache time to live (TTL) in seconds.

Type:number (optional)
Default:1800 seconds

ZoneDelegationOptions (interface)

class @aws-cdk/aws-route53.ZoneDelegationOptions

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.ZoneDelegationOptions;
// ZoneDelegationOptions is an interface
import { ZoneDelegationOptions } from '@aws-cdk/aws-route53';

Options available when creating a delegation relationship from one PublicHostedZone to another.

comment

A comment to add on the DNS record created to incorporate the delegation.

Type:string (optional)
Default:none
ttl

The TTL (Time To Live) of the DNS delegation record in DNS caches.

Type:number (optional)
Default:172800

ZoneDelegationRecord

class @aws-cdk/aws-route53.ZoneDelegationRecord(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.ZoneDelegationRecord;
const { ZoneDelegationRecord } = require('@aws-cdk/aws-route53');
import { ZoneDelegationRecord } from '@aws-cdk/aws-route53';

A record to delegate further lookups to a different set of name servers

Extends:

@aws-cdk/cdk.Construct

Parameters:
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ZoneDelegationRecordProps (interface)

class @aws-cdk/aws-route53.ZoneDelegationRecordProps

Language-specific names:

using Amazon.CDK.AWS.Route53;
import software.amazon.awscdk.services.route53.ZoneDelegationRecordProps;
// ZoneDelegationRecordProps is an interface
import { ZoneDelegationRecordProps } from '@aws-cdk/aws-route53';
Extends:ZoneDelegationOptions
delegatedZoneName

The name of the zone that delegation is made to.

Type:string
nameServers

The name servers to report in the delegation records.

Type:string[]
zone

The zone in which this delegate is defined.

Type:IHostedZone
comment

Inherited from @aws-cdk/aws-route53.ZoneDelegationOptions

A comment to add on the DNS record created to incorporate the delegation.

Type:string (optional)
Default:none
ttl

Inherited from @aws-cdk/aws-route53.ZoneDelegationOptions

The TTL (Time To Live) of the DNS delegation record in DNS caches.

Type:number (optional)
Default:172800