fix(aws-logs): add export()/import() capabilities

LogGroups and LogStreams can now be exported and imported. ALSO IN THIS COMMIT - All exports() for other resources would run afoul of ClassCastException in Java. Wrap all `FnImportValue`s in the right type to avoid this. - The addition of some convenience methods to the `Arn` class flushed out a number of places where we were using some other `Token`-derived value in places where `Arn`s were expected.
aws · rix0rrr · Sep 3, 2018 · Aug 27, 2018 · Aug 27, 2018 · Aug 27, 2018
commit b2042c21d85250dd3e6a59eb584a0658b7325bcb
diff --git a/packages/@aws-cdk/aws-certificatemanager/lib/certificate-ref.ts b/packages/@aws-cdk/aws-certificatemanager/lib/certificate-ref.ts
@@ -19,7 +19,7 @@ export abstract class CertificateRef extends Construct {
      */
     public export(): CertificateRefProps {
         return {
-            certificateArn: new Output(this, 'Arn', { value: this.certificateArn }).makeImportValue()
+            certificateArn: new CertificateArn(new Output(this, 'Arn', { value: this.certificateArn }).makeImportValue())
         };
     }
 }

diff --git a/packages/@aws-cdk/aws-cloudtrail/lib/index.ts b/packages/@aws-cdk/aws-cloudtrail/lib/index.ts
@@ -147,11 +147,11 @@ export class CloudTrail extends cdk.Construct {
             const logGroup = new logs.cloudformation.LogGroupResource(this, "LogGroup", {
                 retentionInDays: props.cloudWatchLogsRetentionTimeDays || LogRetention.OneYear
             });
-            this.cloudWatchLogsGroupArn = logGroup.ref;
+            this.cloudWatchLogsGroupArn = logGroup.logGroupArn;
 
             const logsRole = new iam.Role(this, 'LogsRole', {assumedBy: new cdk.ServicePrincipal(cloudTrailPrincipal) });
 
-            const streamArn = new cdk.FnConcat(this.cloudWatchLogsGroupArn, ":log-stream:*");
+            const streamArn = new cdk.Arn(new cdk.FnConcat(this.cloudWatchLogsGroupArn, ":log-stream:*"));
             logsRole.addToPolicy(new cdk.PolicyStatement()
                 .addActions("logs:PutLogEvents", "logs:CreateLogStream")
                 .addResource(streamArn));

diff --git a/packages/@aws-cdk/aws-codebuild/lib/project.ts b/packages/@aws-cdk/aws-codebuild/lib/project.ts
@@ -71,7 +71,7 @@ export abstract class ProjectRef extends cdk.Construct implements events.IEventR
      */
     public export(): ProjectRefProps {
         return {
-            projectName: new cdk.Output(this, 'ProjectName', { value: this.projectName }).makeImportValue(),
+            projectName: new ProjectName(new cdk.Output(this, 'ProjectName', { value: this.projectName }).makeImportValue()),
         };
     }
 
@@ -463,7 +463,7 @@ export class Project extends ProjectRef {
             resourceName: new cdk.FnConcat('/aws/codebuild/', this.projectName),
         });
 
-        const logGroupStarArn = new cdk.FnConcat(logGroupArn, ':*');
+        const logGroupStarArn = new cdk.Arn(new cdk.FnConcat(logGroupArn, ':*'));
 
         const p = new cdk.PolicyStatement();
         p.allow();

