refactor(core): additional api cleanups (#2972)

Additional minor API cleanups in the core module (see breaking changes list). Updated physical names linter rule to verify that physical name property name is `cfnTypeName` and that it's type is either `PhysicalName` in case the name is optional and `string` if the name is required (fixes #2971). Moved all internal files in @aws-cdk/cdk under "private" BREAKING CHANGE: The deprecated `app.run()` has been removed (use `app.synth()`). * **core:** `CfnElement.refAsString` renamed to `ref` of `string` type. The `IResolvable` version have been removed. * **core:** `Resource.physicalName` is now a `string` instead of `PhysicalName`. If a physical name should be generated during deployment (i.e. not supplied to L1), the string will synthesize to `undefined`. * **core:** `IStringValue` renamed to `IStringProducer` * **core:** `Include` renamed to `CfnInclude` * **core:** `Cfn` prefix was added to the following types: `CfnCreationPolicy`, `CfnResourceAutoScalingCreationPolicy`, `CfnResourceAutoScalingCreationPolicy`, `CfnDeletionPolicy`, `CfnUpdatePolicy`, `CfnAutoScalingRollingUpdate`, `CfnAutoScalingReplacingUpdate`, `CfnAutoScalingScheduledAction`, `CfnCodeDeployLambdaAliasUpdate`, `CfnTag` `CfnRuleAssertion`, `CfnDynamicReferenceProps` * **core:** `deepMerge` is no longer exported. * **core:** `CfnOutputProps.export` was renamed to `exportName`. * **core:** `CfnOutput` all properties are now private * **core:** `StringListCfnOutput` has been removed
aws · Jun 21, 2019 · 7fb6fd6 · 7fb6fd6
1 parent 67f6de0
commit 7fb6fd6
Show file tree

Hide file tree

Showing 167 changed files with 759 additions and 1,206 deletions.
diff --git a/packages/@aws-cdk/aws-apigateway/lib/api-key.ts b/packages/@aws-cdk/aws-apigateway/lib/api-key.ts
@@ -92,11 +92,11 @@ export class ApiKey extends Resource implements IApiKey {
       description: props.description,
       enabled: props.enabled || true,
       generateDistinctId: props.generateDistinctId,
-      name: this.physicalName.value,
+      name: this.physicalName,
       stageKeys: this.renderStageKeys(props.resources)
     });
 
-    this.keyId = resource.refAsString;
+    this.keyId = resource.ref;
   }
 
   private renderStageKeys(resources: RestApi[] | undefined): CfnApiKey.StageKeyProperty[] | undefined {

diff --git a/packages/@aws-cdk/aws-apigateway/lib/deployment.ts b/packages/@aws-cdk/aws-apigateway/lib/deployment.ts
@@ -1,4 +1,4 @@
-import { Construct, DeletionPolicy, Lazy, Resource, Stack } from '@aws-cdk/cdk';
+import { CfnDeletionPolicy, Construct, Lazy, Resource, Stack } from '@aws-cdk/cdk';
 import crypto = require('crypto');
 import { CfnDeployment, CfnDeploymentProps } from './apigateway.generated';
 import { IRestApi } from './restapi';
@@ -72,11 +72,11 @@ export class Deployment extends Resource {
     });
 
     if (props.retainDeployments) {
-      this.resource.options.deletionPolicy = DeletionPolicy.Retain;
+      this.resource.options.deletionPolicy = CfnDeletionPolicy.Retain;
     }
 
     this.api = props.api;
