The CDK Construct Library for AWS::Route53
Project description
Amazon Route53 Construct Library
---To add a public hosted zone:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
route53.PublicHostedZone(self, "HostedZone",
zone_name="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.
# Example automatically generated. See https://github.com/aws/jsii/issues/826
# vpc is of type Vpc
zone = route53.PrivateHostedZone(self, "HostedZone",
zone_name="fully.qualified.domain.com",
vpc=vpc
)
Additional VPCs can be added with zone.addVpc()
.
Adding Records
To add a TXT record to your zone:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
# my_zone is of type route53.HostedZone
route53.TxtRecord(self, "TXTRecord",
zone=my_zone,
record_name="_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=["Bar!", "Baz?"],
ttl=Duration.minutes(90)
)
To add a NS record to your zone:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
# my_zone is of type HostedZone
route53.NsRecord(self, "NSRecord",
zone=my_zone,
record_name="foo",
values=["ns-1.awsdns.co.uk.", "ns-2.awsdns.com."
],
ttl=Duration.minutes(90)
)
To add a DS record to your zone:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
# my_zone is of type route53.HostedZone
route53.DsRecord(self, "DSRecord",
zone=my_zone,
record_name="foo",
values=["12345 3 1 123456789abcdef67890123456789abcdef67890"
],
ttl=Duration.minutes(90)
)
To add an A record to your zone:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
# my_zone is of type route53.HostedZone
route53.ARecord(self, "ARecord",
zone=my_zone,
target=route53.RecordTarget.from_ip_addresses("1.2.3.4", "5.6.7.8")
)
To add an A record for an EC2 instance with an Elastic IP (EIP) to your zone:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
# instance is of type Instance
# my_zone is of type route53.HostedZone
elastic_ip = ec2.CfnEIP(self, "EIP",
domain="vpc",
instance_id=instance.instance_id
)
route53.ARecord(self, "ARecord",
zone=my_zone,
target=route53.RecordTarget.from_ip_addresses(elastic_ip.ref)
)
To add an AAAA record pointing to a CloudFront distribution:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
import aws_cdk.aws_cloudfront as cloudfront
# my_zone is of type HostedZone
# distribution is of type CloudFrontWebDistribution
route53.AaaaRecord(self, "Alias",
zone=my_zone,
target=route53.RecordTarget.from_alias(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.
To add a NS record to a HostedZone in different account you can do the following:
In the account containing the parent hosted zone:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
parent_zone = route53.PublicHostedZone(self, "HostedZone",
zone_name="someexample.com",
cross_account_zone_delegation_principal=iam.AccountPrincipal("12345678901"),
cross_account_zone_delegation_role_name="MyDelegationRole"
)
In the account containing the child zone to be delegated:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
sub_zone = route53.PublicHostedZone(self, "SubZone",
zone_name="sub.someexample.com"
)
# import the delegation role by constructing the roleArn
delegation_role_arn = Stack.of(self).format_arn(
region="", # IAM is global in each partition
service="iam",
account="parent-account-id",
resource="role",
resource_name="MyDelegationRole"
)
delegation_role = iam.Role.from_role_arn(self, "DelegationRole", delegation_role_arn)
# create the record
route53.CrossAccountZoneDelegationRecord(self, "delegate",
delegated_zone=sub_zone,
parent_hosted_zone_name="someexample.com", # or you can use parentHostedZoneId
delegation_role=delegation_role
)
Imports
If you don't know the ID of the Hosted Zone to import, you can use the
HostedZone.fromLookup
:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
route53.HostedZone.from_lookup(self, "MyZone",
domain_name="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:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
zone = route53.HostedZone.from_hosted_zone_attributes(self, "MyZone",
zone_name="example.com",
hosted_zone_id="ZOJJZC49E0EPZ"
)
Alternatively, use the HostedZone.fromHostedZoneId
to import hosted zones if
you know the ID and the retrieval for the zoneName
is undesirable.
# Example automatically generated. See https://github.com/aws/jsii/issues/826
zone = route53.HostedZone.from_hosted_zone_id(self, "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.
# Example automatically generated. See https://github.com/aws/jsii/issues/826
from aws_cdk.core import Stack
from aws_cdk.aws_ec2 import Vpc, VpcEndpointService
from aws_cdk.aws_elasticloadbalancingv2 import NetworkLoadBalancer
from aws_cdk.aws_route53 import PublicHostedZone, VpcEndpointServiceDomainName
stack = Stack()
vpc = Vpc(stack, "VPC")
nlb = NetworkLoadBalancer(stack, "NLB",
vpc=vpc
)
vpces = VpcEndpointService(stack, "VPCES",
vpc_endpoint_service_load_balancers=[nlb]
)
# You must use a public hosted zone so domain ownership can be verified
zone = PublicHostedZone(stack, "PHZ",
zone_name="aws-cdk.dev"
)
VpcEndpointServiceDomainName(stack, "EndpointDomain",
endpoint_service=vpces,
domain_name="my-stuff.aws-cdk.dev",
public_hosted_zone=zone
)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-cdk.aws-route53-1.130.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d1a209505e794922718cbf2f8f432f8d51b305da63ad4f10008b8f1f535f526 |
|
MD5 | c22936e4141f7c489a569084c61b6f59 |
|
BLAKE2b-256 | 6efbe2bbee08ef08448186438c889662859d7fba6b9fc30ca8f8d1ce266ce507 |
Hashes for aws_cdk.aws_route53-1.130.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 270877be4a1469f84c3022300baba2b982cd1644b4ea01d65fb0522adcf9b822 |
|
MD5 | ac7a191bbd542bdbb1699c2b5a768f76 |
|
BLAKE2b-256 | c032eddb9f1dc726c33023ef837370036e18a9a3b166363417e7eb596d8219a0 |