diff --git a/packages/@aws-cdk/aws-codecommit/lib/repository.ts b/packages/@aws-cdk/aws-codecommit/lib/repository.ts
@@ -49,7 +49,7 @@ export abstract class RepositoryRef extends cdk.Construct {
      */
     public export(): RepositoryRefProps {
         return {
-            repositoryName: new cdk.Output(this, 'RepositoryName', { value: this.repositoryName }).makeImportValue(),
+            repositoryName: new RepositoryName(new cdk.Output(this, 'RepositoryName', { value: this.repositoryName }).makeImportValue()),
         };
     }
 

diff --git a/packages/@aws-cdk/aws-ec2/lib/security-group.ts b/packages/@aws-cdk/aws-ec2/lib/security-group.ts
@@ -63,7 +63,7 @@ export abstract class SecurityGroupRef extends Construct implements ISecurityGro
      */
     public export(): SecurityGroupRefProps {
         return {
-            securityGroupId: new Output(this, 'SecurityGroupId', { value: this.securityGroupId }).makeImportValue()
+            securityGroupId: new SecurityGroupId(new Output(this, 'SecurityGroupId', { value: this.securityGroupId }).makeImportValue())
         };
     }
 

diff --git a/packages/@aws-cdk/aws-ec2/lib/vpc-ref.ts b/packages/@aws-cdk/aws-ec2/lib/vpc-ref.ts
@@ -61,12 +61,14 @@ export abstract class VpcNetworkRef extends Construct implements IDependable {
      * Export this VPC from the stack
      */
     public export(): VpcNetworkRefProps {
+        // tslint:disable:max-line-length
         return {
-            vpcId: new Output(this, 'VpcId', { value: this.vpcId }).makeImportValue(),
+            vpcId: new VPCId(new Output(this, 'VpcId', { value: this.vpcId }).makeImportValue()),
             availabilityZones: this.publicSubnets.map(s => s.availabilityZone),
-            publicSubnetIds: new StringListOutput(this, 'PublicSubnetIDs', { values: this.publicSubnets.map(s => s.subnetId) }).makeImportValues(),
-            privateSubnetIds: new StringListOutput(this, 'PrivateSubnetIDs', { values: this.privateSubnets.map(s => s.subnetId) }).makeImportValues(),
+            publicSubnetIds: new StringListOutput(this, 'PublicSubnetIDs', { values: this.publicSubnets.map(s => s.subnetId) }).makeImportValues().map(x => new SubnetId(x)),
+            privateSubnetIds: new StringListOutput(this, 'PrivateSubnetIDs', { values: this.privateSubnets.map(s => s.subnetId) }).makeImportValues().map(x => new SubnetId(x)),
         };
+        // tslint:enable:max-line-length
     }
 }
 

diff --git a/packages/@aws-cdk/aws-events/lib/rule-ref.ts b/packages/@aws-cdk/aws-events/lib/rule-ref.ts
@@ -29,7 +29,7 @@ export abstract class EventRuleRef extends Construct {
      */
     public export(): EventRuleRefProps {
         return {
-            eventRuleArn: new Output(this, 'RuleArn', { value: this.ruleArn }).makeImportValue()
+            eventRuleArn: new RuleArn(new Output(this, 'RuleArn', { value: this.ruleArn }).makeImportValue())
         };
     }
 }

diff --git a/packages/@aws-cdk/aws-kinesis/lib/stream.ts b/packages/@aws-cdk/aws-kinesis/lib/stream.ts
@@ -75,15 +75,10 @@ export abstract class StreamRef extends cdk.Construct implements logs.ILogSubscr
      * Exports this stream from the stack.
      */
     public export(): StreamRefProps {
-        const streamArn = new cdk.Output(this, 'StreamArn', { value: this.streamArn }).makeImportValue();
-        if (this.encryptionKey) {
-            return {
-                streamArn,
-                encryptionKey: this.encryptionKey.export()
-            };
-        } else {
-            return { streamArn };
-        }
+        return {
+            streamArn: new StreamArn(new cdk.Output(this, 'StreamArn', { value: this.streamArn }).makeImportValue()),
+            encryptionKey: this.encryptionKey ? this.encryptionKey.export() : undefined,
+        };
     }
 
     /**

diff --git a/packages/@aws-cdk/aws-kms/lib/key.ts b/packages/@aws-cdk/aws-kms/lib/key.ts
@@ -74,7 +74,7 @@ export abstract class EncryptionKeyRef extends Construct {
      */
     public export(): EncryptionKeyRefProps {
         return {
-            keyArn: new Output(this, 'KeyArn').makeImportValue()
+            keyArn: new KeyArn(new Output(this, 'KeyArn').makeImportValue())
         };
     }
 }

diff --git a/packages/@aws-cdk/aws-kms/test/integ.key.ts b/packages/@aws-cdk/aws-kms/test/integ.key.ts
@@ -1,4 +1,4 @@
-import { App, AwsAccountId, PolicyStatement, Stack } from '@aws-cdk/cdk';
+import { App, Arn, AwsAccountId, PolicyStatement, Stack } from '@aws-cdk/cdk';
 import { EncryptionKey } from '../lib';
 
 const app = new App(process.argv);
