feat(aws-lambda-event-sources): add optional disabled event source ma…

…pping options parameter to supported event sources in Lambda closes #5750
aws · Mar 2, 2020 · 45e4d4c · 45e4d4c
1 parent cfea360
commit 45e4d4c
Show file tree

Hide file tree

Showing 13 changed files with 126 additions and 10 deletions.
diff --git a/packages/@aws-cdk/aws-lambda-event-sources/README.md b/packages/@aws-cdk/aws-lambda-event-sources/README.md
@@ -53,6 +53,7 @@ behavior:
 * __receiveMessageWaitTime__: Will determine [long
   poll](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html)
   duration. The default value is 20 seconds.
+* __enabled__: Disables or enables the event source mapping to pause/start polling and invocation.
 
 ```ts
 import sqs = require('@aws-cdk/aws-sqs');
@@ -137,6 +138,7 @@ and add it to your Lambda function. The following parameters will impact Amazon
 
 * __batchSize__: Determines how many records are buffered before invoking your lambda function - could impact your function's memory usage (if too high) and ability to keep up with incoming data velocity (if too low).
 * __startingPosition__: Will determine where to being consumption, either at the most recent ('LATEST') record or the oldest record ('TRIM_HORIZON'). 'TRIM_HORIZON' will ensure you process all available data, while 'LATEST' will ignore all records that arrived prior to attaching the event source.
+* __enabled__: Disables or enables the event source mapping to pause/start polling and invocation.
 
 ```ts
 import dynamodb = require('@aws-cdk/aws-dynamodb');
@@ -167,6 +169,7 @@ behavior:
 
 * __batchSize__: Determines how many records are buffered before invoking your lambda function - could impact your function's memory usage (if too high) and ability to keep up with incoming data velocity (if too low).
 * __startingPosition__: Will determine where to being consumption, either at the most recent ('LATEST') record or the oldest record ('TRIM_HORIZON'). 'TRIM_HORIZON' will ensure you process all available data, while 'LATEST' will ignore all records that arrived prior to attaching the event source.
