docs(ec2): Clarify vpcName documentation for VPC (#18932)

gshpychka · web-flow · commit 90d7f02e49cf · 2022-02-14T20:19:48.000Z
Explain that VPC doesn't support providing a physical name Related: #18912 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
diff --git a/packages/@aws-cdk/aws-ec2/lib/vpc.ts b/packages/@aws-cdk/aws-ec2/lib/vpc.ts
@@ -969,6 +969,8 @@ export interface VpcProps {
   /**
    * The VPC name.
    *
+   * Since the VPC resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag
+   *
    * @default this.node.path
    */
   readonly vpcName?: string;

Original file line number	Diff line number	Diff line change
`@@ -969,6 +969,8 @@ export interface VpcProps {`
`969`	`969`	`/**`
`970`	`970`	`* The VPC name.`
`971`	`971`	`*`
	`972`	+ * Since the VPC resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag
	`973`	`+ *`
`972`	`974`	`* @default this.node.path`
`973`	`975`	`*/`
`974`	`976`	`readonly vpcName?: string;`