@@ -10,7 +10,7 @@ const key = new EncryptionKey(stack, 'MyKey');
 key.addToResourcePolicy(new PolicyStatement()
     .addAllResources()
     .addAction('kms:encrypt')
-    .addAwsPrincipal(new AwsAccountId()));
+    .addAwsPrincipal(new Arn(new AwsAccountId())));
 
 key.addAlias('alias/bar');
 

diff --git a/packages/@aws-cdk/aws-lambda/lib/lambda-ref.ts b/packages/@aws-cdk/aws-lambda/lib/lambda-ref.ts
@@ -260,7 +260,7 @@ export abstract class FunctionRef extends cdk.Construct
      */
     public export(): FunctionRefProps {
         return {
-            functionArn: new cdk.Output(this, 'FunctionArn', { value: this.functionArn }).makeImportValue(),
+            functionArn: new FunctionArn(new cdk.Output(this, 'FunctionArn', { value: this.functionArn }).makeImportValue()),
         };
     }
 

diff --git a/packages/@aws-cdk/aws-logs/lib/log-group.ts b/packages/@aws-cdk/aws-logs/lib/log-group.ts
@@ -6,7 +6,87 @@ import { IFilterPattern } from './pattern';
 import { ILogSubscriptionDestination, SubscriptionFilter } from './subscription-filter';
 
 /**
- * Properties for a new LogGroup
+ * Properties for importing a LogGroup
+ */
+export interface LogGroupRefProps {
+    logGroupArn: LogGroupArn;
+}
+
+/**
+ * An CloudWatch Log Group
+ */
+export abstract class LogGroupRef extends cdk.Construct {
+    /**
+     * Import an existing LogGroup
+     */
+    public static import(parent: cdk.Construct, id: string, props: LogGroupRefProps): LogGroupRef {
+        return new ImportedLogGroup(parent, id, props);
+    }
+
+    /**
+     * The ARN of this log group
+     */
+    public abstract readonly logGroupArn: LogGroupArn;
+
+    /**
+     * The name of this log group
+     */
+    public abstract readonly logGroupName: LogGroupName;
+
+    /**
+     * Create a new Log Stream for this Log Group
+     *
+     * @param parent Parent construct
+     * @param id Unique identifier for the construct in its parent
+     * @param props Properties for creating the LogStream
+     */
+    public newStream(parent: cdk.Construct, id: string, props: NewLogStreamProps = {}): LogStream {
+        return new LogStream(parent, id, {
+            logGroup: this,
+            ...props
+        });
+    }
+
+    /**
+     * Create a new Subscription Filter on this Log Group
+     *
+     * @param parent Parent construct
+     * @param id Unique identifier for the construct in its parent
+     * @param props Properties for creating the SubscriptionFilter
+     */
+    public newSubscriptionFilter(parent: cdk.Construct, id: string, props: NewSubscriptionFilterProps): SubscriptionFilter {
+        return new SubscriptionFilter(parent, id, {
+            logGroup: this,
+            ...props
+        });
+    }
+
+    /**
+     * Create a new Metric Filter on this Log Group
+     *
+     * @param parent Parent construct
+     * @param id Unique identifier for the construct in its parent
+     * @param props Properties for creating the MetricFilter
+     */
+    public newMetricFilter(parent: cdk.Construct, id: string, props: NewMetricFilterProps): MetricFilter {
+        return new MetricFilter(parent, id, {
+            logGroup: this,
+            ...props
+        });
+    }
+
+    /**
+     * Export this LogGroup
+     */
+    public export(): LogGroupRefProps {
+        return {
+            logGroupArn: new LogGroupArn(new cdk.Output(this, 'LogGroupArn', { value: this.logGroupArn }).makeImportValue())
+        };
+    }
+}
+
+/**
+ * Properties for a LogGroup
  */
 export interface LogGroupProps {
     /**
@@ -39,9 +119,9 @@ export interface LogGroupProps {
 }
 
 /**
- * A new CloudWatch Log Group
+ * Define a CloudWatch Log Group
  */
-export class LogGroup extends cdk.Construct {
+export class LogGroup extends LogGroupRef {
     /**
      * The ARN of this log group
      */
@@ -75,47 +155,27 @@ export class LogGroup extends cdk.Construct {
         this.logGroupArn = resource.logGroupArn;
         this.logGroupName = resource.ref;
     }
+}
 
+/**
+ * An imported CloudWatch Log Group
+ */
+class ImportedLogGroup extends LogGroupRef {
     /**
-     * Create a new Log Stream for this Log Group
-     *
-     * @param parent Parent construct
-     * @param id Unique identifier for the construct in its parent
-     * @param props Properties for creating the LogStream
+     * The ARN of this log group
      */
-    public newStream(parent: cdk.Construct, id: string, props: NewLogStreamProps = {}): LogStream {
-        return new LogStream(parent, id, {
-            logGroup: this,
-            ...props
-        });
-    }
+    public readonly logGroupArn: LogGroupArn;
 
     /**
-     * Create a new Subscription Filter on this Log Group
-     *
-     * @param parent Parent construct
-     * @param id Unique identifier for the construct in its parent
-     * @param props Properties for creating the SubscriptionFilter
+     * The name of this log group
      */
-    public newSubscriptionFilter(parent: cdk.Construct, id: string, props: NewSubscriptionFilterProps): SubscriptionFilter {
-        return new SubscriptionFilter(parent, id, {
-            logGroup: this,
-            ...props
-        });
-    }
+    public readonly logGroupName: LogGroupName;
 
-    /**
-     * Create a new Metric Filter on this Log Group
-     *
-     * @param parent Parent construct
-     * @param id Unique identifier for the construct in its parent
-     * @param props Properties for creating the MetricFilter
-     */
-    public newMetricFilter(parent: cdk.Construct, id: string, props: NewMetricFilterProps): MetricFilter {
-        return new MetricFilter(parent, id, {
-            logGroup: this,
-            ...props
-        });
+    constructor(parent: cdk.Construct, id: string, props: LogGroupRefProps) {
+        super(parent, id);
+
+        this.logGroupArn = props.logGroupArn;
+        this.logGroupName = new LogGroupName(props.logGroupArn.resourceNameComponent(':'));
     }
 }
 

diff --git a/packages/@aws-cdk/aws-logs/lib/log-stream.ts b/packages/@aws-cdk/aws-logs/lib/log-stream.ts
@@ -3,7 +3,40 @@ import { LogGroup } from './log-group';
 import { cloudformation, LogStreamName } from './logs.generated';
 
 /**
- * Properties for a new LogStream
+ * Properties for importing a LogStream
+ */
+export interface LogStreamRefProps {
+    logStreamName: LogStreamName;
+}
+
+/**
+ * A Log Stream in a Log Group
+ */
+export abstract class LogStreamRef extends cdk.Construct {
+    /**
+     * Import an existing LogGroup
+     */
+    public static import(parent: cdk.Construct, id: string, props: LogStreamRefProps): LogStreamRef {
+        return new ImportedLogStream(parent, id, props);
+    }
+
+    /**
+     * The name of this log stream
+     */
+    public abstract readonly logStreamName: LogStreamName;
+
+    /**
+     * Export this LogStream
+     */
+    public export(): LogStreamRefProps {
+        return {
+            logStreamName: new LogStreamName(new cdk.Output(this, 'LogStreamName', { value: this.logStreamName }).makeImportValue())
+        };
+    }
+}
+
+/**
+ * Properties for a LogStream
  */
 export interface LogStreamProps {
     /**
@@ -35,9 +68,9 @@ export interface LogStreamProps {
 }
 
 /**
- * A new Log Stream in a Log Group
+ * Define a Log Stream in a Log Group
  */
-export class LogStream extends cdk.Construct {
+export class LogStream extends LogStreamRef {
     /**
      * The name of this log stream
      */
@@ -57,4 +90,20 @@ export class LogStream extends cdk.Construct {
 
         this.logStreamName = resource.ref;
     }
+}
+
+/**
+ * An imported LogStream
+ */
+class ImportedLogStream extends LogStreamRef {
+    /**
+     * The name of this log stream
+     */
+    public readonly logStreamName: LogStreamName;
+
+    constructor(parent: cdk.Construct, id: string, props: LogStreamRefProps) {
+        super(parent, id);
+
+        this.logStreamName = props.logStreamName;
+    }
 }