feat(cdk): transparently use constructs from another stack

It is now no longer necessary to use `export()` and `import()` when sharing constructs between two `Stacks` inside the same CDK app. Instead, objects defined in one stack can be used directly in another stack. The CDK will detect when an attribute (such as an ARN, ID or URL) of such an object is used in a different stack, and will automatically create the required `Export` in the producing stack and insert the corresponding `Fn::ImportValue` in the consuming stack. BREAKING CHANGE: if you are using `export()` and `import()` to share constructs between stacks, you can stop doing that, instead of `FooImportProps` accept an `IFoo` directly on the consuming stack, and use that object as usual. `ArnUtils.fromComponents()` and `ArnUtils.parse()` have been moved onto `Stack`. All CloudFormation pseudo-parameter (such as `AWS::AccountId` etc) are now also accessible via `Stack`, as `stack.accountId` etc. `resolve()` has been moved to `this.node.resolve()`. `CloudFormationJSON.stringify()` has been moved to `this.node.stringifyJson()`. `validate()` now should be `protected`. Fixes #1324.
aws · Jan 9, 2019 · d7371f0 · d7371f0
1 parent 935054a
commit d7371f0
Show file tree

Hide file tree

Showing 155 changed files with 2,767 additions and 1,688 deletions.
diff --git a/design/aws-guidelines.md b/design/aws-guidelines.md
@@ -204,7 +204,7 @@ properties that allow the user to specify an external resource identity, usually
 by providing one or more resource attributes such as ARN, physical name, etc.
 
 The import interface should have the minimum required properties, that is: if it
-is possible to parse the resource name from the ARN (using `cdk.ArnUtils.parse`),
+is possible to parse the resource name from the ARN (using `cdk.Stack.parseArn`),
 then only the ARN should be required. In cases where it
 is not possible to parse the ARN (e.g. if it is a token and the resource name
 might have use "/" characters), both the ARN and the name should be optional and

diff --git a/examples/cdk-examples-typescript/advanced-usage/index.ts b/examples/cdk-examples-typescript/advanced-usage/index.ts
@@ -157,7 +157,7 @@ class CloudFormationExample extends cdk.Stack {
     // outputs are constructs the synthesize into the template's "Outputs" section
     new cdk.Output(this, 'Output', {
       description: 'This is an output of the template',
-      value: `${new cdk.AwsAccountId()}/${param.ref}`
+      value: `${this.accountId}/${param.ref}`
     });
 
     // stack.templateOptions can be used to specify template-level options
@@ -166,14 +166,13 @@ class CloudFormationExample extends cdk.Stack {
 
       // all CloudFormation's pseudo-parameters are supported via the `cdk.AwsXxx` classes
       PseudoParameters: [
-        new cdk.AwsAccountId(),
-        new cdk.AwsDomainSuffix(),
-        new cdk.AwsNotificationARNs(),
-        new cdk.AwsNoValue(),
-        new cdk.AwsPartition(),
-        new cdk.AwsRegion(),
-        new cdk.AwsStackId(),
-        new cdk.AwsStackName(),
+        this.accountId,
+        this.urlSuffix,
+        this.notificationArns,
+        this.partition,
+        this.region,
+        this.stackId,
+        this.stackName,
       ],
 
       // all CloudFormation's intrinsic functions are supported via the `cdk.Fn.xxx` static methods.

diff --git a/packages/@aws-cdk/app-delivery/lib/pipeline-deploy-stack-action.ts b/packages/@aws-cdk/app-delivery/lib/pipeline-deploy-stack-action.ts
@@ -140,16 +140,6 @@ export class PipelineDeployStackAction extends cdk.Construct {
     });
   }
 
