feat(core): overrideLogicalId: override IDs of CFN elements (#1670)

Allow users to explicitly override the logical ID of a CloudFormation element (such as "Cfn" resources) by invoking `overrideLogicalId` on the resource object. For example: const bucket = new s3.CfnBucket(this, 'MyBucket'); bucket.overrideLogicalId('YourBucket'); The resulting template will use `YourBucket` as the logical ID. NOTE: the `logicalId` property will now return a stringified token instead of a concrete value. Fixes #1594
aws · Feb 6, 2019 · 823a1e8 · 823a1e8
1 parent 8da9115
commit 823a1e8
Show file tree

Hide file tree

Showing 48 changed files with 255 additions and 152 deletions.
diff --git a/packages/@aws-cdk/app-delivery/test/integ.cicd.expected.json b/packages/@aws-cdk/app-delivery/test/integ.cicd.expected.json
@@ -239,8 +239,8 @@
         ]
       },
       "DependsOn": [
-        "CodePipelineRoleB3A660B4",
-        "CodePipelineRoleDefaultPolicy8D520A8D"
+        "CodePipelineRoleDefaultPolicy8D520A8D",
+        "CodePipelineRoleB3A660B4"
       ]
     },
     "DeployStackChangeSetRole4923A126": {
@@ -261,4 +261,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/assets/test/test.asset.ts b/packages/@aws-cdk/assets/test/test.asset.ts
@@ -18,7 +18,10 @@ export = {
     // the correct information
     const entry = asset.node.metadata.find(m => m.type === 'aws:cdk:asset');
     test.ok(entry, 'found metadata entry');
-    test.deepEqual(entry!.data, {
+
+    // console.error(JSON.stringify(stack.node.resolve(entry!.data)));
+
+    test.deepEqual(stack.node.resolve(entry!.data), {
       path: dirPath,
       id: 'MyAsset',
       packaging: 'zip',
@@ -34,13 +37,35 @@ export = {
     test.done();
   },
 
+  'verify that the app resolves tokens in metadata'(test: Test) {
+    const app = new cdk.App();
+    const stack = new cdk.Stack(app, 'my-stack');
+    const dirPath = path.resolve(__dirname, 'sample-asset-directory');
+
+    new ZipDirectoryAsset(stack, 'MyAsset', {
+      path: dirPath
+    });
+
+    const synth = app.synthesizeStack(stack.name);
+
+    test.deepEqual(synth.metadata['/my-stack/MyAsset'][0].data, {
+      path: dirPath,
+      id: "mystackMyAssetD6B1B593",
+      packaging: "zip",
+      s3BucketParameter: "MyAssetS3Bucket68C9B344",
+      s3KeyParameter: "MyAssetS3VersionKey68E1A45D"
+    });
+
+    test.done();
+  },
+
   '"file" assets'(test: Test) {
     const stack = new cdk.Stack();
     const filePath = path.join(__dirname, 'file-asset.txt');
     const asset = new FileAsset(stack, 'MyAsset', { path: filePath });
     const entry = asset.node.metadata.find(m => m.type === 'aws:cdk:asset');
     test.ok(entry, 'found metadata entry');
-    test.deepEqual(entry!.data, {
+    test.deepEqual(stack.node.resolve(entry!.data), {
       path: filePath,
       packaging: 'file',
       id: 'MyAsset',

diff --git a/packages/@aws-cdk/aws-apigateway/test/integ.restapi.books.expected.json b/packages/@aws-cdk/aws-apigateway/test/integ.restapi.books.expected.json
@@ -526,12 +526,12 @@
       },
       "DependsOn": [
         "booksapiANYF4F0CDEB",
-        "booksapibooks97D84727",
+        "booksapibooksbookidDELETE214F4059",
+        "booksapibooksbookidGETCCE21986",
+        "booksapibooksbookid5264BCA2",
         "booksapibooksGETA776447A",
         "booksapibooksPOSTF6C6559D",
-        "booksapibooksbookid5264BCA2",
-        "booksapibooksbookidDELETE214F4059",
-        "booksapibooksbookidGETCCE21986"
+        "booksapibooks97D84727"
       ]
     },
     "booksapiDeploymentStageprod55D8E03E": {

diff --git a/packages/@aws-cdk/aws-apigateway/test/integ.restapi.expected.json b/packages/@aws-cdk/aws-apigateway/test/integ.restapi.expected.json
@@ -15,16 +15,16 @@
         "Description": "Automatically created by the RestApi construct"
       },
       "DependsOn": [
-        "myapiv113487378",
-        "myapiv1appliances507FEFF4",
         "myapiv1appliancesGET8FE872EC",
-        "myapiv1books1D4BE6C1",
+        "myapiv1appliances507FEFF4",
         "myapiv1booksGETC6B996D0",
         "myapiv1booksPOST53E2832E",
-        "myapiv1toysA55FCBC4",
+        "myapiv1books1D4BE6C1",
+        "myapiv113487378",
         "myapiv1toysGET7348114D",
         "myapiv1toysPOST55128058",
-        "myapiv1toysPUT59AFBBC2"
+        "myapiv1toysPUT59AFBBC2",
+        "myapiv1toysA55FCBC4"
       ],
       "DeletionPolicy": "Retain"
     },

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.restapi.ts b/packages/@aws-cdk/aws-apigateway/test/test.restapi.ts
@@ -525,12 +525,12 @@ export = {
     // THEN
     expect(stack).to(haveResource('My::Resource', {
       DependsOn: [
-        "myapiDeploymentB7EF8EB75c091a668064a3f3a1f6d68a3fb22cf9",
-        "myapi162F20B8",
         "myapiAccountC3A4750C",
         "myapiCloudWatchRoleEB425128",
+        "myapiDeploymentB7EF8EB75c091a668064a3f3a1f6d68a3fb22cf9",
         "myapiDeploymentStageprod329F21FF",
-        "myapiGET9B7CD29E"
+        "myapiGET9B7CD29E",
+        "myapi162F20B8"
       ]
     }, ResourcePart.CompleteDefinition));
 

diff --git a/packages/@aws-cdk/aws-autoscaling/test/test.lifecyclehooks.ts b/packages/@aws-cdk/aws-autoscaling/test/test.lifecyclehooks.ts
@@ -34,8 +34,8 @@ export = {
     // Lifecycle Hook has a dependency on the policy object
     expect(stack).to(haveResource('AWS::AutoScaling::LifecycleHook', {
       DependsOn: [
+        "ASGLifecycleHookTransitionRoleDefaultPolicy2E50C7DB",
         "ASGLifecycleHookTransitionRole3AAA6BB7",
-        "ASGLifecycleHookTransitionRoleDefaultPolicy2E50C7DB"
       ]
     }, ResourcePart.CompleteDefinition));
 

diff --git a/packages/@aws-cdk/aws-codebuild/test/integ.docker-asset.lit.expected.json b/packages/@aws-cdk/aws-codebuild/test/integ.docker-asset.lit.expected.json
@@ -197,8 +197,8 @@
         "Timeout": 300
       },
       "DependsOn": [
-        "AdoptEcrRepositorydbc60defc59544bcaa5c28c95d68f62cServiceRoleD788AA17",
-        "AdoptEcrRepositorydbc60defc59544bcaa5c28c95d68f62cServiceRoleDefaultPolicy6BC8737C"
+        "AdoptEcrRepositorydbc60defc59544bcaa5c28c95d68f62cServiceRoleDefaultPolicy6BC8737C",
+        "AdoptEcrRepositorydbc60defc59544bcaa5c28c95d68f62cServiceRoleD788AA17"
       ]
     },
     "MyProjectRole9BBE5233": {
@@ -416,4 +416,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-codedeploy/test/lambda/integ.deployment-group.expected.json b/packages/@aws-cdk/aws-codedeploy/test/lambda/integ.deployment-group.expected.json
@@ -253,8 +253,8 @@
         "Runtime": "nodejs8.10"
       },
       "DependsOn": [
-        "PreHookServiceRoleC724B9BA",
-        "PreHookServiceRoleDefaultPolicy65358F76"
+        "PreHookServiceRoleDefaultPolicy65358F76",
+        "PreHookServiceRoleC724B9BA"
       ]
     },
     "PostHookServiceRoleE8A6AAC2": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.cfn-template-from-repo.lit.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.cfn-template-from-repo.lit.expected.json
@@ -272,8 +272,8 @@
         ]
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "PipelineDeployPrepareChangesRoleD28C853C": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.lambda-pipeline.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.lambda-pipeline.expected.json
@@ -184,8 +184,8 @@
         ]
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "PipelineEventsRole46BEEA7C": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-alexa-deploy.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-alexa-deploy.expected.json
@@ -173,8 +173,8 @@
         }
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "PipelineBucketB967BD35": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-cfn-cross-region.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-cfn-cross-region.expected.json
@@ -222,8 +222,8 @@
         ]
       },
       "DependsOn": [
-        "MyPipelineRoleC0D47CA4",
-        "MyPipelineRoleDefaultPolicy34F09EFA"
+        "MyPipelineRoleDefaultPolicy34F09EFA",
+        "MyPipelineRoleC0D47CA4"
       ]
     },
     "CFNDeployRole68D5E8D3": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-cfn-wtih-action-role.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-cfn-wtih-action-role.expected.json
@@ -238,8 +238,8 @@
         }
       },
       "DependsOn": [
-        "MyPipelineRoleC0D47CA4",
-        "MyPipelineRoleDefaultPolicy34F09EFA"
+        "MyPipelineRoleDefaultPolicy34F09EFA",
+        "MyPipelineRoleC0D47CA4"
       ]
     },
     "ActionRole60B0EDF7": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-cfn.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-cfn.expected.json
