refactor(core): use "string" for physical name props (#3011)

We realized there is no need to use a strong type (`PhysicalName`) for resource physical names. Eventually users want to be able to either use the default, pass an explicit string for the name or request that the framework generate a name for them, conditionally (or, in the future, unconditionally) to whether the resource is being referenced across environments. To that end, all physical name props have been converted back to `string` and a special token marker `PhysicalName.GENERATE_IF_NEEDED` was introduced which can be used to indicate that physical name will be generated if needed for cross environment references. This change also modifies the protected API provided the `Resource` class: - `physicalName` returns the value that should be passed to the CFN resource - `getResourceNameAttribute(nameAttr)` returns a token that should be exposed as the resource name (e.g. `bucketName`). - `getResourceArnAttribute(arnAttr, components)` returns a token that should bexposed as the resource's ARN (e.g. `bucketArn`). All of these are "environment-sensitive" and will return "the right" value, depending on the resource's poster and configuration.
aws · Jun 23, 2019 · a942e4c · a942e4c
1 parent 3b5b76d
commit a942e4c
Show file tree

Hide file tree

Showing 101 changed files with 539 additions and 842 deletions.
diff --git a/packages/@aws-cdk/aws-apigateway/lib/api-key.ts b/packages/@aws-cdk/aws-apigateway/lib/api-key.ts
@@ -1,4 +1,4 @@
-import { Construct, IResource as IResourceBase, PhysicalName, Resource } from '@aws-cdk/cdk';
+import { Construct, IResource as IResourceBase, 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 apiKeyName?: PhysicalName;
+  readonly apiKeyName?: string;
 }
 
 /**

diff --git a/packages/@aws-cdk/aws-apigateway/lib/restapi.ts b/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, PhysicalName, Resource, Stack } from '@aws-cdk/cdk';
+import { CfnOutput, Construct, IResource as IResourceBase, 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?: PhysicalName;
+  readonly restApiName?: string;
 
   /**
    * Custom header parameters for the request.
@@ -199,7 +199,7 @@ export class RestApi extends Resource implements IRestApi {
 
   constructor(scope: Construct, id: string, props: RestApiProps = { }) {
     super(scope, id, {
-      physicalName: props.restApiName || PhysicalName.of(id),
+      physicalName: props.restApiName || id,
     });
 
     const resource = new CfnRestApi(this, 'Resource', {

diff --git a/packages/@aws-cdk/aws-apigateway/lib/vpc-link.ts b/packages/@aws-cdk/aws-apigateway/lib/vpc-link.ts
@@ -1,5 +1,5 @@
 import elbv2 = require('@aws-cdk/aws-elasticloadbalancingv2');
-import { Construct, Lazy, PhysicalName, Resource } from '@aws-cdk/cdk';
+import { Construct, Lazy, 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?: PhysicalName;
+  readonly vpcLinkName?: string;
 
   /**
    * The description of the VPC link.
@@ -43,7 +43,7 @@ export class VpcLink extends Resource {
   constructor(scope: Construct, id: string, props: VpcLinkProps = {}) {
     super(scope, id, {
       physicalName: props.vpcLinkName ||
-        PhysicalName.of(Lazy.stringValue({ produce: () => this.node.uniqueId })),
+        Lazy.stringValue({ produce: () => this.node.uniqueId }),
     });
 
     const cfnResource = new CfnVpcLink(this, 'Resource', {

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.restapi.ts b/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: cdk.PhysicalName.of('my-rest-api'),
+      restApiName: 'my-rest-api',
     });
 
     api.root.addMethod('GET');
@@ -176,7 +176,7 @@ export = {
     const api = new apigateway.RestApi(stack, 'restapi', {
       deploy: false,
       cloudWatchRole: false,
-      restApiName: cdk.PhysicalName.of('my-rest-api'),
+      restApiName: 'my-rest-api',
     });
 
     // WHEN

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.vpc-link.ts b/packages/@aws-cdk/aws-apigateway/test/test.vpc-link.ts
@@ -16,7 +16,7 @@ export = {
 
     // WHEN
     new apigateway.VpcLink(stack, 'VpcLink', {
-      vpcLinkName: cdk.PhysicalName.of('MyLink'),
+      vpcLinkName: 'MyLink',
       targets: [nlb]
     });
 

diff --git a/packages/@aws-cdk/aws-autoscaling/lib/lifecycle-hook.ts b/packages/@aws-cdk/aws-autoscaling/lib/lifecycle-hook.ts
@@ -1,5 +1,5 @@
 import iam = require('@aws-cdk/aws-iam');
-import { Construct, Duration, IResource, PhysicalName, Resource } from '@aws-cdk/cdk';
+import { Construct, Duration, IResource, 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?: PhysicalName;
+  readonly lifecycleHookName?: string;
 
   /**
    * The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

diff --git a/packages/@aws-cdk/aws-cloudtrail/lib/index.ts b/packages/@aws-cdk/aws-cloudtrail/lib/index.ts
@@ -3,7 +3,7 @@ import iam = require('@aws-cdk/aws-iam');
 import kms = require('@aws-cdk/aws-kms');
 import logs = require('@aws-cdk/aws-logs');
 import s3 = require('@aws-cdk/aws-s3');
-import { Construct, PhysicalName, Resource, Stack } from '@aws-cdk/cdk';
+import { Construct, Resource, Stack } from '@aws-cdk/cdk';
 import { CfnTrail } from './cloudtrail.generated';
 
 // AWS::CloudTrail CloudFormation Resources:
@@ -86,7 +86,7 @@ export interface TrailProps {
    *
    * @default - AWS CloudFormation generated name.
    */
-  readonly trailName?: PhysicalName;
+  readonly trailName?: string;
 
   /** An Amazon S3 object key prefix that precedes the name of all log files.
    *
@@ -185,16 +185,11 @@ export class Trail extends Resource {
       eventSelectors: this.eventSelectors
     });
 
-    const resourceIdentifiers = this.getCrossEnvironmentAttributes({
-      arn: trail.attrArn,
-      name: trail.trailName || '',
-      arnComponents: {
-        service: 'cloudtrail',
-        resource: 'trail',
-        resourceName: this.physicalName,
-      },
+    this.trailArn = this.getResourceArnAttribute(trail.attrArn, {
+      service: 'cloudtrail',
+      resource: 'trail',
+      resourceName: this.physicalName,
     });
-    this.trailArn = resourceIdentifiers.arn;
     this.trailSnsTopicArn = trail.attrSnsTopicArn;
 
     const s3BucketPolicy = s3bucket.node.findChild("Policy").node.findChild("Resource") as s3.CfnBucketPolicy;

diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/alarm.ts b/packages/@aws-cdk/aws-cloudwatch/lib/alarm.ts
@@ -151,18 +151,13 @@ export class Alarm extends Resource implements IAlarm {
       })
     });
 
-    const resourceIdentifiers = this.getCrossEnvironmentAttributes({
-      arn: alarm.attrArn,
-      name: alarm.ref,
-      arnComponents: {
-        service: 'cloudwatch',
-        resource: 'alarm',
-        resourceName: this.physicalName,
-        sep: ':',
-      },
+    this.alarmArn = this.getResourceArnAttribute(alarm.attrArn, {
+      service: 'cloudwatch',
+      resource: 'alarm',
+      resourceName: this.physicalName,
+      sep: ':',
     });
-    this.alarmArn = resourceIdentifiers.arn;
-    this.alarmName = resourceIdentifiers.name;
+    this.alarmName = this.getResourceNameAttribute(alarm.ref);
 
     this.metric = props.metric;
     this.annotation = {

diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts b/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts
@@ -1,4 +1,4 @@
-import { Construct, Lazy, PhysicalName, Resource, Stack } from "@aws-cdk/cdk";
+import { Construct, Lazy, Resource, Stack } from "@aws-cdk/cdk";
 import { CfnDashboard } from './cloudwatch.generated';
 import { Column, Row } from "./layout";
 import { IWidget } from "./widget";
@@ -14,7 +14,7 @@ export interface DashboardProps {
    *
    * @default Automatically generated name
    */
-  readonly dashboardName?: PhysicalName;
+  readonly dashboardName?: string;
 
   /**
    * The start of the time range to use for each widget on the dashboard.

diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/metric.ts b/packages/@aws-cdk/aws-cloudwatch/lib/metric.ts
@@ -255,7 +255,7 @@ export interface CreateAlarmOptions {
    *
    * @default Automatically generated name
    */
-  readonly alarmName?: cdk.PhysicalName;
+  readonly alarmName?: string;
 
   /**
    * Description for the alarm

diff --git a/packages/@aws-cdk/aws-cloudwatch/test/integ.alarm-and-dashboard.ts b/packages/@aws-cdk/aws-cloudwatch/test/integ.alarm-and-dashboard.ts
@@ -27,7 +27,7 @@ const alarm = metric.createAlarm(stack, 'Alarm', {
 });
 
 const dashboard = new cloudwatch.Dashboard(stack, 'Dash', {
-  dashboardName: cdk.PhysicalName.of('MyCustomDashboardName'),
+  dashboardName: 'MyCustomDashboardName',
   start: '-9H',
   end: '2018-12-17T06:00:00.000Z',
   periodOverride: PeriodOverride.INHERIT

diff --git a/packages/@aws-cdk/aws-cloudwatch/test/test.dashboard.ts b/packages/@aws-cdk/aws-cloudwatch/test/test.dashboard.ts
@@ -1,5 +1,5 @@
 import { expect, haveResource, isSuperObject } from '@aws-cdk/assert';
-import { App, PhysicalName, Stack } from '@aws-cdk/cdk';
+import { App, Stack } from '@aws-cdk/cdk';
 import { Test } from 'nodeunit';
 import { Dashboard, GraphWidget, PeriodOverride, TextWidget } from '../lib';
 
@@ -127,7 +127,7 @@ export = {
 
     // WHEN
     new Dashboard(stack, 'MyDashboard', {
-      dashboardName: PhysicalName.of('MyCustomDashboardName'),
+      dashboardName: 'MyCustomDashboardName',
     });
 
     // THEN

diff --git a/packages/@aws-cdk/aws-codebuild/lib/project.ts b/packages/@aws-cdk/aws-codebuild/lib/project.ts
@@ -464,7 +464,7 @@ export interface CommonProjectProps {
    *
    * @default - Name is automatically generated.
    */
-  readonly projectName?: PhysicalName;
+  readonly projectName?: string;
 
   /**
    * VPC network to place codebuild network interfaces
@@ -633,7 +633,7 @@ export class Project extends ProjectBase {
     });
 
     this.role = props.role || new iam.Role(this, 'Role', {
-      roleName: PhysicalName.auto({ crossEnvironment: true }),
+      roleName: PhysicalName.GENERATE_IF_NEEDED,
       assumedBy: new iam.ServicePrincipal('codebuild.amazonaws.com')
     });
     this.grantPrincipal = this.role;
@@ -701,17 +701,12 @@ export class Project extends ProjectBase {
 
     this.addVpcRequiredPermissions(props, resource);
 
-    const resourceIdentifiers = this.getCrossEnvironmentAttributes({
-      arn: resource.attrArn,
-      name: resource.ref,
-      arnComponents: {
-        service: 'codebuild',
-        resource: 'project',
-        resourceName: this.physicalName,
-      },
+    this.projectArn = this.getResourceArnAttribute(resource.attrArn, {
+      service: 'codebuild',
+      resource: 'project',
+      resourceName: this.physicalName,
     });
-    this.projectArn = resourceIdentifiers.arn;
-    this.projectName = resourceIdentifiers.name;
+    this.projectName = this.getResourceNameAttribute(resource.ref);
 
     this.addToRolePolicy(this.createLoggingPermission());
 
@@ -883,7 +878,7 @@ export class Project extends ProjectBase {
     }));
 
     const policy = new iam.Policy(this, 'PolicyDocument', {
-      policyName: PhysicalName.of('CodeBuildEC2Policy'),
+      policyName: 'CodeBuildEC2Policy',
       statements: [
         new iam.PolicyStatement({
           resources: ['*'],

diff --git a/packages/@aws-cdk/aws-codebuild/test/integ.project-vpc.ts b/packages/@aws-cdk/aws-codebuild/test/integ.project-vpc.ts
@@ -13,7 +13,7 @@ const vpc = new ec2.Vpc(stack, 'MyVPC', {
 const securityGroup = new ec2.SecurityGroup(stack, 'SecurityGroup1', {
     allowAllOutbound: true,
     description: 'Example',
-    securityGroupName: cdk.PhysicalName.of('Bob'),
+    securityGroupName: 'Bob',
   vpc,
 });
 new codebuild.Project(stack, 'MyProject', {

diff --git a/packages/@aws-cdk/aws-codebuild/test/test.codebuild.ts b/packages/@aws-cdk/aws-codebuild/test/test.codebuild.ts
@@ -630,7 +630,7 @@ export = {
       const bucket = new s3.Bucket(stack, 'MyBucket');
       const vpc = new ec2.Vpc(stack, 'MyVPC');
       const securityGroup = new ec2.SecurityGroup(stack, 'SecurityGroup1', {
-          securityGroupName: cdk.PhysicalName.of('Bob'),
+          securityGroupName: 'Bob',
           vpc,
           allowAllOutbound: true,
           description: 'Example',
@@ -677,7 +677,7 @@ export = {
       const bucket = new s3.Bucket(stack, 'MyBucket');
       const vpc = new ec2.Vpc(stack, 'MyVPC');
       const securityGroup = new ec2.SecurityGroup(stack, 'SecurityGroup1', {
-          securityGroupName: cdk.PhysicalName.of('Bob'),
+          securityGroupName: 'Bob',
           vpc,
           allowAllOutbound: true,
           description: 'Example',
@@ -699,7 +699,7 @@ export = {
       const bucket = new s3.Bucket(stack, 'MyBucket');
       const vpc = new ec2.Vpc(stack, 'MyVPC');
       const securityGroup = new ec2.SecurityGroup(stack, 'SecurityGroup1', {
-          securityGroupName: cdk.PhysicalName.of('Bob'),
+          securityGroupName: 'Bob',
           vpc,
           allowAllOutbound: true,
           description: 'Example',

diff --git a/packages/@aws-cdk/aws-codecommit/lib/repository.ts b/packages/@aws-cdk/aws-codecommit/lib/repository.ts
@@ -1,5 +1,5 @@
 import events = require('@aws-cdk/aws-events');
-import { Construct, IConstruct, IResource, PhysicalName, Resource, Stack } from '@aws-cdk/cdk';
+import { Construct, IConstruct, IResource, Resource, Stack } from '@aws-cdk/cdk';
 import { CfnRepository } from './codecommit.generated';
 
 export interface IRepository extends IResource {
@@ -279,7 +279,7 @@ export class Repository extends RepositoryBase {
 
   constructor(scope: Construct, id: string, props: RepositoryProps) {
     super(scope, id, {
-      physicalName: PhysicalName.of(props.repositoryName),
+      physicalName: props.repositoryName,
     });
 
     this.repository = new CfnRepository(this, 'Resource', {
@@ -288,17 +288,11 @@ export class Repository extends RepositoryBase {
       triggers: this.triggers
     });
 
-    const resourceIdentifiers = this.getCrossEnvironmentAttributes({
-      arn: this.repository.attrArn,
-      name: this.repository.attrName,
-      arnComponents: {
-        service: 'codecommit',
-        resource: props.repositoryName,
-      },
+    this.repositoryName = this.getResourceNameAttribute(this.repository.attrName);
+    this.repositoryArn = this.getResourceArnAttribute(this.repository.attrArn, {
+      service: 'codecommit',
+      resource: this.physicalName,
     });
-
-    this.repositoryArn = resourceIdentifiers.arn;
-    this.repositoryName = resourceIdentifiers.name;
   }
 
   public get repositoryCloneUrlHttp() {

diff --git a/packages/@aws-cdk/aws-codedeploy/lib/lambda/application.ts b/packages/@aws-cdk/aws-codedeploy/lib/lambda/application.ts
@@ -1,4 +1,4 @@
-import { Construct, IResource, PhysicalName, Resource } from '@aws-cdk/cdk';
+import { Construct, IResource, Resource } from '@aws-cdk/cdk';
 import { CfnApplication } from "../codedeploy.generated";
 import { arnForApplication } from "../utils";
 
@@ -29,7 +29,7 @@ export interface LambdaApplicationProps {
    *
    * @default an auto-generated name will be used
    */
-  readonly applicationName?: PhysicalName;
+  readonly applicationName?: string;
 }
 
 /**
@@ -69,17 +69,12 @@ export class LambdaApplication extends Resource implements ILambdaApplication {
       computePlatform: 'Lambda'
     });
 
-    const resourceIdentifiers = this.getCrossEnvironmentAttributes({
-      arn: arnForApplication(resource.ref),
-      name: resource.ref,
-      arnComponents: {
-        service: 'codedeploy',
-        resource: 'application',
-        resourceName: this.physicalName,
-        sep: ':',
-      },
+    this.applicationName = this.getResourceNameAttribute(resource.ref);
+    this.applicationArn = this.getResourceArnAttribute(arnForApplication(resource.ref), {
+      service: 'codedeploy',
+      resource: 'application',
+      resourceName: this.physicalName,
+      sep: ':',
     });
-    this.applicationName = resourceIdentifiers.name;
-    this.applicationArn = resourceIdentifiers.arn;
   }
 }