@aws-cdk/aws-route53-targets

Route53 Alias Record Targets for the CDK Route53 Library

---

---

This library contains Route53 Alias Record targets for:

• API Gateway custom domains

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

• API Gateway V2 custom domains

  
  new route53.ARecord(this, 'AliasRecord', {
    zone,
    target: route53.RecordTarget.fromAlias(new alias.ApiGatewayv2DomainProperties(domainName.regionalDomainName, domainName.regionalHostedZoneId)),
  });
  

• CloudFront distributions

  new route53.ARecord(this, 'AliasRecord', {
    zone,
    target: route53.RecordTarget.fromAlias(new alias.CloudFrontTarget(distribution)),
  });
  

• ELBv2 load balancers

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

• Classic load balancers

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

Important: Based on AWS documentation, all alias record in Route 53 that points to a Elastic Load Balancer will always include dualstack for the DNSName to resolve IPv4/IPv6 addresses (without dualstack IPv6 will not resolve).

For example, if the Amazon-provided DNS for the load balancer is ALB-xxxxxxx.us-west-2.elb.amazonaws.com, CDK will create alias target in Route 53 will be dualstack.ALB-xxxxxxx.us-west-2.elb.amazonaws.com.

• GlobalAccelerator

  new route53.ARecord(stack, 'AliasRecord', {
    zone,
    target: route53.RecordTarget.fromAlias(new targets.GlobalAcceleratorTarget(accelerator)),
    // or - route53.RecordTarget.fromAlias(new targets.GlobalAcceleratorDomainTarget('xyz.awsglobalaccelerator.com')),
  });
  

Important: If you use GlobalAcceleratorDomainTarget, passing a string rather than an instance of IAccelerator, ensure that the string is a valid domain name of an existing Global Accelerator instance. See the documentation on DNS addressing with Global Accelerator for more info.

• InterfaceVpcEndpoints

Important: Based on the CFN docs for VPCEndpoints - see here - the attributes returned for DnsEntries in CloudFormation is a combination of the hosted zone ID and the DNS name. The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for AWS Marketplace services, and therefore this CDK construct is ONLY guaranteed to work with non-marketplace services.

new route53.ARecord(stack, "AliasRecord", {
  zone,
  target: route53.RecordTarget.fromAlias(new alias.InterfaceVpcEndpointTarget(interfaceVpcEndpoint))
});

• S3 Bucket Website:

Important: The Bucket name must strictly match the full DNS name. See the Developer Guide for more info.

const [recordName, domainName] = ['www', 'example.com'];

const bucketWebsite = new Bucket(this, 'BucketWebsite', {
  bucketName: [recordName, domainName].join('.'), // www.example.com
  publicReadAccess: true,
  websiteIndexDocument: 'index.html',
});

const zone = HostedZone.fromLookup(this, 'Zone', {domainName}); // example.com

new route53.ARecord(this, 'AliasRecord', {
  zone,
  recordName, // www
  target: route53.RecordTarget.fromAlias(new alias.BucketWebsiteTarget(bucket)),
});

• User pool domain

  new route53.ARecord(this, 'AliasRecord', {
    zone,
    target: route53.RecordTarget.fromAlias(new alias.UserPoolDomainTarget(domain)),
  });
  

• Route 53 record

  new route53.ARecord(this, 'AliasRecord', {
    zone,
    target: route53.RecordTarget.fromAlias(new targets.Route53RecordTarget(record)),
  });
  

See the documentation of @aws-cdk/aws-route53 for more information.

Changelog

1.122.0 (2021-09-08)

⚠ BREAKING CHANGES TO EXPERIMENTAL FEATURES

• assertions: hasOutput(props: any) becomes hasOutput(logicalId: string, props: any)
• assertions: findOutputs(props: any = {}) becomes findOutputs(logicalId: string, props: any = {})
• assertions: hasMapping(props: any) becomes hasMapping(logicalId: string, props: any)
• assertions: findMappings(props: any = {}) becomes findMappings(logicalId: string, props: any = {})

Features

• ec2: Allow ApplyCloudformationInitOptions to set additional params (#16121) (1d94646), closes #16004
• backup: option to prevent recovery point deletions (#16282) (6e71806)
• cli: hotswap deployments (#15748) (6e55c95)
• config: EC2_INSTANCE_PROFILE_ATTACHED managed rule (#16011) (816a319)
• ec2: rename SubnetTypes to improve clarity with EC2 conventions (#16348) (2023004), closes #15929
• ec2: vpc endpoint for aws keyspaces (#16306) (ad425d0)
• ecs-service-extensions: Subscribe Extension (#16049) (66baca5)
• elasticloadbalancingv2: ALPN policy support for NLB listener (#15956) (5427578)
• kms: support fromLookup in KMS key to get key by alias name (#15652) (34a57ed), closes #8822
• lambda: python 3.9 runtime (#16366) (a534829)
• pipelines: stack-level steps (#16215) (d499c85), closes #16148
• stepfunctions-tasks: await the eval so async ops can be passed to tasks.EvaluateExpression (#16290) (174b066)

Bug Fixes

• apigatewayv2: some methods of the defaultStage are not available without casting it to IHttpStage (#15607) (27a0113)
• assertions: output and mapping assertions do not accept logical id (#16329), closes #16242
• assets: run executable command of container assets in cloud assembly root directory (#16094) (c2852c9), closes #15721
• autoscaling: EbsDeviceVolumeType.IO2 is not a valid CloudFormation value (#16028) (492d33b), closes #16027
• cli: 'deploy' and 'diff' silently does nothing when given unknown stack name (#16150) (74776f3), closes #15866
• cloudwatch: cross account alarms does not support math expressions (#16333) (1ffd897), closes #16331
• core: allow asset bundling when selinux is enabled (#15742) (dbfebb4)
• iam: permissions boundary aspect doesn't always recognize roles (#16154) (c8bfcf6)
• stepfunctions-tasks: Athena StartQueryExecution includes QueryExecutionContext even when object is empty (#16141) (6e2a3e0), closes #16133 #16133