-  public validate(): string[] {
-    const result = super.validate();
-    const assets = this.stack.node.metadata.filter(md => md.type === cxapi.ASSET_METADATA);
-    if (assets.length > 0) {
-      // FIXME: Implement the necessary actions to publish assets
-      result.push(`Cannot deploy the stack ${this.stack.name} because it references ${assets.length} asset(s)`);
-    }
-    return result;
-  }
-
   /**
    * Add policy statements to the role deploying the stack.
    *
@@ -162,6 +152,16 @@ export class PipelineDeployStackAction extends cdk.Construct {
   public addToRolePolicy(statement: iam.PolicyStatement) {
     this.role.addToPolicy(statement);
   }
+
+  protected validate(): string[] {
+    const result = super.validate();
+    const assets = this.stack.node.metadata.filter(md => md.type === cxapi.ASSET_METADATA);
+    if (assets.length > 0) {
+      // FIXME: Implement the necessary actions to publish assets
+      result.push(`Cannot deploy the stack ${this.stack.name} because it references ${assets.length} asset(s)`);
+    }
+    return result;
+  }
 }
 
 function cfnCapabilities(adminPermissions: boolean, capabilities?: cfn.CloudFormationCapabilities): cfn.CloudFormationCapabilities {

diff --git a/packages/@aws-cdk/app-delivery/test/test.pipeline-deploy-stack-action.ts b/packages/@aws-cdk/app-delivery/test/test.pipeline-deploy-stack-action.ts
@@ -274,7 +274,7 @@ export = nodeunit.testCase({
           for (let i = 0 ; i < assetCount ; i++) {
             deployedStack.node.addMetadata(cxapi.ASSET_METADATA, {});
           }
-          test.deepEqual(action.validate(),
+          test.deepEqual(action.node.validateTree().map(x => x.message),
             [`Cannot deploy the stack DeployedStack because it references ${assetCount} asset(s)`]);
         }
       )

diff --git a/packages/@aws-cdk/assert/lib/expect.ts b/packages/@aws-cdk/assert/lib/expect.ts
@@ -9,6 +9,9 @@ export function expect(stack: api.SynthesizedStack | cdk.Stack, skipValidation =
 
   if (isStackClassInstance(stack)) {
     if (!skipValidation) {
+      // Do a prepare-and-validate run over the given stack
+      stack.node.prepareTree();
+
       const errors = stack.node.validateTree();
       if (errors.length > 0) {
         throw new Error(`Stack validation failed:\n${errors.map(e => `${e.message} at: ${e.source.node.scope}`).join('\n')}`);
@@ -34,4 +37,4 @@ export function expect(stack: api.SynthesizedStack | cdk.Stack, skipValidation =
 
 function isStackClassInstance(x: api.SynthesizedStack | cdk.Stack): x is cdk.Stack {
   return 'toCloudFormation' in x;
-}
+}
diff --git a/packages/@aws-cdk/assets-docker/lib/adopted-repository.ts b/packages/@aws-cdk/assets-docker/lib/adopted-repository.ts
@@ -42,7 +42,7 @@ export class AdoptedRepository extends ecr.RepositoryBase {
     });
 
     fn.addToRolePolicy(new iam.PolicyStatement()
-      .addResource(ecr.Repository.arnForLocalRepository(props.repositoryName))
+      .addResource(ecr.Repository.arnForLocalRepository(props.repositoryName, this))
       .addActions(
         'ecr:GetRepositoryPolicy',
         'ecr:SetRepositoryPolicy',
@@ -67,7 +67,7 @@ export class AdoptedRepository extends ecr.RepositoryBase {
 
     // this this repository is "local" to the stack (in the same region/account)
     // we can render it's ARN from it's name.
-    this.repositoryArn = ecr.Repository.arnForLocalRepository(this.repositoryName);
+    this.repositoryArn = ecr.Repository.arnForLocalRepository(this.repositoryName, this);
   }
 
   /**

diff --git a/packages/@aws-cdk/aws-apigateway/lib/deployment.ts b/packages/@aws-cdk/aws-apigateway/lib/deployment.ts
@@ -107,13 +107,16 @@ class LatestDeploymentResource extends CfnDeployment {
   private originalLogicalId?: string;
   private lazyLogicalIdRequired: boolean;
   private lazyLogicalId?: string;
+  private logicalIdToken: cdk.Token;
   private hashComponents = new Array<any>();
 
   constructor(scope: cdk.Construct, id: string, props: CfnDeploymentProps) {
     super(scope, id, props);
 
     // from this point, don't allow accessing logical ID before synthesis
     this.lazyLogicalIdRequired = true;
+
+    this.logicalIdToken = new cdk.Token(() => this.lazyLogicalId);
   }
 
   /**
@@ -124,11 +127,7 @@ class LatestDeploymentResource extends CfnDeployment {
       return this.originalLogicalId!;
     }
 
-    if (!this.lazyLogicalId) {
-      throw new Error('This resource has a lazy logical ID which is calculated just before synthesis. Use a cdk.Token to evaluate');
-    }
-
-    return this.lazyLogicalId;
+    return this.logicalIdToken.toString();
   }
 
   /**
@@ -170,20 +169,18 @@ class LatestDeploymentResource extends CfnDeployment {
    * Hooks into synthesis to calculate a logical ID that hashes all the components
    * add via `addToLogicalId`.
    */
