Skip to content

docs: ec2: Add documentation to the vpcEndpointDnsEntries prop#21701

Merged
mergify[bot] merged 5 commits intoaws:mainfrom
gshpychka:patch-3
Aug 23, 2022
Merged

docs: ec2: Add documentation to the vpcEndpointDnsEntries prop#21701
mergify[bot] merged 5 commits intoaws:mainfrom
gshpychka:patch-3

Conversation

@gshpychka
Copy link
Copy Markdown
Contributor

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:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • 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

@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Aug 22, 2022

@aws-cdk-automation aws-cdk-automation requested a review from a team August 22, 2022 10:12
@github-actions github-actions bot added the p2 label Aug 22, 2022
Copy link
Copy Markdown
Contributor

@corymhall corymhall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very helpful! Just one suggestion to add the rest of the CFN docs since I think the examples are beneficial.

* 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't forget to backquote these code samples for Markdown

Copy link
Copy Markdown
Contributor Author

@gshpychka gshpychka Aug 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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 mergify bot dismissed corymhall’s stale review August 22, 2022 13:33

Pull request has been modified.

@gshpychka gshpychka requested review from corymhall and rix0rrr and removed request for corymhall and rix0rrr August 23, 2022 11:15
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented 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).

@mergify mergify bot merged commit 17dd132 into aws:main Aug 23, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented 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).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 872fc29
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@gshpychka gshpychka deleted the patch-3 branch August 23, 2022 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants