feat: physical names in the entire Construct Library (#2894)

This PR changes the xyzName attribute of all Resources in the Construct Library to be of type PhysicalName,
and adds an AWS linter rule that checks ensures conformance.

The name of the property can be any ending substring of the base name of the resource with the "Name" suffix -
for example, if my resource is AWS::MyService::AwesomeFoobar, the name can be foobarName or awesomeFoobarName.

BREAKING CHANGE: all <resource>Name attributes had their type changed from string to cdk.PhysicalName.

Author: skinny85

packages/@aws-cdk/aws-apigateway/lib/api-key.ts

@@ -1,4 +1,4 @@
-import { Construct, IResource as IResourceBase, Resource } from '@aws-cdk/cdk';
+import { Construct, IResource as IResourceBase, PhysicalName, Resource } from '@aws-cdk/cdk';
 import { CfnApiKey } from './apigateway.generated';
 import { ResourceOptions } from "./resource";
 import { RestApi } from './restapi';
@@ -70,7 +70,7 @@ export interface ApiKeyProps extends ResourceOptions {
    * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name
    * @default automically generated name
    */
-  readonly name?: string;
+  readonly apiKeyName?: PhysicalName;
 }
 
 /**
@@ -83,14 +83,16 @@ export class ApiKey extends Resource implements IApiKey {
   public readonly keyId: string;
 
   constructor(scope: Construct, id: string, props: ApiKeyProps = { }) {
-    super(scope, id);
+    super(scope, id, {
+      physicalName: props.apiKeyName,
+    });
 
     const resource = new CfnApiKey(this, 'Resource', {
       customerId: props.customerId,
       description: props.description,
       enabled: props.enabled || true,
       generateDistinctId: props.generateDistinctId,
-      name: props.name,
+      name: this.physicalName.value,
       stageKeys: this.renderStageKeys(props.resources)
     });
 

packages/@aws-cdk/aws-apigateway/lib/restapi.ts

@@ -1,5 +1,5 @@
 import iam = require('@aws-cdk/aws-iam');
-import { CfnOutput, Construct, IResource as IResourceBase, Resource, Stack } from '@aws-cdk/cdk';
+import { CfnOutput, Construct, IResource as IResourceBase, PhysicalName, Resource, Stack } from '@aws-cdk/cdk';
 import { ApiKey, IApiKey } from './api-key';
 import { CfnAccount, CfnRestApi } from './apigateway.generated';
 import { Deployment } from './deployment';
@@ -64,7 +64,7 @@ export interface RestApiProps extends ResourceOptions {
    *
    * @default - ID of the RestApi construct.
    */
-  readonly restApiName?: string;
+  readonly restApiName?: PhysicalName;
 
   /**
    * Custom header parameters for the request.
@@ -198,10 +198,12 @@ export class RestApi extends Resource implements IRestApi {
   private _latestDeployment: Deployment | undefined;
 
   constructor(scope: Construct, id: string, props: RestApiProps = { }) {
-    super(scope, id);
+    super(scope, id, {
+      physicalName: props.restApiName || PhysicalName.of(id),
+    });
 
     const resource = new CfnRestApi(this, 'Resource', {
-      name: props.restApiName || id,
+      name: this.physicalName.value!,
       description: props.description,
       policy: props.policy,
       failOnWarnings: props.failOnWarnings,

packages/@aws-cdk/aws-apigateway/lib/vpc-link.ts

@@ -1,5 +1,5 @@
 import elbv2 = require('@aws-cdk/aws-elasticloadbalancingv2');
-import { Construct, Lazy, Resource } from '@aws-cdk/cdk';
+import { Construct, Lazy, PhysicalName, Resource } from '@aws-cdk/cdk';
 import { CfnVpcLink } from './apigateway.generated';
 
 /**
@@ -10,7 +10,7 @@ export interface VpcLinkProps {
    * The name used to label and identify the VPC link.
    * @default - automatically generated name
    */
-  readonly vpcLinkName?: string;
+  readonly vpcLinkName?: PhysicalName;
 
   /**
    * The description of the VPC link.
@@ -41,10 +41,13 @@ export class VpcLink extends Resource {
   private readonly targets = new Array<elbv2.INetworkLoadBalancer>();
 
   constructor(scope: Construct, id: string, props: VpcLinkProps = {}) {
-    super(scope, id);
+    super(scope, id, {
+      physicalName: props.vpcLinkName ||
+        PhysicalName.of(Lazy.stringValue({ produce: () => this.node.uniqueId })),
+    });
 
     const cfnResource = new CfnVpcLink(this, 'Resource', {
-      name: props.vpcLinkName || this.node.uniqueId,
+      name: this.physicalName.value!,
       description: props.description,
       targetArns: Lazy.listValue({ produce: () => this.renderTargets() })
     });

packages/@aws-cdk/aws-apigateway/package.json

@@ -93,8 +93,15 @@
     "exclude": [
       "from-method:@aws-cdk/aws-apigateway.Resource",
       "from-method:@aws-cdk/aws-apigateway.ApiKey",
-      "ref-via-interface:@aws-cdk/aws-apigateway.ApiKeyProps.resources"
+      "ref-via-interface:@aws-cdk/aws-apigateway.ApiKeyProps.resources",
+      "props-physical-name:@aws-cdk/aws-apigateway.DeploymentProps",
+      "props-physical-name:@aws-cdk/aws-apigateway.MethodProps",
+      "props-physical-name:@aws-cdk/aws-apigateway.ProxyResourceProps",
+      "props-physical-name:@aws-cdk/aws-apigateway.ResourceProps",
+      "props-physical-name:@aws-cdk/aws-apigateway.StageProps",
+      "props-physical-name:@aws-cdk/aws-apigateway.UsagePlanProps",
+      "props-physical-name:@aws-cdk/aws-apigateway.LambdaRestApiProps"
     ]
   },
   "stability": "experimental"
-}
+}

packages/@aws-cdk/aws-apigateway/test/test.lambda-api.ts

@@ -81,7 +81,7 @@ export = {
       runtime: lambda.Runtime.Nodejs810,
     });
     const alias = new lambda.Alias(stack, 'alias', {
-      aliasName: 'my-alias',
+      aliasName: cdk.PhysicalName.of('my-alias'),
       version: new lambda.Version(stack, 'version', {
         lambda: handler
       })

packages/@aws-cdk/aws-apigateway/test/test.restapi.ts

@@ -141,7 +141,7 @@ export = {
     const api = new apigateway.RestApi(stack, 'restapi', {
       deploy: false,
       cloudWatchRole: false,
-      restApiName: 'my-rest-api'
+      restApiName: cdk.PhysicalName.of('my-rest-api'),
     });
 
     api.root.addMethod('GET');
@@ -176,7 +176,7 @@ export = {
     const api = new apigateway.RestApi(stack, 'restapi', {
       deploy: false,
       cloudWatchRole: false,
-      restApiName: 'my-rest-api'
+      restApiName: cdk.PhysicalName.of('my-rest-api'),
     });
 
     // WHEN

packages/@aws-cdk/aws-apigateway/test/test.vpc-link.ts

@@ -16,7 +16,7 @@ export = {
 
     // WHEN
     new apigateway.VpcLink(stack, 'VpcLink', {
-      vpcLinkName: 'MyLink',
+      vpcLinkName: cdk.PhysicalName.of('MyLink'),
       targets: [nlb]
     });
 
@@ -71,4 +71,4 @@ export = {
     test.throws(() => app.synth(), /No targets added to vpc link/);
     test.done();
   }
-};
+};

packages/@aws-cdk/aws-applicationautoscaling/package.json

@@ -85,5 +85,10 @@
   "engines": {
     "node": ">= 8.10.0"
   },
+  "awslint": {
+    "exclude": [
+      "props-physical-name:@aws-cdk/aws-applicationautoscaling.ScalableTargetProps"
+    ]
+  },
   "stability": "experimental"
-}
+}

packages/@aws-cdk/aws-autoscaling/lib/lifecycle-hook.ts

@@ -1,5 +1,5 @@
 import iam = require('@aws-cdk/aws-iam');
-import { Construct, IResource, Resource } from '@aws-cdk/cdk';
+import { Construct, IResource, PhysicalName, Resource } from '@aws-cdk/cdk';
 import { IAutoScalingGroup } from './auto-scaling-group';
 import { CfnLifecycleHook } from './autoscaling.generated';
 import { ILifecycleHookTarget } from './lifecycle-hook-target';
@@ -13,7 +13,7 @@ export interface BasicLifecycleHookProps {
    *
    * @default - Automatically generated name.
    */
-  readonly lifecycleHookName?: string;
+  readonly lifecycleHookName?: PhysicalName;
 
   /**
    * The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
@@ -92,7 +92,9 @@ export class LifecycleHook extends Resource implements ILifecycleHook {
   public readonly lifecycleHookName: string;
 
   constructor(scope: Construct, id: string, props: LifecycleHookProps) {
-    super(scope, id);
+    super(scope, id, {
+      physicalName: props.lifecycleHookName,
+    });
 
     this.role = props.role || new iam.Role(this, 'Role', {
       assumedBy: new iam.ServicePrincipal('autoscaling.amazonaws.com')
@@ -104,7 +106,7 @@ export class LifecycleHook extends Resource implements ILifecycleHook {
       autoScalingGroupName: props.autoScalingGroup.autoScalingGroupName,
       defaultResult: props.defaultResult,
       heartbeatTimeout: props.heartbeatTimeoutSec,
-      lifecycleHookName: props.lifecycleHookName,
+      lifecycleHookName: this.physicalName.value,
       lifecycleTransition: props.lifecycleTransition,
       notificationMetadata: props.notificationMetadata,
       notificationTargetArn: targetProps.notificationTargetArn,

packages/@aws-cdk/aws-autoscaling/package.json

@@ -97,8 +97,10 @@
     "exclude": [
       "import-props-interface:@aws-cdk/aws-autoscaling.AutoScalingGroupImportProps",
       "resource-interface-extends-construct:@aws-cdk/aws-autoscaling.IAutoScalingGroup",
-      "export:@aws-cdk/aws-autoscaling.IAutoScalingGroup"
+      "export:@aws-cdk/aws-autoscaling.IAutoScalingGroup",
+      "props-physical-name:@aws-cdk/aws-autoscaling.AutoScalingGroupProps",
+      "props-physical-name:@aws-cdk/aws-autoscaling.ScheduledActionProps"
     ]
   },
   "stability": "experimental"
-}
+}