@@ -224,8 +224,8 @@
         ]
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "PipelineBucketB967BD35": {

diff --git a/...cdk/aws-codepipeline/test/integ.pipeline-code-build-multiple-inputs-outputs.expected.json b/...cdk/aws-codepipeline/test/integ.pipeline-code-build-multiple-inputs-outputs.expected.json
@@ -358,8 +358,8 @@
         ]
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "PipelineEventsRole46BEEA7C": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-code-commit-build.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-code-commit-build.expected.json
@@ -222,8 +222,8 @@
         ]
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "MyBuildProjectRole6B7E2258": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-code-commit.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-code-commit.expected.json
@@ -225,8 +225,8 @@
         ]
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "PipelineEventsRole46BEEA7C": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-code-deploy.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-code-deploy.expected.json
@@ -330,8 +330,8 @@
         ]
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     }
   }

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-ecr-source.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-ecr-source.expected.json
@@ -141,8 +141,8 @@
         }
       },
       "DependsOn": [
-        "MyPipelineRoleC0D47CA4",
-        "MyPipelineRoleDefaultPolicy34F09EFA"
+        "MyPipelineRoleDefaultPolicy34F09EFA",
+        "MyPipelineRoleC0D47CA4"
       ]
     },
     "MyPipelineEventsRoleFAB99F32": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-events.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-events.expected.json
