Skip to content

docs(apigateway): update tsc custom domain examples #6413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 2 commits into from
Feb 26, 2020
Merged

docs(apigateway): update tsc custom domain examples #6413

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b8ec8d
docs(apigateway): update tsc custom domain examples
fernandrone Feb 23, 2020
d7ba87a
Merge branch 'master' into patch-2
mergify[bot] Feb 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions packages/@aws-cdk/aws-apigateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,9 +525,12 @@ as `example.com`, and for subdomains, such as `www.example.com`. (You can create
CNAME records only for subdomains.)

```ts
import * as route53 from '@aws-cdk/aws-route53';
import * as targets from '@aws-cdk/aws-route53-targets';

new route53.ARecord(this, 'CustomDomainAliasRecord', {
zone: hostedZoneForExampleCom,
target: route53.RecordTarget.fromAlias(new route53_targets.ApiGateway(api))
target: route53.RecordTarget.fromAlias(new targets.ApiGateway(api))
});
```

Expand Down Expand Up @@ -565,12 +568,15 @@ domain.addBasePathMapping(api);
This can also be achieved through the `mapping` configuration when defining the
domain as demonstrated above.

If you wish to setup this domain with an Amazon Route53 alias, use the `route53_targets.ApiGatewayDomain`:
If you wish to setup this domain with an Amazon Route53 alias, use the `targets.ApiGatewayDomain`:

```ts
import * as route53 from '@aws-cdk/aws-route53';
import * as targets from '@aws-cdk/aws-route53-targets';

new route53.ARecord(this, 'CustomDomainAliasRecord', {
zone: hostedZoneForExampleCom,
target: route53.RecordTarget.fromAlias(new route53_targets.ApiGatewayDomain(domainName))
target: route53.RecordTarget.fromAlias(new targets.ApiGatewayDomain(domainName))
});
```

Expand Down