feat(events): better modeling of CW Event Targets

packages/@aws-cdk/aws-apigateway/lib/deployment.ts

@@ -91,51 +91,13 @@ export class Deployment extends Resource {
 }
 
 class LatestDeploymentResource extends CfnDeployment {
-  private originalLogicalId?: string;
-  private lazyLogicalIdRequired: boolean;
-  private lazyLogicalId?: string;
-  private logicalIdToken: Token;
   private hashComponents = new Array<any>();
+  private originalLogicalId: string;
 
   constructor(scope: 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 Token(() => this.lazyLogicalId);
-  }
-
-  /**
-   * Returns either the original or the custom logical ID of this resource.
-   */
-  public get logicalId() {
-    if (!this.lazyLogicalIdRequired) {
-      return this.originalLogicalId!;
-    }
-
-    return this.logicalIdToken.toString();
-  }
-
-  /**
-   * Sets the logical ID of this resource.
-   */
-  public set logicalId(v: string) {
-    this.originalLogicalId = v;
-  }
-
-  /**
-   * Returns a lazy reference to this resource (evaluated only upon synthesis).
-   */
-  public get ref() {
-    return new Token(() => ({ Ref: this.lazyLogicalId })).toString();
-  }
-
-  /**
-   * Does nothing.
-   */
-  public set ref(_v: string) {
-    return;
+    this.originalLogicalId = this.node.stack.logicalIds.getLogicalId(this);
   }
 
   /**
@@ -159,15 +121,13 @@ class LatestDeploymentResource extends CfnDeployment {
   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 {
+    if (this.hashComponents.length > 0) {
       const md5 = crypto.createHash('md5');
       this.hashComponents
         .map(c => this.node.resolve(c))
         .forEach(c => md5.update(JSON.stringify(c)));
 
-      this.lazyLogicalId = this.originalLogicalId + md5.digest("hex");
+      this.overrideLogicalId(this.originalLogicalId + md5.digest("hex"));
     }
 
     super.prepare();

packages/@aws-cdk/aws-cloudtrail/lib/index.ts

@@ -1,3 +1,4 @@
+import events = require('@aws-cdk/aws-events');
 import iam = require('@aws-cdk/aws-iam');
 import kms = require('@aws-cdk/aws-kms');
 import logs = require('@aws-cdk/aws-logs');
@@ -209,6 +210,21 @@ export class Trail extends Resource {
       }]
     });
   }
+
+  /**
+   * Create an event rule for when an event is recorded by any trail.
+   *
+   * Note that the event doesn't necessarily have to come from this
+   * trail. Be sure to filter the event properly using an event pattern.
+   */
+  public onEvent(name: string, target?: events.IRuleTarget, options?: events.RuleProps) {
+    const rule = new events.Rule(this, name, options);
+    rule.addTarget(target);
+    rule.addEventPattern({
+      detailType: ['AWS API Call via CloudTrail']
+    });
+    return rule;
+  }
 }
 
 /**

packages/@aws-cdk/aws-cloudtrail/package.json

@@ -67,6 +67,7 @@
     "pkglint": "^0.31.0"
   },
   "dependencies": {
+    "@aws-cdk/aws-events": "^0.31.0",
     "@aws-cdk/aws-iam": "^0.31.0",
     "@aws-cdk/aws-kms": "^0.31.0",
     "@aws-cdk/aws-logs": "^0.31.0",
@@ -75,6 +76,7 @@
   },
   "homepage": "https://github.com/awslabs/aws-cdk",
   "peerDependencies": {
+    "@aws-cdk/aws-events": "^0.31.0",
     "@aws-cdk/aws-iam": "^0.31.0",
     "@aws-cdk/aws-kms": "^0.31.0",
     "@aws-cdk/aws-logs": "^0.31.0",

packages/@aws-cdk/aws-cloudtrail/test/test.cloudtrail.ts

@@ -189,7 +189,39 @@ export = {
         test.done();
       },
     }
-  }
+  },
+
+  'add an event rule'(test: Test) {
+    // GIVEN
+    const stack = getTestStack();
+    const trail = new Trail(stack, 'MyAmazingCloudTrail', { managementEvents: ReadWriteType.WriteOnly });
+
+    // WHEN
+    trail.onEvent('DoEvents', {
+      bind: () => ({
+        arn: 'arn',
+        id: 'myid'
+      })
+    });
+
+    // THEN
+    expect(stack).to(haveResource('AWS::Events::Rule', {
+      EventPattern: {
+        "detail-type": [
+          "AWS API Call via CloudTrail"
+        ]
+      },
+      State: "ENABLED",
+      Targets: [
+        {
+          Arn: "arn",
+          Id: "myid"
+        }
+      ]
+    }));
+
+    test.done();
+  },
 };
 
 function getTestStack(): Stack {

packages/@aws-cdk/aws-codebuild/lib/events.ts

@@ -0,0 +1,88 @@
+import events = require('@aws-cdk/aws-events');
+
+/**
+ * Event fields for the CodeBuild "state change" event
+ *
+ * @see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html#sample-build-notifications-ref
+ */
+export class StateChangeEvent {
+  /**
+   * The triggering build's status
+   */
+  public static get buildStatus() {
+    return events.EventField.fromPath('$.detail.build-status');
+  }
+
+  /**
+   * The triggering build's project name
+   */
+  public static get projectName() {
+    return events.EventField.fromPath('$.detail.project-name');
+  }
+
+  /**
+   * Return the build id
+   */
+  public static get buildId() {
+    return events.EventField.fromPath('$.detail.build-id');
+  }
+
+  public static get currentPhase() {
+    return events.EventField.fromPath('$.detail.current-phase');
+  }
+
+  private constructor() {
+  }
+}
+
+/**
+ * Event fields for the CodeBuild "phase change" event
+ *
+ * @see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html#sample-build-notifications-ref
+ */
+export class PhaseChangeEvent {
+  /**
+   * The triggering build's project name
+   */
+  public static get projectName() {
+    return events.EventField.fromPath('$.detail.project-name');
+  }
+
+  /**
+   * The triggering build's id
+   */
+  public static get buildId() {
+    return events.EventField.fromPath('$.detail.build-id');
+  }
+
+  /**
+   * The phase that was just completed
+   */
+  public static get completedPhase() {
+    return events.EventField.fromPath('$.detail.completed-phase');
+  }
+
+  /**
+   * The status of the completed phase
+   */
+  public static get completedPhaseStatus() {
+    return events.EventField.fromPath('$.detail.completed-phase-status');
+  }
+
+  /**
+   * The duration of the completed phase
+   */
+  public static get completedPhaseDurationSeconds() {
+    return events.EventField.fromPath('$.detail.completed-phase-duration-seconds');
+  }
+
+  /**
+   * Whether the build is complete
+   */
+  public static get buildComplete() {
+    return events.EventField.fromPath('$.detail.build-complete');
+  }
+
+  private constructor() {
+  }
+}

