refactor: remove "export"s and normalize resource names (#2580)

Implemented an awslint rule to help identify all "export" methods and remove them. Align all AWS resource constructs (besides `events.EventRule`) to their canonical name. Fixes #2577 Fixes #2578 Fixes #2458 Fixes #2419 Fixes #2579 Fixes #2313 Related #2551 BREAKING CHANGE: All `export` methods from all AWS resources have been removed. CloudFormation Exports are now automatically created when attributes are referenced across stacks within the same app. To export resources manually, you can explicitly define a `CfnOutput`. * `kms.EncryptionKey` renamed to `kms.Key` * `ec2.VpcNetwork` renamed to `ec2.Vpc` * `ec2.VpcSubnet` renamed to `ec2.Subnet` * `cloudtrail.CloudTrail` renamed `to `cloudtrail.Trail` * Deleted a few `XxxAttribute` and `XxxImportProps` interfaces which were no longer in used after their corresponding `export` method was deleted and there was no use for them in imports. * `ecs.ClusterAttributes` now accepts `IVpc` and `ISecurityGroup` instead of attributes. You can use their corresponding `fromXxx` methods to import them as needed. * `servicediscovery.CnameInstance.instanceCname` renamed to `cname`. * `glue.IDatabase.locationUrl` is now only in `glue.Database` (not on the interface) * `ec2.TcpPortFromAttribute` and `UdpPortFromAttribute` removed. Use `TcpPort` and `UdpPort` with `new Token(x).toNumber` instead. * `ec2.VpcNetwork.importFromContext` renamed to `ec2.Vpc.fromLookup` * `iam.IRole.roleId` has been removed from the interface, but `Role.roleId` is still available for owned resources.
aws · May 18, 2019 · 68efa04 · 68efa04
1 parent e7ad990
commit 68efa04
Show file tree

Hide file tree

Showing 192 changed files with 1,451 additions and 3,509 deletions.
diff --git a/packages/@aws-cdk/aws-apigateway/lib/restapi.ts b/packages/@aws-cdk/aws-apigateway/lib/restapi.ts
@@ -7,30 +7,12 @@ import { Method, MethodOptions } from './method';
 import { IResource, ResourceBase, ResourceOptions } from './resource';
 import { Stage, StageOptions } from './stage';
 
-export interface RestApiAttributes {
-  /**
-   * The REST API ID of an existing REST API resource.
-   */
-  readonly restApiId: string;
-
-  /**
-   * The resource ID of the root resource.
-   */
-  readonly restApiRootResourceId?: string;
-}
-
 export interface IRestApi extends IResourceBase {
   /**
    * The ID of this API Gateway RestApi.
    * @attribute
    */
   readonly restApiId: string;
-
-  /**
-   * Exports a REST API resource from this stack.
-   * @returns REST API props that can be imported to another stack.
-   */
-  export(): RestApiAttributes;
 }
 
 export interface RestApiProps extends ResourceOptions {
@@ -165,7 +147,6 @@ export class RestApi extends Resource implements IRestApi {
   public static fromRestApiId(scope: Construct, id: string, restApiId: string): IRestApi {
     class Import extends Resource implements IRestApi {
       public readonly restApiId = restApiId;
-      public export(): RestApiAttributes { return { restApiId }; }
     }
 
     return new Import(scope, id);
@@ -237,16 +218,6 @@ export class RestApi extends Resource implements IRestApi {
     this.root = new RootResource(this, props, resource.restApiRootResourceId);
   }
 
-  /**
-   * Exports a REST API resource from this stack.
-   * @returns REST API props that can be imported to another stack.
-   */
-  public export(): RestApiAttributes {
-    return {
-      restApiId: new CfnOutput(this, 'RestApiId', { value: this.restApiId }).makeImportValue().toString()
-    };
-  }
-
   /**
    * The deployed root URL of this REST API.
    */

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.method.ts b/packages/@aws-cdk/aws-apigateway/test/test.method.ts
@@ -303,7 +303,7 @@ export = {
     // GIVEN
     const stack = new cdk.Stack();
     const api = new apigateway.RestApi(stack, 'test-api', { deploy: false });
-    const vpc = new ec2.VpcNetwork(stack, 'VPC');
+    const vpc = new ec2.Vpc(stack, 'VPC');
     const nlb = new elbv2.NetworkLoadBalancer(stack, 'NLB', {
       vpc
     });

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.restapi.ts b/packages/@aws-cdk/aws-apigateway/test/test.restapi.ts
@@ -1,4 +1,4 @@
-import { expect, haveResource, haveResourceLike, ResourcePart, SynthUtils } from '@aws-cdk/assert';
+import { expect, haveResource, haveResourceLike, ResourcePart } from '@aws-cdk/assert';
 import cdk = require('@aws-cdk/cdk');
 import { App, Stack } from '@aws-cdk/cdk';
 import { Test } from 'nodeunit';
@@ -328,25 +328,15 @@ export = {
     test.done();
   },
 
-  'import/export'(test: Test) {
+  'fromRestApiId'(test: Test) {
     // GIVEN
     const stack = new cdk.Stack();
 
     // WHEN
     const imported = apigateway.RestApi.fromRestApiId(stack, 'imported-api', 'api-rxt4498f');
-    const api = new apigateway.RestApi(stack, 'MyRestApi');
-    api.root.addMethod('GET');
-
-    const exported = api.export();
 
     // THEN
-    stack.node.prepareTree();
-    test.deepEqual(SynthUtils.toCloudFormation(stack).Outputs.MyRestApiRestApiIdB93C5C2D, {
-      Value: { Ref: 'MyRestApi2D1F47A9' },
-      Export: { Name: 'Stack:MyRestApiRestApiIdB93C5C2D' }
-    });
     test.deepEqual(imported.node.resolve(imported.restApiId), 'api-rxt4498f');
-    test.deepEqual(imported.node.resolve(exported), { restApiId: { 'Fn::ImportValue': 'Stack:MyRestApiRestApiIdB93C5C2D' } });
     test.done();
   },
 

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.vpc-link.ts b/packages/@aws-cdk/aws-apigateway/test/test.vpc-link.ts
@@ -9,7 +9,7 @@ export = {
   'default setup'(test: Test) {
     // GIVEN
     const stack = new cdk.Stack();
-    const vpc = new ec2.VpcNetwork(stack, 'VPC');
+    const vpc = new ec2.Vpc(stack, 'VPC');
     const nlb = new elbv2.NetworkLoadBalancer(stack, 'NLB', {
       vpc
     });

diff --git a/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts b/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts
@@ -148,7 +148,7 @@ export interface AutoScalingGroupProps extends CommonAutoScalingGroupProps {
   /**
    * VPC to launch these instances in.
    */
-  readonly vpc: ec2.IVpcNetwork;
+  readonly vpc: ec2.IVpc;
 
   /**
    * Type of instance to launch

diff --git a/packages/@aws-cdk/aws-autoscaling/test/integ.amazonlinux2.ts b/packages/@aws-cdk/aws-autoscaling/test/integ.amazonlinux2.ts
@@ -6,7 +6,7 @@ import autoscaling = require('../lib');
 const app = new cdk.App();
 const stack = new cdk.Stack(app, 'aws-cdk-autoscaling-integ');
 
-const vpc = new ec2.VpcNetwork(stack, 'VPC', {
+const vpc = new ec2.Vpc(stack, 'VPC', {
   maxAZs: 2
 });
 

diff --git a/packages/@aws-cdk/aws-autoscaling/test/integ.asg-w-classic-loadbalancer.ts b/packages/@aws-cdk/aws-autoscaling/test/integ.asg-w-classic-loadbalancer.ts
@@ -7,7 +7,7 @@ import autoscaling = require('../lib');
 const app = new cdk.App();
 const stack = new cdk.Stack(app, 'aws-cdk-asg-integ');
 
-const vpc = new ec2.VpcNetwork(stack, 'VPC', {
+const vpc = new ec2.Vpc(stack, 'VPC', {
   maxAZs: 3
 });
 

diff --git a/packages/@aws-cdk/aws-autoscaling/test/integ.asg-w-elbv2.ts b/packages/@aws-cdk/aws-autoscaling/test/integ.asg-w-elbv2.ts
@@ -7,7 +7,7 @@ import autoscaling = require('../lib');
 const app = new cdk.App();
 const stack = new cdk.Stack(app, 'aws-cdk-asg-integ');
 
-const vpc = new ec2.VpcNetwork(stack, 'VPC', {
+const vpc = new ec2.Vpc(stack, 'VPC', {
   maxAZs: 2
 });
 

diff --git a/packages/@aws-cdk/aws-autoscaling/test/integ.custom-scaling.ts b/packages/@aws-cdk/aws-autoscaling/test/integ.custom-scaling.ts
@@ -6,7 +6,7 @@ import autoscaling = require('../lib');
 const app = new cdk.App();
 const stack = new cdk.Stack(app, 'aws-cdk-autoscaling-integ');
 
-const vpc = new ec2.VpcNetwork(stack, 'VPC', {
+const vpc = new ec2.Vpc(stack, 'VPC', {
   maxAZs: 2
 });
 

diff --git a/packages/@aws-cdk/aws-autoscaling/test/integ.external-role.ts b/packages/@aws-cdk/aws-autoscaling/test/integ.external-role.ts
@@ -7,7 +7,7 @@ class TestStack extends cdk.Stack {
   constructor(scope: cdk.App, id: string) {
     super(scope, id);
 
-    const vpc = new ec2.VpcNetwork(this, 'VPC');
+    const vpc = new ec2.Vpc(this, 'VPC');
     const role = new iam.Role(this, 'Role', {
       assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com')
     });

diff --git a/packages/@aws-cdk/aws-autoscaling/test/test.auto-scaling-group.ts b/packages/@aws-cdk/aws-autoscaling/test/test.auto-scaling-group.ts
@@ -524,7 +524,7 @@ export = {
 };
 
 function mockVpc(stack: cdk.Stack) {
-  return ec2.VpcNetwork.import(stack, 'MyVpc', {
+  return ec2.Vpc.fromVpcAttributes(stack, 'MyVpc', {
     vpcId: 'my-vpc',
     availabilityZones: [ 'az1' ],
     publicSubnetIds: [ 'pub1' ],

diff --git a/packages/@aws-cdk/aws-autoscaling/test/test.lifecyclehooks.ts b/packages/@aws-cdk/aws-autoscaling/test/test.lifecyclehooks.ts
@@ -10,7 +10,7 @@ export = {
   'we can add a lifecycle hook to an ASG'(test: Test) {
     // GIVEN
     const stack = new cdk.Stack();
-    const vpc = new ec2.VpcNetwork(stack, 'VPC');
+    const vpc = new ec2.Vpc(stack, 'VPC');
     const asg = new autoscaling.AutoScalingGroup(stack, 'ASG', {
       vpc,
       instanceType: new ec2.InstanceTypePair(ec2.InstanceClass.M4, ec2.InstanceSize.Micro),

diff --git a/packages/@aws-cdk/aws-autoscaling/test/test.scaling.ts b/packages/@aws-cdk/aws-autoscaling/test/test.scaling.ts
@@ -224,13 +224,13 @@ export = {
 };
 
 class ASGFixture extends cdk.Construct {
-  public readonly vpc: ec2.VpcNetwork;
+  public readonly vpc: ec2.Vpc;
   public readonly asg: autoscaling.AutoScalingGroup;
 
   constructor(scope: cdk.Construct, id: string) {
     super(scope, id);
 
-    this.vpc = new ec2.VpcNetwork(this, 'VPC');
+    this.vpc = new ec2.Vpc(this, 'VPC');
     this.asg = new autoscaling.AutoScalingGroup(this, 'ASG', {
       vpc: this.vpc,
       instanceType: new ec2.InstanceTypePair(ec2.InstanceClass.M4, ec2.InstanceSize.Micro),

diff --git a/packages/@aws-cdk/aws-autoscaling/test/test.scheduled-action.ts b/packages/@aws-cdk/aws-autoscaling/test/test.scheduled-action.ts
@@ -104,7 +104,7 @@ export = {
 };
 
 function makeAutoScalingGroup(scope: cdk.Construct) {
-  const vpc = new ec2.VpcNetwork(scope, 'VPC');
+  const vpc = new ec2.Vpc(scope, 'VPC');
   return new autoscaling.AutoScalingGroup(scope, 'ASG', {
     vpc,
     instanceType: new ec2.InstanceType('t2.micro'),

diff --git a/packages/@aws-cdk/aws-certificatemanager/lib/certificate.ts b/packages/@aws-cdk/aws-certificatemanager/lib/certificate.ts
@@ -1,4 +1,4 @@
-import { CfnOutput, Construct, IResource, Resource } from '@aws-cdk/cdk';
+import { Construct, IResource, Resource } from '@aws-cdk/cdk';
 import { CfnCertificate } from './certificatemanager.generated';
 import { apexDomain } from './util';
 
@@ -9,21 +9,6 @@ export interface ICertificate extends IResource {
    * @attribute
    */
   readonly certificateArn: string;
-
-  /**
-   * Export this certificate from the stack
-   */
-  export(): CertificateAttributes;
-}
-
-/**
- * Reference to an existing Certificate
- */
-export interface CertificateAttributes {
-  /**
-   * The certificate's ARN
-   */
-  readonly certificateArn: string;
 }
 
 /**
@@ -79,9 +64,6 @@ export class Certificate extends Resource implements ICertificate {
   public static fromCertificateArn(scope: Construct, id: string, certificateArn: string): ICertificate {
     class Import extends Resource implements ICertificate {
       public certificateArn = certificateArn;
-      public export(): CertificateAttributes {
-        return { certificateArn };
-      }
     }
 
     return new Import(scope, id);
@@ -118,13 +100,4 @@ export class Certificate extends Resource implements ICertificate {
       };
     }
   }
-
-  /**
-   * Export this certificate from the stack
-   */
-  public export(): CertificateAttributes {
-    return {
-      certificateArn: new CfnOutput(this, 'Arn', { value: this.certificateArn }).makeImportValue().toString()
-    };
-  }
 }
diff --git a/packages/@aws-cdk/aws-certificatemanager/lib/dns-validated-certificate.ts b/packages/@aws-cdk/aws-certificatemanager/lib/dns-validated-certificate.ts
@@ -4,7 +4,7 @@ import lambda = require('@aws-cdk/aws-lambda');
 import route53 = require('@aws-cdk/aws-route53');
 import cdk = require('@aws-cdk/cdk');
 import path = require('path');
-import { CertificateAttributes, CertificateProps, ICertificate } from './certificate';
+import { CertificateProps, ICertificate } from './certificate';
 
 export interface DnsValidatedCertificateProps extends CertificateProps {
     /**
@@ -71,15 +71,6 @@ export class DnsValidatedCertificate extends cdk.Construct implements ICertifica
         this.certificateArn = certificate.getAtt('Arn').toString();
     }
 
-    /**
-     * Export this certificate from the stack
-     */
-    public export(): CertificateAttributes {
-        return {
-            certificateArn: new cdk.CfnOutput(this, 'Arn', { value: this.certificateArn }).makeImportValue().toString()
-        };
-    }
-
     protected validate(): string[] {
         const errors: string[] = [];
         // Ensure the zone name is a parent zone of the certificate domain name

diff --git a/packages/@aws-cdk/aws-certificatemanager/test/test.certificate.ts b/packages/@aws-cdk/aws-certificatemanager/test/test.certificate.ts
@@ -43,14 +43,14 @@ export = {
   },
 
   'export and import'(test: Test) {
+    // GIVEN
     const stack = new Stack();
 
-    const refProps = new Certificate(stack, 'Cert', {
-      domainName: 'hello.com',
-    }).export();
-
-    Certificate.fromCertificateArn(stack, 'Imported', refProps.certificateArn);
+    // WHEN
+    const c = Certificate.fromCertificateArn(stack, 'Imported', 'cert-arn');
 
+    // THEN
+    test.deepEqual(c.certificateArn, 'cert-arn');
     test.done();
   }
 };
diff --git a/packages/@aws-cdk/aws-certificatemanager/test/test.dns-validated-certificate.ts b/packages/@aws-cdk/aws-certificatemanager/test/test.dns-validated-certificate.ts
@@ -80,22 +80,6 @@ export = {
     test.done();
   },
 
-  'export and import'(test: Test) {
-    const stack = new Stack();
-
-    const helloDotComZone = new PublicHostedZone(stack, 'HelloDotCom', {
-      zoneName: 'hello.com'
-    });
-
-    const refProps = new DnsValidatedCertificate(stack, 'Cert', {
-      domainName: 'hello.com',
-      hostedZone: helloDotComZone,
-    }).export();
-
-    test.ok('certificateArn' in refProps);
-    test.done();
-  },
-
   'adds validation error on domain mismatch'(test: Test) {
     const stack = new Stack();
 

diff --git a/packages/@aws-cdk/aws-cloudtrail/lib/index.ts b/packages/@aws-cdk/aws-cloudtrail/lib/index.ts
@@ -2,13 +2,13 @@ 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 cdk = require('@aws-cdk/cdk');
+import { Construct, Resource } from '@aws-cdk/cdk';
 import { CfnTrail } from './cloudtrail.generated';
 
 // AWS::CloudTrail CloudFormation Resources:
 export * from './cloudtrail.generated';
 
-export interface CloudTrailProps {
+export interface TrailProps {
   /**
    * For most services, events are recorded in the region where the action occurred.
    * For global services such as AWS Identity and Access Management (IAM), AWS STS, Amazon CloudFront, and Route 53,
@@ -65,7 +65,7 @@ export interface CloudTrailProps {
   /** The AWS Key Management Service (AWS KMS) key ID that you want to use to encrypt CloudTrail logs.
    * @default none
    */
-  readonly kmsKey?: kms.IEncryptionKey;
+  readonly kmsKey?: kms.IKey;
 
   /** The name of an Amazon SNS topic that is notified when new log files are published.
    * @default none
@@ -99,12 +99,21 @@ export enum ReadWriteType {
  * const cloudTrail = new CloudTrail(this, 'MyTrail');
  *
  */
-export class CloudTrail extends cdk.Construct {
+export class Trail extends Resource {
+
+  /**
+   * @attribute
+   */
+  public readonly trailArn: string;
+
+  /**
+   * @attribute
+   */
+  public readonly trailSnsTopicArn: string;
 
-  public readonly cloudTrailArn: string;
   private eventSelectors: EventSelector[] = [];
 
-  constructor(scope: cdk.Construct, id: string, props: CloudTrailProps = {}) {
+  constructor(scope: Construct, id: string, props: TrailProps = {}) {
     super(scope, id);
 
     const s3bucket = new s3.Bucket(this, 'S3', {encryption: s3.BucketEncryption.Unencrypted});
@@ -157,7 +166,10 @@ export class CloudTrail extends cdk.Construct {
       snsTopicName: props.snsTopic,
       eventSelectors: this.eventSelectors
     });
-    this.cloudTrailArn = trail.trailArn;
+
+    this.trailArn = trail.trailArn;
+    this.trailSnsTopicArn = trail.trailSnsTopicArn;
+
     const s3BucketPolicy = s3bucket.node.findChild("Policy").node.findChild("Resource") as s3.CfnBucketPolicy;
     trail.node.addDependency(s3BucketPolicy);
 

diff --git a/packages/@aws-cdk/aws-cloudtrail/test/integ.cloudtrail.lit.ts b/packages/@aws-cdk/aws-cloudtrail/test/integ.cloudtrail.lit.ts
@@ -7,7 +7,7 @@ const stack = new cdk.Stack(app, 'integ-cloudtrail');
 
 const bucket = new s3.Bucket(stack, 'Bucket', { removalPolicy: cdk.RemovalPolicy.Destroy });
 
-const trail = new cloudtrail.CloudTrail(stack, 'Trail');
+const trail = new cloudtrail.Trail(stack, 'Trail');
 trail.addS3EventSelector([bucket.arnForObjects('')]);
 
 app.run();