Route53 Alias Record Targets for the CDK Route53 Library

---

End-of-Support

AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.

For more information on how to migrate, see the Migrating to AWS CDK v2 guide.

This library contains Route53 Alias Record targets for:

API Gateway custom domains

import aws_cdk.aws_apigateway as apigw

# zone: route53.HostedZone
# rest_api: apigw.LambdaRestApi


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.ApiGateway(rest_api))
)

API Gateway V2 custom domains

import aws_cdk.aws_apigatewayv2 as apigwv2

# zone: route53.HostedZone
# domain_name: apigwv2.DomainName


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.ApiGatewayv2DomainProperties(domain_name.regional_domain_name, domain_name.regional_hosted_zone_id))
)

CloudFront distributions

import aws_cdk.aws_cloudfront as cloudfront

# zone: route53.HostedZone
# distribution: cloudfront.CloudFrontWebDistribution


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.CloudFrontTarget(distribution))
)

ELBv2 load balancers

import aws_cdk.aws_elasticloadbalancingv2 as elbv2

# zone: route53.HostedZone
# lb: elbv2.ApplicationLoadBalancer


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.LoadBalancerTarget(lb))
)

Classic load balancers

import aws_cdk.aws_elasticloadbalancing as elb

# zone: route53.HostedZone
# lb: elb.LoadBalancer


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.ClassicLoadBalancerTarget(lb))
)

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

import aws_cdk.aws_globalaccelerator as globalaccelerator

# zone: route53.HostedZone
# accelerator: globalaccelerator.Accelerator


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.GlobalAcceleratorTarget(accelerator))
)

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.

import aws_cdk.aws_ec2 as ec2

# zone: route53.HostedZone
# interface_vpc_endpoint: ec2.InterfaceVpcEndpoint


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.InterfaceVpcEndpointTarget(interface_vpc_endpoint))
)

S3 Bucket Website:

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

import aws_cdk.aws_s3 as s3


record_name = "www"
domain_name = "example.com"

bucket_website = s3.Bucket(self, "BucketWebsite",
    bucket_name=[record_name, domain_name].join("."),  # www.example.com
    public_read_access=True,
    website_index_document="index.html"
)

zone = route53.HostedZone.from_lookup(self, "Zone", domain_name=domain_name) # example.com

route53.ARecord(self, "AliasRecord",
    zone=zone,
    record_name=record_name,  # www
    target=route53.RecordTarget.from_alias(targets.BucketWebsiteTarget(bucket_website))
)

User pool domain

import aws_cdk.aws_cognito as cognito

# zone: route53.HostedZone
# domain: cognito.UserPoolDomain

route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.UserPoolDomainTarget(domain))
)

Route 53 record

# zone: route53.HostedZone
# record: route53.ARecord

route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.Route53RecordTarget(record))
)

Elastic Beanstalk environment:

Important: Only supports Elastic Beanstalk environments created after 2016 that have a regional endpoint.

# zone: route53.HostedZone
# ebs_environment_url: str


route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.ElasticBeanstalkEnvironmentEndpointTarget(ebs_environment_url))
)

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

Release files for aws-cdk.aws-route53-targets 1.204.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-cdk.aws-route53-targets 1.204.0
File	Size	Uploaded
aws-cdk.aws-route53-targets-1.204.0.tar.gz	52.4 kB	Jun 19, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for aws-cdk.aws-route53-targets 1.204.0
File	Interpreter	ABI	Platform	Reset
aws_cdk.aws_route53_targets-1.204.0-py3-none-any.whl 51.0 kB Jun 19, 2023	Python 3	none	any	Details

Total release size: 103.4 kB

Release files / aws-cdk.aws-route53-targets-1.204.0.tar.gz

Download URL	aws-cdk.aws-route53-targets-1.204.0.tar.gz
Size	52.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`5dff60a948cd8947fe235eacc3e0d7c49264b33f33c944f990eb8ac0140e5995`
BLAKE2b-256 checksum How to use checksums	`27a06cfe2ea84000bfd5ca9105cec38859a4f07a55cf7a82165540e38d523bbd`
Upload date	Jun 19, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.2`

Release files / aws_cdk.aws_route53_targets-1.204.0-py3-none-any.whl

Download URL	aws_cdk.aws_route53_targets-1.204.0-py3-none-any.whl
Size	51.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`03b80d91c0c126b9ad5bd1d7932cba67dce8a51f5b712253db832ccd37887d6d`
BLAKE2b-256 checksum How to use checksums	`21f8720e57afcec84564502c0de8491b0660693b9b22965ddf267bf253134729`
Upload date	Jun 19, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.2`