-    this.deploymentId = Lazy.stringValue({ produce: () => this.resource.refAsString });
+    this.deploymentId = Lazy.stringValue({ produce: () => this.resource.ref });
   }
 
   /**

diff --git a/packages/@aws-cdk/aws-apigateway/lib/method.ts b/packages/@aws-cdk/aws-apigateway/lib/method.ts
@@ -123,7 +123,7 @@ export class Method extends Resource {
 
     const resource = new CfnMethod(this, 'Resource', methodProps);
 
-    this.methodId = resource.refAsString;
+    this.methodId = resource.ref;
 
     props.resource.restApi._attachMethod(this);
 

diff --git a/packages/@aws-cdk/aws-apigateway/lib/resource.ts b/packages/@aws-cdk/aws-apigateway/lib/resource.ts
@@ -211,7 +211,7 @@ export class Resource extends ResourceBase {
     };
     const resource = new CfnResource(this, 'Resource', resourceProps);
 
-    this.resourceId = resource.refAsString;
+    this.resourceId = resource.ref;
     this.restApi = props.parent.restApi;
 
     // render resource path (special case for root)

diff --git a/packages/@aws-cdk/aws-apigateway/lib/restapi.ts b/packages/@aws-cdk/aws-apigateway/lib/restapi.ts
@@ -203,7 +203,7 @@ export class RestApi extends Resource implements IRestApi {
     });
 
     const resource = new CfnRestApi(this, 'Resource', {
-      name: this.physicalName.value!,
+      name: this.physicalName,
       description: props.description,
       policy: props.policy,
       failOnWarnings: props.failOnWarnings,
@@ -215,7 +215,7 @@ export class RestApi extends Resource implements IRestApi {
       parameters: props.parameters,
     });
 
-    this.restApiId = resource.refAsString;
+    this.restApiId = resource.ref;
 
     this.configureDeployment(props);
 

diff --git a/packages/@aws-cdk/aws-apigateway/lib/stage.ts b/packages/@aws-cdk/aws-apigateway/lib/stage.ts
@@ -197,7 +197,7 @@ export class Stage extends Resource {
       methodSettings,
     });
 
-    this.stageName = resource.refAsString;
+    this.stageName = resource.ref;
     this.restApi = props.deployment.api;
   }
 

diff --git a/packages/@aws-cdk/aws-apigateway/lib/usage-plan.ts b/packages/@aws-cdk/aws-apigateway/lib/usage-plan.ts
@@ -165,7 +165,7 @@ export class UsagePlan extends Resource {
 
     this.apiStages.push(...(props.apiStages || []));
 
-    this.usagePlanId = resource.refAsString;
+    this.usagePlanId = resource.ref;
 
     // Add ApiKey when
     if (props.apiKey) {

diff --git a/packages/@aws-cdk/aws-apigateway/lib/vpc-link.ts b/packages/@aws-cdk/aws-apigateway/lib/vpc-link.ts
@@ -47,12 +47,12 @@ export class VpcLink extends Resource {
     });
 
     const cfnResource = new CfnVpcLink(this, 'Resource', {
-      name: this.physicalName.value!,
+      name: this.physicalName,
       description: props.description,
       targetArns: Lazy.listValue({ produce: () => this.renderTargets() })
     });
 
-    this.vpcLinkId = cfnResource.refAsString;
+    this.vpcLinkId = cfnResource.ref;
 
     if (props.targets) {
       this.addTargets(...props.targets);

diff --git a/packages/@aws-cdk/aws-apigateway/package.json b/packages/@aws-cdk/aws-apigateway/package.json
@@ -99,8 +99,8 @@
       "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-type:@aws-cdk/aws-apigateway.StageProps.stageName",
       "props-physical-name:@aws-cdk/aws-apigateway.LambdaRestApiProps"
     ]
   },

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.lambda-api.ts b/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: cdk.PhysicalName.of('my-alias'),
+      aliasName: 'my-alias',
       version: new lambda.Version(stack, 'version', {
         lambda: handler
       })

diff --git a/packages/@aws-cdk/aws-applicationautoscaling/lib/scalable-target.ts b/packages/@aws-cdk/aws-applicationautoscaling/lib/scalable-target.ts
@@ -120,7 +120,7 @@ export class ScalableTarget extends Resource implements IScalableTarget {
       serviceNamespace: props.serviceNamespace
     });
 
-    this.scalableTargetId = resource.refAsString;
+    this.scalableTargetId = resource.ref;
   }
 
   /**

diff --git a/packages/@aws-cdk/aws-applicationautoscaling/lib/step-scaling-action.ts b/packages/@aws-cdk/aws-applicationautoscaling/lib/step-scaling-action.ts
@@ -93,7 +93,7 @@ export class StepScalingAction extends cdk.Construct {
       } as CfnScalingPolicy.StepScalingPolicyConfigurationProperty
     });
 
-    this.scalingPolicyArn = resource.refAsString;
+    this.scalingPolicyArn = resource.ref;
   }
 
   /**

diff --git a/packages/@aws-cdk/aws-applicationautoscaling/lib/target-tracking-scaling-policy.ts b/packages/@aws-cdk/aws-applicationautoscaling/lib/target-tracking-scaling-policy.ts
@@ -134,7 +134,7 @@ export class TargetTrackingScalingPolicy extends cdk.Construct {
       }
     });
 
-    this.scalingPolicyArn = resource.refAsString;
+    this.scalingPolicyArn = resource.ref;
   }
 }
 

diff --git a/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts b/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts
@@ -5,7 +5,7 @@ import elbv2 = require('@aws-cdk/aws-elasticloadbalancingv2');
 import iam = require('@aws-cdk/aws-iam');
 import sns = require('@aws-cdk/aws-sns');
 
-import { AutoScalingRollingUpdate, Construct, Duration, Fn, IResource, Lazy, Resource, Stack, Tag } from '@aws-cdk/cdk';
+import { CfnAutoScalingRollingUpdate, Construct, Duration, Fn, IResource, Lazy, Resource, Stack, Tag } from '@aws-cdk/cdk';
 import { CfnAutoScalingGroup, CfnAutoScalingGroupProps, CfnLaunchConfiguration } from './autoscaling.generated';
 import { BasicLifecycleHookProps, LifecycleHook } from './lifecycle-hook';
 import { BasicScheduledActionProps, ScheduledAction } from './scheduled-action';
@@ -390,7 +390,7 @@ export class AutoScalingGroup extends AutoScalingGroupBase implements
       keyName: props.keyName,
       instanceType: props.instanceType.toString(),
       securityGroups: securityGroupsToken,
-      iamInstanceProfile: iamProfile.refAsString,
+      iamInstanceProfile: iamProfile.ref,
       userData: userDataToken,
       associatePublicIpAddress: props.associatePublicIpAddress,
       spotPrice: props.spotPrice,
@@ -415,7 +415,7 @@ export class AutoScalingGroup extends AutoScalingGroupBase implements
       minSize: minCapacity.toString(),
       maxSize: maxCapacity.toString(),
       desiredCapacity: desiredCapacity.toString(),
-      launchConfigurationName: launchConfig.refAsString,
+      launchConfigurationName: launchConfig.ref,
       loadBalancerNames: Lazy.listValue({ produce: () => this.loadBalancerNames }, { omitEmpty: true }),
       targetGroupArns: Lazy.listValue({ produce: () => this.targetGroupArns }, { omitEmpty: true }),
       notificationConfigurations: !props.notificationsTopic ? undefined : [
@@ -438,7 +438,7 @@ export class AutoScalingGroup extends AutoScalingGroupBase implements
 
     this.autoScalingGroup = new CfnAutoScalingGroup(this, 'ASG', asgProps);
     this.osType = machineImage.os.type;
-    this.autoScalingGroupName = this.autoScalingGroup.refAsString;
+    this.autoScalingGroupName = this.autoScalingGroup.ref;
     this.autoScalingGroupArn = Stack.of(this).formatArn({
       service: 'autoscaling',
       resource: 'autoScalingGroup:*:autoScalingGroupName',
@@ -661,7 +661,7 @@ export enum ScalingProcess {
 /**
  * Render the rolling update configuration into the appropriate object
  */
