docs(apigateway): update tsc custom domain examples #6413
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Explicitly add the necessary imports required for the route53 alias records examples in the custom domain section of the Typescript API Gateway documentation. Also, update the examples to use the same notation used in the route53 module, that is, `targets.` instead of `route53_targets.` The previous examples were a bit confusing because they did not make it clear which packages were required, and even made it seem like you needed to import the targets from the route53 package. As an user who is learning the CDK and was not familiar with the Route53 and Route53 Targets packages I was stuck until I explored the documentation a bit more. I think this makes the example way more clear.
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
nija-at
approved these changes
Feb 26, 2020
Contributor
|
Thank you for contributing! Your pull request is now being automatically merged. |
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Contributor
|
Thank you for contributing! Your pull request is now being automatically merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explicitly add the necessary imports required for the route53 alias records examples in the custom domain section of the Typescript API Gateway documentation. Also, update the examples to use the same notation used in the route53 module, that is,
targets.instead ofroute53_targets.The previous examples were a bit confusing because they did not make it clear which packages were required, and even made it seem like you needed to import the targets from the route53 package. As an user who is learning the CDK and was not familiar with the Route53 and Route53 Targets packages I was stuck until I explored the documentation a bit more. I think this makes the example way more clear.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license