docs: ec2: Add documentation to the vpcEndpointDnsEntries prop
#21701
Conversation
This file contains 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
|
|
corymhall
previously requested changes
Aug 22, 2022
| @@ -520,6 +520,9 @@ export class InterfaceVpcEndpoint extends VpcEndpoint implements IInterfaceVpcEn | |||
|
|
|||
| /** | |||
| * The DNS entries for the interface VPC endpoint. | |||
| * Each entry 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. | |||
There was a problem hiding this comment.
Suggested change
| * This order is not enforced for AWS Marketplace services. | |
| * This order is not enforced for AWS Marketplace services. | |
| * | |
| * The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV | |
| * and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com. | |
| * | |
| * ["Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com", | |
| * "Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com", | |
| * "Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com"] | |
| * | |
| * If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change. |
There was a problem hiding this comment.
Don't forget to backquote these code samples for Markdown
There was a problem hiding this comment.
@rix0rrr can you please clarify what you mean? You mean I should surround the sample with ```...```?
Co-authored-by: Cory Hall <43035978+corymhall@users.noreply.github.com>
mergify
bot
dismissed
corymhall’s stale review
Pull request has been modified.
corymhall
approved these changes
Aug 23, 2022
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
josephedward
pushed a commit
to josephedward/aws-cdk
that referenced
this pull request
Aug 30, 2022
…#21701) I mistakenly assumed this prop would contain the list of DNS names and did not realize it is actually a list of the hosted zone ID and the DNS name separated by `:`. This change includes a part of the CloudFormation documentation to the attribute to help others avoid this mistake. ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I mistakenly assumed this prop would contain the list of DNS names and did not realize it is actually a list of the hosted zone ID and the DNS name separated by
:. This change includes a part of the CloudFormation documentation to the attribute to help others avoid this mistake.All Submissions:
Adding new Unconventional Dependencies:
New Features
yarn integto deploy the infrastructure and generate the snapshot (i.e.yarn integwithout--dry-run)?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license