@@ -180,8 +180,8 @@
         ]
       },
       "DependsOn": [
-        "MyPipelineRoleC0D47CA4",
-        "MyPipelineRoleDefaultPolicy34F09EFA"
+        "MyPipelineRoleDefaultPolicy34F09EFA",
+        "MyPipelineRoleC0D47CA4"
       ]
     },
     "MyPipelineOnPipelineStateChangeA017E4B1": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-jenkins.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-jenkins.expected.json
@@ -217,8 +217,8 @@
         ]
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "JenkinsProviderJenkinsBuildProviderResourceD9231CAC": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-manual-approval.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-manual-approval.expected.json
@@ -175,8 +175,8 @@
         }
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "ManualApprovalTopicResource300641E2": {

diff --git a/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-s3-deploy.expected.json b/packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-s3-deploy.expected.json
@@ -203,8 +203,8 @@
         }
       },
       "DependsOn": [
-        "PipelineRoleD68726F7",
-        "PipelineRoleDefaultPolicyC7A05455"
+        "PipelineRoleDefaultPolicyC7A05455",
+        "PipelineRoleD68726F7"
       ]
     },
     "PipelineBucketB967BD35": {

diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/integ.event-task.lit.expected.json b/packages/@aws-cdk/aws-ecs/test/ec2/integ.event-task.lit.expected.json
@@ -307,8 +307,8 @@
         }
       },
       "DependsOn": [
-        "EcsClusterDefaultAutoScalingGroupInstanceRole3C026863",
-        "EcsClusterDefaultAutoScalingGroupInstanceRoleDefaultPolicy04DC6C80"
+        "EcsClusterDefaultAutoScalingGroupInstanceRoleDefaultPolicy04DC6C80",
+        "EcsClusterDefaultAutoScalingGroupInstanceRole3C026863"
       ]
     },
     "EcsClusterDefaultAutoScalingGroupASGC1A785DB": {
@@ -461,8 +461,8 @@
         "Timeout": 310
       },
       "DependsOn": [
-        "EcsClusterDefaultAutoScalingGroupDrainECSHookFunctionServiceRole94543EDA",
-        "EcsClusterDefaultAutoScalingGroupDrainECSHookFunctionServiceRoleDefaultPolicyA45BF396"
+        "EcsClusterDefaultAutoScalingGroupDrainECSHookFunctionServiceRoleDefaultPolicyA45BF396",
+        "EcsClusterDefaultAutoScalingGroupDrainECSHookFunctionServiceRole94543EDA"
       ]
     },
     "EcsClusterDefaultAutoScalingGroupDrainECSHookFunctionTopicE6B1EBA6": {
@@ -538,8 +538,8 @@
         }
       },
       "DependsOn": [
-        "EcsClusterDefaultAutoScalingGroupLifecycleHookDrainHookRoleA38EC83B",
-        "EcsClusterDefaultAutoScalingGroupLifecycleHookDrainHookRoleDefaultPolicy75002F88"
+        "EcsClusterDefaultAutoScalingGroupLifecycleHookDrainHookRoleDefaultPolicy75002F88",
+        "EcsClusterDefaultAutoScalingGroupLifecycleHookDrainHookRoleA38EC83B"
       ]
     },
     "TaskDefTaskRole1EDB4A67": {
@@ -1031,8 +1031,8 @@
         "Timeout": 300
       },
       "DependsOn": [
-        "AdoptEcrRepositorydbc60defc59544bcaa5c28c95d68f62cServiceRoleD788AA17",
-        "AdoptEcrRepositorydbc60defc59544bcaa5c28c95d68f62cServiceRoleDefaultPolicy6BC8737C"
+        "AdoptEcrRepositorydbc60defc59544bcaa5c28c95d68f62cServiceRoleDefaultPolicy6BC8737C",
+        "AdoptEcrRepositorydbc60defc59544bcaa5c28c95d68f62cServiceRoleD788AA17"
       ]
     },
     "TaskLoggingLogGroupC7E938D4": {