+* __enabled__: Disables or enables the event source mapping to pause/start polling and invocation.
 
 ```ts
 import lambda = require('@aws-cdk/aws-lambda');

diff --git a/packages/@aws-cdk/aws-lambda-event-sources/lib/sqs.ts b/packages/@aws-cdk/aws-lambda-event-sources/lib/sqs.ts
@@ -12,6 +12,13 @@ export interface SqsEventSourceProps {
    * @default 10
    */
   readonly batchSize?: number;
+
+  /**
+   * Disables the event source mapping to pause polling and invocation.
+   *
+   * @default true
+   */
+  readonly enabled?: boolean;
 }
 
 /**
@@ -30,6 +37,7 @@ export class SqsEventSource implements lambda.IEventSource {
     const eventSourceMapping = target.addEventSourceMapping(`SqsEventSource:${this.queue.node.uniqueId}`, {
       batchSize: this.props.batchSize,
       eventSourceArn: this.queue.queueArn,
+      enabled: this.props.enabled
     });
     this._eventSourceMappingId = eventSourceMapping.eventSourceMappingId;
 

diff --git a/packages/@aws-cdk/aws-lambda-event-sources/lib/stream.ts b/packages/@aws-cdk/aws-lambda-event-sources/lib/stream.ts
@@ -33,6 +33,13 @@ export interface StreamEventSourceProps {
    * @default Duration.seconds(0)
    */
   readonly maxBatchingWindow?: Duration;
+
+  /**
+   * Disables the event source mapping to pause polling and invocation.
+   *
+   * @default true
+   */
+  readonly enabled?: boolean;
 }
 
 /**
@@ -50,6 +57,7 @@ export abstract class StreamEventSource implements lambda.IEventSource {
       batchSize: this.props.batchSize || 100,
       startingPosition: this.props.startingPosition,
       maxBatchingWindow: this.props.maxBatchingWindow,
+      enabled: this.props.enabled
     };
   }
 }
diff --git a/packages/@aws-cdk/aws-lambda-event-sources/test/integ.dynamodb.expected.json b/packages/@aws-cdk/aws-lambda-event-sources/test/integ.dynamodb.expected.json
@@ -112,6 +112,7 @@
           "Ref": "FC4345940"
         },
         "BatchSize": 5,
+        "Enabled": false,
         "StartingPosition": "TRIM_HORIZON"
       }
     },
@@ -138,8 +139,8 @@
           "StreamViewType": "NEW_IMAGE"
         }
       },
-      "DeletionPolicy": "Delete",
-      "UpdateReplacePolicy": "Delete"
+      "UpdateReplacePolicy": "Delete",
+      "DeletionPolicy": "Delete"
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-lambda-event-sources/test/integ.dynamodb.ts b/packages/@aws-cdk/aws-lambda-event-sources/test/integ.dynamodb.ts
@@ -20,7 +20,8 @@ class DynamoEventSourceTest extends cdk.Stack {
 
     fn.addEventSource(new DynamoEventSource(queue, {
       batchSize: 5,
-      startingPosition: lambda.StartingPosition.TRIM_HORIZON
+      startingPosition: lambda.StartingPosition.TRIM_HORIZON,
+      enabled: false
     }));
   }
 }

diff --git a/packages/@aws-cdk/aws-lambda-event-sources/test/integ.kinesis.expected.json b/packages/@aws-cdk/aws-lambda-event-sources/test/integ.kinesis.expected.json
@@ -94,6 +94,7 @@
           "Ref": "FC4345940"
         },
         "BatchSize": 100,
+        "Enabled": false,
         "StartingPosition": "TRIM_HORIZON"
       }
     },
@@ -105,4 +106,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-lambda-event-sources/test/integ.kinesis.ts b/packages/@aws-cdk/aws-lambda-event-sources/test/integ.kinesis.ts
@@ -12,7 +12,8 @@ class KinesisEventSourceTest extends cdk.Stack {
     const stream = new kinesis.Stream(this, 'Q');
 
     fn.addEventSource(new KinesisEventSource(stream, {
-      startingPosition: lambda.StartingPosition.TRIM_HORIZON
+      startingPosition: lambda.StartingPosition.TRIM_HORIZON,
+      enabled: false
     }));
   }
 }

diff --git a/packages/@aws-cdk/aws-lambda-event-sources/test/integ.sqs.expected.json b/packages/@aws-cdk/aws-lambda-event-sources/test/integ.sqs.expected.json
@@ -95,11 +95,12 @@
         "FunctionName": {
           "Ref": "FC4345940"
         },
-        "BatchSize": 5
+        "BatchSize": 5,
+        "Enabled": false
       }
     },
     "Q63C6E3AB": {
       "Type": "AWS::SQS::Queue"
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-lambda-event-sources/test/integ.sqs.ts b/packages/@aws-cdk/aws-lambda-event-sources/test/integ.sqs.ts
@@ -11,7 +11,8 @@ class SqsEventSourceTest extends cdk.Stack {
     const queue = new sqs.Queue(this, 'Q');
 
     fn.addEventSource(new SqsEventSource(queue, {
-      batchSize: 5
+      batchSize: 5,
+      enabled: false
     }));
   }
 }

diff --git a/packages/@aws-cdk/aws-lambda-event-sources/test/test.dynamo.ts b/packages/@aws-cdk/aws-lambda-event-sources/test/test.dynamo.ts
@@ -273,4 +273,39 @@ export = {
     test.done();
   },
 
+  'initialize event source disabled'(test: Test) {
+    // GIVEN
+    const stack = new cdk.Stack();
+    const fn = new TestFunction(stack, 'Fn');
+    const table = new dynamodb.Table(stack, 'T', {
+      partitionKey: {
+        name: 'id',
+        type: dynamodb.AttributeType.STRING
+      },
+      stream: dynamodb.StreamViewType.NEW_IMAGE
+    });
+
+    // WHEN
+    fn.addEventSource(new sources.DynamoEventSource(table, {
+      startingPosition: lambda.StartingPosition.LATEST,
+      enabled: false
+    }));
+
+    // THEN
+    expect(stack).to(haveResource('AWS::Lambda::EventSourceMapping', {
+      "EventSourceArn": {
+        "Fn::GetAtt": [
+          "TD925BC7E",
+          "StreamArn"
+        ]
+      },
+      "FunctionName":  {
+        "Ref": "Fn9270CBC0"
+      },
+      "Enabled": false,
+      "StartingPosition": "LATEST"
+    }));
+
+    test.done();
+  },
 };
diff --git a/packages/@aws-cdk/aws-lambda-event-sources/test/test.kinesis.ts b/packages/@aws-cdk/aws-lambda-event-sources/test/test.kinesis.ts
@@ -183,4 +183,34 @@ export = {
     test.throws(() => eventSource.eventSourceMappingId, /KinesisEventSource is not yet bound to an event source mapping/);
     test.done();
   },
+
+  'initialize event source disabled'(test: Test) {
+    // GIVEN
+    const stack = new cdk.Stack();
+    const fn = new TestFunction(stack, 'Fn');
+    const stream = new kinesis.Stream(stack, 'S');
+
+    // WHEN
+    fn.addEventSource(new sources.KinesisEventSource(stream, {
+      startingPosition: lambda.StartingPosition.LATEST,
+      enabled: false
+    }));
+
+    // THEN
+    expect(stack).to(haveResource('AWS::Lambda::EventSourceMapping', {
+      "EventSourceArn": {
+        "Fn::GetAtt": [
+          "S509448A1",
+          "Arn"
+        ]
+      },
+      "FunctionName":  {
+        "Ref": "Fn9270CBC0"
+      },
+      "Enabled": false,
+      "StartingPosition": "LATEST"
+    }));
+
+    test.done();
+  },
 };
diff --git a/packages/@aws-cdk/aws-lambda-event-sources/test/test.sqs.ts b/packages/@aws-cdk/aws-lambda-event-sources/test/test.sqs.ts
@@ -138,4 +138,30 @@ export = {
     test.throws(() => eventSource.eventSourceMappingId, /SqsEventSource is not yet bound to an event source mapping/);
     test.done();
   },
+
+  'initialize event source disabled'(test: Test) {
+    // GIVEN
+    const stack = new cdk.Stack();
+    const fn = new TestFunction(stack, 'Fn');
+    const q = new sqs.Queue(stack, 'Q');
+
+    // WHEN
+    fn.addEventSource(new sources.SqsEventSource(q, {enabled: false}));
+
+    // THEN
+    expect(stack).to(haveResource('AWS::Lambda::EventSourceMapping', {
+      "EventSourceArn": {
+        "Fn::GetAtt": [
+          "Q63C6E3AB",
+          "Arn"
+        ]
+      },
+      "FunctionName": {
+        "Ref": "Fn9270CBC0"
+      },
+      "Enabled": false
+    }));
+
+    test.done();
+  }
 };
diff --git a/packages/@aws-cdk/aws-lambda/lib/event-source.ts b/packages/@aws-cdk/aws-lambda/lib/event-source.ts
@@ -1,9 +1,9 @@
 import { IFunction } from './function-base';
-
 /**
  * An abstract class which represents an AWS Lambda event source.
  */
 export interface IEventSource {
+
   /**
    * Called by `lambda.addEventSource` to allow the event source to bind to this
    * function.