-  public validate() {
+  protected prepare() {
     // if hash components were added to the deployment, we use them to calculate
     // a logical ID for the deployment resource.
     if (this.hashComponents.length === 0) {
       this.lazyLogicalId = this.originalLogicalId;
     } else {
       const md5 = crypto.createHash('md5');
       this.hashComponents
-        .map(c => cdk.resolve(c))
+        .map(c => this.node.resolve(c))
         .forEach(c => md5.update(JSON.stringify(c)));
 
       this.lazyLogicalId = this.originalLogicalId + md5.digest("hex");
     }
-
-    return [];
   }
 }
diff --git a/packages/@aws-cdk/aws-apigateway/lib/integrations/aws.ts b/packages/@aws-cdk/aws-apigateway/lib/integrations/aws.ts
@@ -1,5 +1,6 @@
 import cdk = require('@aws-cdk/cdk');
 import { Integration, IntegrationOptions, IntegrationType } from '../integration';
+import { Method } from '../method';
 import { parseAwsApiCall } from '../util';
 
 export interface AwsIntegrationProps {
@@ -61,21 +62,30 @@ export interface AwsIntegrationProps {
  * technology.
  */
 export class AwsIntegration extends Integration {
+  private scope?: cdk.IConstruct;
+
   constructor(props: AwsIntegrationProps) {
     const backend = props.subdomain ? `${props.subdomain}.${props.service}` : props.service;
     const type = props.proxy ? IntegrationType.AwsProxy : IntegrationType.Aws;
     const { apiType, apiValue } = parseAwsApiCall(props.path, props.action, props.actionParameters);
     super({
       type,
       integrationHttpMethod: 'POST',
-      uri: cdk.ArnUtils.fromComponents({
-        service: 'apigateway',
-        account: backend,
-        resource: apiType,
-        sep: '/',
-        resourceName: apiValue,
+      uri: new cdk.Token(() => {
+        if (!this.scope) { throw new Error('AwsIntegration must be used in API'); }
+        return cdk.Stack.find(this.scope).formatArn({
+          service: 'apigateway',
+          account: backend,
+          resource: apiType,
+          sep: '/',
+          resourceName: apiValue,
+        });
       }),
       options: props.options,
     });
   }
+
+  public bind(method: Method) {
+    this.scope = method;
+  }
 }
diff --git a/packages/@aws-cdk/aws-apigateway/lib/integrations/lambda.ts b/packages/@aws-cdk/aws-apigateway/lib/integrations/lambda.ts
@@ -52,6 +52,7 @@ export class LambdaIntegration extends AwsIntegration {
   }
 
   public bind(method: Method) {
+    super.bind(method);
     const principal = new iam.ServicePrincipal('apigateway.amazonaws.com');
 
     const desc = `${method.httpMethod}.${method.resource.resourcePath.replace(/\//g, '.')}`;

diff --git a/packages/@aws-cdk/aws-apigateway/lib/method.ts b/packages/@aws-cdk/aws-apigateway/lib/method.ts
@@ -158,7 +158,8 @@ export class Method extends cdk.Construct {
       credentials = options.credentialsRole.roleArn;
     } else if (options.credentialsPassthrough) {
       // arn:aws:iam::*:user/*
-      credentials = cdk.ArnUtils.fromComponents({ service: 'iam', region: '', account: '*', resource: 'user', sep: '/', resourceName: '*' });
+      // tslint:disable-next-line:max-line-length
+      credentials = cdk.Stack.find(this).formatArn({ service: 'iam', region: '', account: '*', resource: 'user', sep: '/', resourceName: '*' });
     }
 
     return {

diff --git a/packages/@aws-cdk/aws-apigateway/lib/restapi.ts b/packages/@aws-cdk/aws-apigateway/lib/restapi.ts
@@ -301,33 +301,33 @@ export class RestApi extends cdk.Construct implements cdk.IDependable, IRestApi
       method = '*';
     }
 
-    return cdk.ArnUtils.fromComponents({
+    return cdk.Stack.find(this).formatArn({
       service: 'execute-api',
       resource: this.restApiId,
       sep: '/',
       resourceName: `${stage}/${method}${path}`
     });
   }
 
+  /**
+   * Internal API used by `Method` to keep an inventory of methods at the API
+   * level for validation purposes.
+   */
+  public _attachMethod(method: Method) {
+    this.methods.push(method);
+  }
+
   /**
    * Performs validation of the REST API.
    */
-  public validate() {
+  protected validate() {
     if (this.methods.length === 0) {
       return [ `The REST API doesn't contain any methods` ];
     }
 
     return [];
   }
 
-  /**
-   * Internal API used by `Method` to keep an inventory of methods at the API
-   * level for validation purposes.
-   */
-  public _attachMethod(method: Method) {
-    this.methods.push(method);
-  }
-
   private configureDeployment(props: RestApiProps) {
     const deploy = props.deploy === undefined ? true : props.deploy;
     if (deploy) {
@@ -358,7 +358,7 @@ export class RestApi extends cdk.Construct implements cdk.IDependable, IRestApi
   private configureCloudWatchRole(apiResource: CfnRestApi) {
     const role = new iam.Role(this, 'CloudWatchRole', {
       assumedBy: new iam.ServicePrincipal('apigateway.amazonaws.com'),
-      managedPolicyArns: [ cdk.ArnUtils.fromComponents({
+      managedPolicyArns: [ cdk.Stack.find(this).formatArn({
         service: 'iam',
         region: '',
         account: 'aws',
@@ -405,8 +405,6 @@ export enum EndpointType {
   Private = 'PRIVATE'
 }
 
-export class RestApiUrl extends cdk.CloudFormationToken { }
-
 class ImportedRestApi extends cdk.Construct implements IRestApi {
   public restApiId: string;
 

diff --git a/packages/@aws-cdk/aws-apigateway/lib/stage.ts b/packages/@aws-cdk/aws-apigateway/lib/stage.ts
@@ -1,4 +1,5 @@
 import cdk = require('@aws-cdk/cdk');
+import { Stack } from '@aws-cdk/cdk';
 import { CfnStage } from './apigateway.generated';
 import { Deployment } from './deployment';
 import { IRestApi } from './restapi';
@@ -180,7 +181,8 @@ export class Stage extends cdk.Construct implements cdk.IDependable {
     if (!path.startsWith('/')) {
       throw new Error(`Path must begin with "/": ${path}`);
     }
-    return `https://${this.restApi.restApiId}.execute-api.${new cdk.AwsRegion()}.amazonaws.com/${this.stageName}${path}`;
+    const stack = Stack.find(this);
+    return `https://${this.restApi.restApiId}.execute-api.${stack.region}.${stack.urlSuffix}/${this.stageName}${path}`;
   }
 
   private renderMethodSettings(props: StageProps): CfnStage.MethodSettingProperty[] | undefined {

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
@@ -836,7 +836,9 @@
             {
               "Ref": "AWS::Region"
             },
-            ".amazonaws.com/",
+            ".",
+            { "Ref": "AWS::URLSuffix" },
+            "/",
             {
               "Ref": "booksapiDeploymentStageprod55D8E03E"
             },

diff --git a/packages/@aws-cdk/aws-apigateway/test/integ.restapi.defaults.expected.json b/packages/@aws-cdk/aws-apigateway/test/integ.restapi.defaults.expected.json
@@ -109,7 +109,9 @@
             {
               "Ref": "AWS::Region"
             },
-            ".amazonaws.com/",
+            ".",
+            { "Ref": "AWS::URLSuffix" },
+            "/",
             {
               "Ref": "myapiDeploymentStageprod298F01AF"
             },

diff --git a/packages/@aws-cdk/aws-apigateway/test/integ.restapi.expected.json b/packages/@aws-cdk/aws-apigateway/test/integ.restapi.expected.json
@@ -601,7 +601,9 @@
             {
               "Ref": "AWS::Region"
             },
-            ".amazonaws.com/",
+            ".",
+            { "Ref": "AWS::URLSuffix" },
+            "/",
             {
               "Ref": "myapiDeploymentStagebeta96434BEB"
             },

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.deployment.ts b/packages/@aws-cdk/aws-apigateway/test/test.deployment.ts
@@ -152,7 +152,7 @@ export = {
     test.done();
 
     function synthesize() {
-      stack.node.validateTree();
+      stack.node.prepareTree();
       return stack.toCloudFormation();
     }
   },

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.method.ts b/packages/@aws-cdk/aws-apigateway/test/test.method.ts
@@ -123,7 +123,7 @@ export = {
     });
 
     // THEN
-    test.deepEqual(cdk.resolve(method.methodArn), {
+    test.deepEqual(method.node.resolve(method.methodArn), {
       "Fn::Join": [
         "",
         [
@@ -157,7 +157,7 @@ export = {
     });
 
     // THEN
-    test.deepEqual(cdk.resolve(method.testMethodArn), {
+    test.deepEqual(method.node.resolve(method.testMethodArn), {
       "Fn::Join": [
         "",
         [