Package software.amazon.awscdk.services.route53

@Stability(Stable) @Deprecated package software.amazon.awscdk.services.route53
Deprecated.

Amazon Route53 Construct 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.

To add a public hosted zone: 

 PublicHostedZone.Builder.create(this, "HostedZone")
         .zoneName("fully.qualified.domain.com")
         .build();

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. 

 Vpc vpc;
 
 
 PrivateHostedZone zone = PrivateHostedZone.Builder.create(this, "HostedZone")
         .zoneName("fully.qualified.domain.com")
         .vpc(vpc)
         .build();

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

Adding Records

To add a TXT record to your zone: 

 HostedZone myZone;
 
 
 TxtRecord.Builder.create(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(List.of("Bar!", "Baz?"))
         .ttl(Duration.minutes(90))
         .build();

To add a NS record to your zone: 

 HostedZone myZone;
 
 
 NsRecord.Builder.create(this, "NSRecord")
         .zone(myZone)
         .recordName("foo")
         .values(List.of("ns-1.awsdns.co.uk.", "ns-2.awsdns.com."))
         .ttl(Duration.minutes(90))
         .build();

To add a DS record to your zone: 

 HostedZone myZone;
 
 
 DsRecord.Builder.create(this, "DSRecord")
         .zone(myZone)
         .recordName("foo")
         .values(List.of("12345 3 1 123456789abcdef67890123456789abcdef67890"))
         .ttl(Duration.minutes(90))
         .build();

To add an A record to your zone: 

 HostedZone myZone;
 
 
 ARecord.Builder.create(this, "ARecord")
         .zone(myZone)
         .target(RecordTarget.fromIpAddresses("1.2.3.4", "5.6.7.8"))
         .build();

To add an A record for an EC2 instance with an Elastic IP (EIP) to your zone: 

 Instance instance;
 
 HostedZone myZone;
 
 
 CfnEIP elasticIp = CfnEIP.Builder.create(this, "EIP")
         .domain("vpc")
         .instanceId(instance.getInstanceId())
         .build();
 ARecord.Builder.create(this, "ARecord")
         .zone(myZone)
         .target(RecordTarget.fromIpAddresses(elasticIp.getRef()))
         .build();

To add an AAAA record pointing to a CloudFront distribution: 

 import software.amazon.awscdk.services.cloudfront.*;
 
 HostedZone myZone;
 CloudFrontWebDistribution distribution;
 
 AaaaRecord.Builder.create(this, "Alias")
         .zone(myZone)
         .target(RecordTarget.fromAlias(new CloudFrontTarget(distribution)))
         .build();

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.

To add a NS record to a HostedZone in different account you can do the following:

In the account containing the parent hosted zone: 

 PublicHostedZone parentZone = PublicHostedZone.Builder.create(this, "HostedZone")
         .zoneName("someexample.com")
         .crossAccountZoneDelegationPrincipal(new AccountPrincipal("12345678901"))
         .crossAccountZoneDelegationRoleName("MyDelegationRole")
         .build();

In the account containing the child zone to be delegated: 

 PublicHostedZone subZone = PublicHostedZone.Builder.create(this, "SubZone")
         .zoneName("sub.someexample.com")
         .build();
 
 // import the delegation role by constructing the roleArn
 String delegationRoleArn = Stack.of(this).formatArn(ArnComponents.builder()
         .region("") // IAM is global in each partition
         .service("iam")
         .account("parent-account-id")
         .resource("role")
         .resourceName("MyDelegationRole")
         .build());
 IRole delegationRole = Role.fromRoleArn(this, "DelegationRole", delegationRoleArn);
 
 // create the record
 // create the record
 CrossAccountZoneDelegationRecord.Builder.create(this, "delegate")
         .delegatedZone(subZone)
         .parentHostedZoneName("someexample.com") // or you can use parentHostedZoneId
         .delegationRole(delegationRole)
         .build();

Imports

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

 HostedZone.fromLookup(this, "MyZone", HostedZoneProviderProps.builder()
         .domainName("example.com")
         .build());

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: 

 IHostedZone zone = HostedZone.fromHostedZoneAttributes(this, "MyZone", HostedZoneAttributes.builder()
         .zoneName("example.com")
         .hostedZoneId("ZOJJZC49E0EPZ")
         .build());

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

 IHostedZone zone = HostedZone.fromHostedZoneId(this, "MyZone", "ZOJJZC49E0EPZ");

You can import a Public Hosted Zone as well with the similar PubicHostedZone.fromPublicHostedZoneId and PubicHostedZone.fromPublicHostedZoneAttributes methods: 

 IHostedZone zoneFromAttributes = PublicHostedZone.fromPublicHostedZoneAttributes(this, "MyZone", PublicHostedZoneAttributes.builder()
         .zoneName("example.com")
         .hostedZoneId("ZOJJZC49E0EPZ")
         .build());
 
 // Does not know zoneName
 IPublicHostedZone zoneFromId = PublicHostedZone.fromPublicHostedZoneId(this, "MyZone", "ZOJJZC49E0EPZ");

VPC Endpoint Service Private DNS

When you create a VPC endpoint service, AWS generates endpoint-specific DNS hostnames that consumers use to communicate with the service. For example, vpce-1234-abcdev-us-east-1.vpce-svc-123345.us-east-1.vpce.amazonaws.com. By default, your consumers access the service with that DNS name. This can cause problems with HTTPS traffic because the DNS will not match the backend certificate: 

 curl: (60) SSL: no alternative certificate subject name matches target host name 'vpce-abcdefghijklmnopq-rstuvwx.vpce-svc-abcdefghijklmnopq.us-east-1.vpce.amazonaws.com'

Effectively, the endpoint appears untrustworthy. To mitigate this, clients have to create an alias for this DNS name in Route53.

Private DNS for an endpoint service lets you configure a private DNS name so consumers can access the service using an existing DNS name without creating this Route53 DNS alias This DNS name can also be guaranteed to match up with the backend certificate.

Before consumers can use the private DNS name, you must verify that you have control of the domain/subdomain.

Assuming your account has ownership of the particular domain/subdomain, this construct sets up the private DNS configuration on the endpoint service, creates all the necessary Route53 entries, and verifies domain ownership. 

 import software.amazon.awscdk.core.Stack;
 import software.amazon.awscdk.services.ec2.Vpc;
 import software.amazon.awscdk.services.ec2.VpcEndpointService;
 import software.amazon.awscdk.services.elasticloadbalancingv2.NetworkLoadBalancer;
 import software.amazon.awscdk.services.route53.PublicHostedZone;
 import software.amazon.awscdk.services.route53.VpcEndpointServiceDomainName;
 
 Stack stack = new Stack();
 Vpc vpc = new Vpc(stack, "VPC");
 NetworkLoadBalancer nlb = NetworkLoadBalancer.Builder.create(stack, "NLB")
         .vpc(vpc)
         .build();
 VpcEndpointService vpces = VpcEndpointService.Builder.create(stack, "VPCES")
         .vpcEndpointServiceLoadBalancers(List.of(nlb))
         .build();
 // You must use a public hosted zone so domain ownership can be verified
 PublicHostedZone zone = PublicHostedZone.Builder.create(stack, "PHZ")
         .zoneName("aws-cdk.dev")
         .build();
 VpcEndpointServiceDomainName.Builder.create(stack, "EndpointDomain")
         .endpointService(vpces)
         .domainName("my-stuff.aws-cdk.dev")
         .publicHostedZone(zone)
         .build();
Deprecated: 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 https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html