Skip to content

Commit

Permalink
feat(route53): update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
@wladyslawczyzewski
wladyslawczyzewski committed Jun 25, 2024
1 parent 070eda9 commit d004bc9
Showing 1 changed file with 144 additions and 114 deletions.
258 changes: 144 additions & 114 deletions packages/aws-cdk-lib/aws-route53-targets/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,180 +1,210 @@
# Route53 Alias Record Targets for the CDK Route53 Library


This library contains Route53 Alias Record targets for:

* API Gateway custom domains
- API Gateway custom domains

```ts
import * as apigw from 'aws-cdk-lib/aws-apigateway';
```ts
import * as apigw from 'aws-cdk-lib/aws-apigateway';

declare const zone: route53.HostedZone;
declare const restApi: apigw.LambdaRestApi;
declare const zone: route53.HostedZone;
declare const restApi: apigw.LambdaRestApi;

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

* API Gateway V2 custom domains
- API Gateway V2 custom domains

```ts
import * as apigwv2 from 'aws-cdk-lib/aws-apigatewayv2';
```ts
import * as apigwv2 from 'aws-cdk-lib/aws-apigatewayv2';

declare const zone: route53.HostedZone;
declare const domainName: apigwv2.DomainName;
declare const zone: route53.HostedZone;
declare const domainName: apigwv2.DomainName;

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

* CloudFront distributions
- CloudFront distributions

```ts
import * as cloudfront from 'aws-cdk-lib/aws-cloudfront';
```ts
import * as cloudfront from 'aws-cdk-lib/aws-cloudfront';

declare const zone: route53.HostedZone;
declare const distribution: cloudfront.CloudFrontWebDistribution;
declare const zone: route53.HostedZone;
declare const distribution: cloudfront.CloudFrontWebDistribution;

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

- ELBv2 load balancers

By providing optional properties, you can specify whether to evaluate target health.

* ELBv2 load balancers
```ts
import * as elbv2 from 'aws-cdk-lib/aws-elasticloadbalancingv2';

```ts
import * as elbv2 from 'aws-cdk-lib/aws-elasticloadbalancingv2';
declare const zone: route53.HostedZone;
declare const lb: elbv2.ApplicationLoadBalancer;

declare const zone: route53.HostedZone;
declare const lb: elbv2.ApplicationLoadBalancer;
new route53.ARecord(this, 'AliasRecord', {
zone,
target: route53.RecordTarget.fromAlias(
new targets.LoadBalancerTarget(lb, {
evaluateTargetHealth: true,
}),
),
});
```

new route53.ARecord(this, 'AliasRecord', {
zone,
target: route53.RecordTarget.fromAlias(new targets.LoadBalancerTarget(lb)),
// or - route53.RecordTarget.fromAlias(new targets.ApiGatewayDomain(domainName)),
});
```
- Classic load balancers

* Classic load balancers
By providing optional properties, you can specify whether to evaluate target health.

```ts
import * as elb from 'aws-cdk-lib/aws-elasticloadbalancing';
```ts
import * as elb from 'aws-cdk-lib/aws-elasticloadbalancing';

declare const zone: route53.HostedZone;
declare const lb: elb.LoadBalancer;
declare const zone: route53.HostedZone;
declare const lb: elb.LoadBalancer;

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

