Skip to content
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

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

Merged
merged 5 commits into from
Aug 23, 2022
Merged

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

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
086a5f0
Add documentation to `vpcEndpointDnsEntries`
gshpychka Aug 22, 2022
bba2aaf
Merge branch 'main' into patch-3
gshpychka Aug 22, 2022
b5f0ff6
Update packages/@aws-cdk/aws-ec2/lib/vpc-endpoint.ts
gshpychka Aug 22, 2022
01a86f3
remove trailing spaces
gshpychka Aug 22, 2022
872fc29
Merge branch 'main' into patch-3
mergify[bot] Aug 23, 2022
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
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-ec2/lib/vpc-endpoint.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
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
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
Contributor Author

@gshpychka gshpychka Aug 22, 2022 •
edited
Loading

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 ```...```?

* @attribute
*/
public readonly vpcEndpointDnsEntries: string[];
Expand Down