packages/@aws-cdk/aws-codebuild/lib/index.ts

@@ -1,3 +1,4 @@
+export * from './events';
 export * from './pipeline-project';
 export * from './project';
 export * from './source';

packages/@aws-cdk/aws-codebuild/lib/project.ts

@@ -52,32 +52,35 @@ export interface IProject extends IResource, iam.IGrantable {
    * You can also use the methods `onBuildFailed` and `onBuildSucceeded` to define rules for
    * these specific state changes.
    *
+   * To access fields from the event in the event target input,
+   * use the static fields on the `StateChangeEvent` class.
+   *
    * @see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html
    */
-  onStateChange(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps): events.EventRule;
+  onStateChange(name: string, target?: events.IRuleTarget, options?: events.RuleProps): events.Rule;
 
   /**
    * Defines a CloudWatch event rule that triggers upon phase change of this
    * build project.
    *
    * @see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html
    */
-  onPhaseChange(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps): events.EventRule;
+  onPhaseChange(name: string, target?: events.IRuleTarget, options?: events.RuleProps): events.Rule;
 
   /**
    * Defines an event rule which triggers when a build starts.
    */
-  onBuildStarted(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps): events.EventRule;
+  onBuildStarted(name: string, target?: events.IRuleTarget, options?: events.RuleProps): events.Rule;
 
   /**
    * Defines an event rule which triggers when a build fails.
    */
-  onBuildFailed(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps): events.EventRule;
+  onBuildFailed(name: string, target?: events.IRuleTarget, options?: events.RuleProps): events.Rule;
 
   /**
    * Defines an event rule which triggers when a build completes successfully.
    */
-  onBuildSucceeded(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps): events.EventRule;
+  onBuildSucceeded(name: string, target?: events.IRuleTarget, options?: events.RuleProps): events.Rule;
 
   /**
    * @returns a CloudWatch metric associated with this build project.
@@ -174,10 +177,13 @@ abstract class ProjectBase extends Resource implements IProject {
    * You can also use the methods `onBuildFailed` and `onBuildSucceeded` to define rules for
    * these specific state changes.
    *
+   * To access fields from the event in the event target input,
+   * use the static fields on the `StateChangeEvent` class.
+   *
    * @see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html
    */
-  public onStateChange(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps) {
-    const rule = new events.EventRule(this, name, options);
+  public onStateChange(name: string, target?: events.IRuleTarget, options?: events.RuleProps) {
+    const rule = new events.Rule(this, name, options);
     rule.addTarget(target);
     rule.addEventPattern({
       source: ['aws.codebuild'],
@@ -197,8 +203,8 @@ abstract class ProjectBase extends Resource implements IProject {
    *
    * @see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html
    */
-  public onPhaseChange(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps) {
-    const rule = new events.EventRule(this, name, options);
+  public onPhaseChange(name: string, target?: events.IRuleTarget, options?: events.RuleProps) {
+    const rule = new events.Rule(this, name, options);
     rule.addTarget(target);
     rule.addEventPattern({
       source: ['aws.codebuild'],
@@ -214,8 +220,11 @@ abstract class ProjectBase extends Resource implements IProject {
 
   /**
    * Defines an event rule which triggers when a build starts.
+   *
+   * To access fields from the event in the event target input,
+   * use the static fields on the `StateChangeEvent` class.
    */
-  public onBuildStarted(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps) {
+  public onBuildStarted(name: string, target?: events.IRuleTarget, options?: events.RuleProps) {
     const rule = this.onStateChange(name, target, options);
     rule.addEventPattern({
       detail: {
@@ -227,8 +236,11 @@ abstract class ProjectBase extends Resource implements IProject {
 
   /**
    * Defines an event rule which triggers when a build fails.
+   *
+   * To access fields from the event in the event target input,
+   * use the static fields on the `StateChangeEvent` class.
    */
-  public onBuildFailed(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps) {
+  public onBuildFailed(name: string, target?: events.IRuleTarget, options?: events.RuleProps) {
     const rule = this.onStateChange(name, target, options);
     rule.addEventPattern({
       detail: {
@@ -240,8 +252,11 @@ abstract class ProjectBase extends Resource implements IProject {
 
   /**
    * Defines an event rule which triggers when a build completes successfully.
+   *
+   * To access fields from the event in the event target input,
+   * use the static fields on the `StateChangeEvent` class.
    */
-  public onBuildSucceeded(name: string, target?: events.IEventRuleTarget, options?: events.EventRuleProps) {
+  public onBuildSucceeded(name: string, target?: events.IRuleTarget, options?: events.RuleProps) {
     const rule = this.onStateChange(name, target, options);
     rule.addEventPattern({
       detail: {