From 17dd1321d510383e622a708fd7df61087fbe4aef Mon Sep 17 00:00:00 2001 From: Glib Shpychka <23005347+gshpychka@users.noreply.github.com> Date: Tue, 23 Aug 2022 16:18:39 +0300 Subject: [PATCH] docs: ec2: Add documentation to the `vpcEndpointDnsEntries` prop (#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* --- packages/@aws-cdk/aws-ec2/lib/vpc-endpoint.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/packages/@aws-cdk/aws-ec2/lib/vpc-endpoint.ts b/packages/@aws-cdk/aws-ec2/lib/vpc-endpoint.ts index 1bd2f32228d2a..c6e6abb75d054 100644 --- a/packages/@aws-cdk/aws-ec2/lib/vpc-endpoint.ts +++ b/packages/@aws-cdk/aws-ec2/lib/vpc-endpoint.ts @@ -520,6 +520,18 @@ 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. + * + * 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. * @attribute */ public readonly vpcEndpointDnsEntries: string[];