-function renderRollingUpdateConfig(config: RollingUpdateConfiguration = {}): AutoScalingRollingUpdate {
+function renderRollingUpdateConfig(config: RollingUpdateConfiguration = {}): CfnAutoScalingRollingUpdate {
   const waitOnResourceSignals = config.minSuccessfulInstancesPercent !== undefined ? true : false;
   const pauseTime = config.pauseTime || (waitOnResourceSignals ? Duration.minutes(5) : Duration.seconds(0));
 

diff --git a/packages/@aws-cdk/aws-autoscaling/lib/lifecycle-hook.ts b/packages/@aws-cdk/aws-autoscaling/lib/lifecycle-hook.ts
@@ -106,7 +106,7 @@ export class LifecycleHook extends Resource implements ILifecycleHook {
       autoScalingGroupName: props.autoScalingGroup.autoScalingGroupName,
       defaultResult: props.defaultResult,
       heartbeatTimeout: props.heartbeatTimeout && props.heartbeatTimeout.toSeconds(),
-      lifecycleHookName: this.physicalName.value,
+      lifecycleHookName: this.physicalName,
       lifecycleTransition: props.lifecycleTransition,
       notificationMetadata: props.notificationMetadata,
       notificationTargetArn: targetProps.notificationTargetArn,
@@ -118,7 +118,7 @@ export class LifecycleHook extends Resource implements ILifecycleHook {
     // lifecycle hook.
     resource.node.addDependency(this.role);
 
-    this.lifecycleHookName = resource.refAsString;
+    this.lifecycleHookName = resource.ref;
   }
 }
 

diff --git a/packages/@aws-cdk/aws-autoscaling/lib/step-scaling-action.ts b/packages/@aws-cdk/aws-autoscaling/lib/step-scaling-action.ts
@@ -81,7 +81,7 @@ export class StepScalingAction extends cdk.Construct {
       stepAdjustments: cdk.Lazy.anyValue({ produce: () => this.adjustments }),
     });
 
-    this.scalingPolicyArn = resource.refAsString;
+    this.scalingPolicyArn = resource.ref;
   }
 
   /**

diff --git a/packages/@aws-cdk/aws-autoscaling/lib/target-tracking-scaling-policy.ts b/packages/@aws-cdk/aws-autoscaling/lib/target-tracking-scaling-policy.ts
@@ -135,7 +135,7 @@ export class TargetTrackingScalingPolicy extends cdk.Construct {
       }
     });
 
-    this.scalingPolicyArn = this.resource.refAsString;
+    this.scalingPolicyArn = this.resource.ref;
   }
 }
 

diff --git a/packages/@aws-cdk/aws-certificatemanager/lib/certificate.ts b/packages/@aws-cdk/aws-certificatemanager/lib/certificate.ts
@@ -87,7 +87,7 @@ export class Certificate extends Resource implements ICertificate {
       domainValidationOptions: allDomainNames.map(domainValidationOption),
     });
 
-    this.certificateArn = cert.refAsString;
+    this.certificateArn = cert.ref;
 
     /**
      * Return the domain validation options for the given domain

diff --git a/packages/@aws-cdk/aws-cloudformation/test/integ.aws-custom-resource.ts b/packages/@aws-cdk/aws-cloudformation/test/integ.aws-custom-resource.ts
@@ -2,6 +2,7 @@
 import sns = require('@aws-cdk/aws-sns');
 import ssm = require('@aws-cdk/aws-ssm');
 import cdk = require('@aws-cdk/cdk');
+import { Token } from '@aws-cdk/cdk';
 import { AwsCustomResource } from '../lib';
 
 const app = new cdk.App();
@@ -46,8 +47,8 @@ const getParameter = new AwsCustomResource(stack, 'GetParameter', {
   }
 });
 
-new cdk.CfnOutput(stack, 'MessageId', { value: snsPublish.getData('MessageId') });
-new cdk.CfnOutput(stack, 'TopicArn', { value: listTopics.getData('Topics.0.TopicArn') });
-new cdk.CfnOutput(stack, 'ParameterValue', { value: getParameter.getData('Parameter.Value') });
+new cdk.CfnOutput(stack, 'MessageId', { value: Token.asString(snsPublish.getData('MessageId')) });
+new cdk.CfnOutput(stack, 'TopicArn', { value: Token.asString(listTopics.getData('Topics.0.TopicArn')) });
+new cdk.CfnOutput(stack, 'ParameterValue', { value: Token.asString(getParameter.getData('Parameter.Value')) });
 
 app.synth();
diff --git a/packages/@aws-cdk/aws-cloudfront/lib/web_distribution.ts b/packages/@aws-cdk/aws-cloudfront/lib/web_distribution.ts
@@ -698,7 +698,7 @@ export class CloudFrontWebDistribution extends cdk.Construct implements IDistrib
 
     const distribution = new CfnDistribution(this, 'CFDistribution', { distributionConfig });
     this.domainName = distribution.attrDomainName;
-    this.distributionId = distribution.refAsString;
+    this.distributionId = distribution.ref;
   }
 
   private toBehavior(input: BehaviorWithOrigin, protoPolicy?: ViewerProtocolPolicy) {

diff --git a/packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront-lambda-association.ts b/packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront-lambda-association.ts
@@ -35,4 +35,4 @@ new cloudfront.CloudFrontWebDistribution(stack, 'MyDistribution', {
   ]
  });
 
-app.run();
+app.synth();
diff --git a/packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront-s3.ts b/packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront-s3.ts
@@ -17,7 +17,7 @@ const dist = new cloudfront.CloudFrontWebDistribution(stack, 'Distribution', {
     behaviors: [{ isDefaultBehavior: true }],
     s3OriginSource: {
       s3BucketSource: bucket,
-      originAccessIdentityId: oai.refAsString,
+      originAccessIdentityId: oai.ref,
     },
   }]
 });

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, ResourceIdentifiers, Stack } from '@aws-cdk/cdk';
+import { Construct, PhysicalName, Resource, Stack } from '@aws-cdk/cdk';
 import { CfnTrail } from './cloudtrail.generated';
 
 // AWS::CloudTrail CloudFormation Resources:
@@ -175,7 +175,7 @@ export class Trail extends Resource {
       enableLogFileValidation: props.enableFileValidation == null ? true : props.enableFileValidation,
       isMultiRegionTrail: props.isMultiRegionTrail == null ? true : props.isMultiRegionTrail,
       includeGlobalServiceEvents: props.includeGlobalServiceEvents == null ? true : props.includeGlobalServiceEvents,
-      trailName: this.physicalName.value,
+      trailName: this.physicalName,
       kmsKeyId:  props.kmsKey && props.kmsKey.keyArn,
       s3BucketName: s3bucket.bucketName,
       s3KeyPrefix: props.s3KeyPrefix,
@@ -185,13 +185,13 @@ export class Trail extends Resource {
       eventSelectors: this.eventSelectors
     });
 
-    const resourceIdentifiers = new ResourceIdentifiers(this, {
+    const resourceIdentifiers = this.getCrossEnvironmentAttributes({
       arn: trail.attrArn,
       name: trail.trailName || '',
       arnComponents: {
         service: 'cloudtrail',
         resource: 'trail',
-        resourceName: this.physicalName.value,
+        resourceName: this.physicalName,
       },
     });
     this.trailArn = resourceIdentifiers.arn;

diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/alarm.ts b/packages/@aws-cdk/aws-cloudwatch/lib/alarm.ts
@@ -1,4 +1,4 @@
-import { Construct, IResource, Lazy, Resource, ResourceIdentifiers, Stack } from '@aws-cdk/cdk';
+import { Construct, IResource, Lazy, Resource, Stack } from '@aws-cdk/cdk';
 import { IAlarmAction } from './alarm-action';
 import { CfnAlarm } from './cloudwatch.generated';
 import { HorizontalAnnotation } from './graph';
@@ -126,7 +126,7 @@ export class Alarm extends Resource implements IAlarm {
     const alarm = new CfnAlarm(this, 'Resource', {
       // Meta
       alarmDescription: props.alarmDescription,
-      alarmName: this.physicalName.value,
+      alarmName: this.physicalName,
 
       // Evaluation
       comparisonOperator,
@@ -151,13 +151,13 @@ export class Alarm extends Resource implements IAlarm {
       })
     });
 
-    const resourceIdentifiers = new ResourceIdentifiers(this, {
+    const resourceIdentifiers = this.getCrossEnvironmentAttributes({
       arn: alarm.attrArn,
-      name: alarm.refAsString,
+      name: alarm.ref,
       arnComponents: {
         service: 'cloudwatch',
         resource: 'alarm',
-        resourceName: this.physicalName.value,
+        resourceName: this.physicalName,
         sep: ':',
       },
     });

diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts b/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts
@@ -68,7 +68,7 @@ export class Dashboard extends Resource {
     });
 
     new CfnDashboard(this, 'Resource', {
-      dashboardName: this.physicalName.value,
+      dashboardName: this.physicalName,
       dashboardBody: Lazy.stringValue({ produce: () => {
         const column = new Column(...this.rows);
         column.position(0, 0);

diff --git a/packages/@aws-cdk/aws-codebuild/README.md b/packages/@aws-cdk/aws-codebuild/README.md
@@ -335,7 +335,7 @@ const vpc = new ec2.Vpc(stack, 'MyVPC');
 const securityGroup = new ec2.SecurityGroup(stack, 'SecurityGroup1', {
     allowAllOutbound: true,
     description: 'Example',
-    groupName: 'MySecurityGroup',
+    securityGroupName: 'MySecurityGroup',
     vpc: vpc,
 });
 new codebuild.Project(stack, 'MyProject', {