**Important:** Based on [AWS documentation](https://aws.amazon.com/de/premiumsupport/knowledge-center/alias-resource-record-set-route53-cli/), 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).
**Important:** Based on [AWS documentation](https://aws.amazon.com/de/premiumsupport/knowledge-center/alias-resource-record-set-route53-cli/), 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
- GlobalAccelerator

```ts
import * as globalaccelerator from 'aws-cdk-lib/aws-globalaccelerator';
By providing optional properties, you can specify whether to evaluate target health.

declare const zone: route53.HostedZone;
declare const accelerator: globalaccelerator.Accelerator;
```ts
import * as globalaccelerator from 'aws-cdk-lib/aws-globalaccelerator';

new route53.ARecord(this, 'AliasRecord', {
zone,
target: route53.RecordTarget.fromAlias(new targets.GlobalAcceleratorTarget(accelerator)),
// or - route53.RecordTarget.fromAlias(new targets.GlobalAcceleratorDomainTarget('xyz.awsglobalaccelerator.com')),
});
```
declare const zone: route53.HostedZone;
declare const accelerator: globalaccelerator.Accelerator;

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

**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](https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html) with Global Accelerator for more info.

* InterfaceVpcEndpoints
- InterfaceVpcEndpoints

**Important:** Based on the CFN docs for VPCEndpoints - [see here](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#aws-resource-ec2-vpcendpoint-return-values) - 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.

```ts
import * as ec2 from 'aws-cdk-lib/aws-ec2';
```ts
import * as ec2 from 'aws-cdk-lib/aws-ec2';

declare const zone: route53.HostedZone;
declare const interfaceVpcEndpoint: ec2.InterfaceVpcEndpoint;
declare const zone: route53.HostedZone;
declare const interfaceVpcEndpoint: ec2.InterfaceVpcEndpoint;

new route53.ARecord(this, "AliasRecord", {
zone,
target: route53.RecordTarget.fromAlias(new targets.InterfaceVpcEndpointTarget(interfaceVpcEndpoint)),
});
```
new route53.ARecord(this, 'AliasRecord', {
zone,
target: route53.RecordTarget.fromAlias(new targets.InterfaceVpcEndpointTarget(interfaceVpcEndpoint)),
});
```

* S3 Bucket Website:
- S3 Bucket Website:

**Important:** The Bucket name must strictly match the full DNS name.
See [the Developer Guide](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html) for more info.

```ts
import * as s3 from 'aws-cdk-lib/aws-s3';
By providing optional properties, you can specify whether to evaluate target health.

const recordName = 'www';
const domainName = 'example.com';
```ts
import * as s3 from 'aws-cdk-lib/aws-s3';

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

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

new route53.ARecord(this, 'AliasRecord', {
zone,
recordName, // www
target: route53.RecordTarget.fromAlias(new targets.BucketWebsiteTarget(bucketWebsite)),
});
```
const zone = route53.HostedZone.fromLookup(this, 'Zone', { domainName }); // example.com

* User pool domain
new route53.ARecord(this, 'AliasRecord', {
zone,
recordName, // www
target: route53.RecordTarget.fromAlias(
new targets.BucketWebsiteTarget(bucketWebsite, {
evaluateTargetHealth: true,
}),
),
});
```

```ts
import * as cognito from 'aws-cdk-lib/aws-cognito';
- User pool domain

```ts
import * as cognito from 'aws-cdk-lib/aws-cognito';

declare const zone: route53.HostedZone;
declare const domain: cognito.UserPoolDomain;
new route53.ARecord(this, 'AliasRecord', {
zone,
target: route53.RecordTarget.fromAlias(new targets.UserPoolDomainTarget(domain)),
});
```
declare const zone: route53.HostedZone;
declare const domain: cognito.UserPoolDomain;
new route53.ARecord(this, 'AliasRecord', {
zone,
target: route53.RecordTarget.fromAlias(new targets.UserPoolDomainTarget(domain)),
});
```

* Route 53 record
- Route 53 record

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

* Elastic Beanstalk environment:
- Elastic Beanstalk environment:

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

By providing optional properties, you can specify whether to evaluate target health.

```ts
declare const zone: route53.HostedZone;
declare const ebsEnvironmentUrl: string;

new route53.ARecord(this, 'AliasRecord', {
zone,
target: route53.RecordTarget.fromAlias(new targets.ElasticBeanstalkEnvironmentEndpointTarget(ebsEnvironmentUrl)),
target: route53.RecordTarget.fromAlias(
new targets.ElasticBeanstalkEnvironmentEndpointTarget(ebsEnvironmentUrl, {
evaluateTargetHealth: true,
}),
),
});
```

Expand Down

0 comments on commit d004bc9

Please sign in to comment.