@aws-cdk/aws-route53

Amazon Route53 Construct Library

---

---

To add a public hosted zone:

import * as route53 from '@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 * as ec2 from '@aws-cdk/aws-ec2';
import * as route53 from '@aws-cdk/aws-route53';

const vpc = new ec2.Vpc(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 * as route53 from '@aws-cdk/aws-route53';

new route53.TxtRecord(this, 'TXTRecord', {
  zone: myZone,
  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.
                       // Defaults to zone root if not specified.
  values: [            // Will be quoted for you, and " will be escaped automatically.
    'Bar!',
    'Baz?'
  ],
  ttl: Duration.minutes(90),       // Optional - default is 30 minutes
});

To add a A record to your zone:

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

new route53.ARecord(this, 'ARecord', {
  zone: myZone,
  target: route53.RecordTarget.fromIpAddresses('1.2.3.4', '5.6.7.8')
});

To add a AAAA record pointing to a CloudFront distribution:

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

new route53.AaaaRecord(this, 'Alias', {
  zone: myZone,
  target: route53.RecordTarget.fromAlias(new targets.CloudFrontTarget(distribution))
});

Constructs are available for A, AAAA, CAA, CNAME, MX, NS, SRV and TXT records.

Use the CaaAmazonRecord construct to easily restrict certificate authorities allowed to issue certificates for a domain to Amazon only.

Imports

If you don't know the ID of the Hosted Zone to import, you can use the HostedZone.fromLookup:

HostedZone.fromLookup(this, 'MyZone', {
  domainName: 'example.com'
});

HostedZone.fromLookup requires an environment to be configured. Check out the documentation for more documentation and examples. CDK automatically looks into your ~/.aws/config file for the [default] profile. If you want to specify a different account run cdk deploy --profile [profile].

new MyDevStack(app, 'dev', { 
  env: { 
    account: process.env.CDK_DEFAULT_ACCOUNT, 
    region: process.env.CDK_DEFAULT_REGION 
}});

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

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

Alternatively, use the HostedZone.fromHostedZoneId to import hosted zones if you know the ID and the retrieval for the zoneName is undesirable.

const zone = HostedZone.fromHostedZoneId(this, 'MyZone', {
  hostedZoneId: 'ZOJJZC49E0EPZ',
});

Changelog

1.72.0 (2020-11-06)

⚠ BREAKING CHANGES TO EXPERIMENTAL FEATURES

• rds: Serverless cluster enableHttpEndpoint renamed to enableDataApi
• stepfunctions-tasks: type of outputLocation in the experimental Athena StartQueryExecution has been changed to s3.Location from string

Features

• apigatewayv2: http api - endpoint url (#11092) (c200413), closes #10651
• apigatewayv2: vpc link and private integrations (#11198) (e87a6a3), closes #10531 #10119 aws/jsii#1947
• appmesh: add Virtual Gateways and Gateway Routes (#10879) (79200e7)
• appsync: add RDS datasource (#9258) (23d0943), closes #9152
• appsync: support custom cloudWatchLogsRoleArn for GraphqlApi (#10357) (bed89a5), closes #9441
• ec2: Add Lambda interface endpoint (#11260) (9d0c935), closes #11259
• intro "Names.uniqueId()" instead of the deprecated "node.uniqueId" (#11166) (5e433b1), closes aws/constructs#314
• ecs-patterns: add option to create cname instead of alias record (#10812) (89a5055)
• ecs-service-extensions: create an Environment from attributes (#10932) (d395b5e), closes #10931
• rds: add grant method for Data API (#10748) (884539b), closes #10744

Bug Fixes

• apigateway: changes to gateway response does not trigger auto deployment (#11068) (0c8264a), closes #10963
• cfnspec: incorrect Route 53 health check configuration properties in CloudFormation specification (#11280) (f3c8b50), closes #issuecomment-717435271 #11096
• cli: --no-previous-parameters incorrectly skips updates (#11288) (1bfc649)
• core: many nested stacks make NodeJS run out of memory (#11250) (c124886)
• core: multiple library copies lead to 'Assets must be defined within Stage or App' error (#11113) (fcfed39), closes #10314
• core: support docker engine v20.10.0-beta1 (#11124) (87887a3)
• dynamodb: Misconfigured metrics causing empty graphs (#11283) (9968669)
• ecs: redirect config should honor openListener flag (#11115) (ed6e7ed)
• event-targets: circular dependency when the lambda target is in a different stack (#11217) (e21f249), closes #10942
• pipelines: asset stage can't support more than 50 assets (#11284) (5db8e80), closes #9353
• secretsmanager: can't export secret name from Secret (#11202) (5dcdecb), closes #10914
• secretsmanager: Secret.fromSecretName doesn't work with ECS (#11042) (fe1ce73), closes #10309 #10519
• stepfunctions: stack overflow when referenced json path finding encounters a circular object graph (#11225) (f14d823), closes #9319
• stepfunctions-tasks: Athena* APIs have incorrect supported integration patterns (#11188) (0f66833), closes #11045 #11246
• stepfunctions-tasks: incorrect S3 permissions for AthenaStartQueryExecution (#11203) (b35c423)
• explicitly set the 'ImagePullPrincipalType' of image (#11264) (29aa223), closes #10569