feat(aws-lambda): high level API for event sources

packages/@aws-cdk/aws-lambda-event-sources/.gitignore

@@ -0,0 +1,17 @@
+*.js
+*.js.map
+*.d.ts
+node_modules
+*.generated.ts
+dist
+tsconfig.json
+tslint.json
+
+.jsii
+
+.LAST_BUILD
+.nyc_output
+coverage
+.nycrc
+.LAST_PACKAGE
+*.snk

packages/@aws-cdk/aws-lambda-event-sources/.npmignore

@@ -0,0 +1,16 @@
+# Don't include original .ts files when doing `npm pack`
+*.ts
+!*.d.ts
+coverage
+.nyc_output
+*.tgz
+
+dist
+.LAST_PACKAGE
+.LAST_BUILD
+!*.js
+
+# Include .jsii
+!.jsii
+
+*.snk

packages/@aws-cdk/aws-lambda-event-sources/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

packages/@aws-cdk/aws-lambda-event-sources/NOTICE

@@ -0,0 +1,2 @@
+AWS Cloud Development Kit (AWS CDK)
+Copyright 2018-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.

packages/@aws-cdk/aws-lambda-event-sources/README.md

@@ -0,0 +1,102 @@
+## AWS Lambda Event Sources
+
+This module includes classes that allow using various AWS services as event
+sources for AWS Lambda via the high-level `lambda.addEventSource(source)` API.
+
+NOTE: In most cases, it is also possible to use the resource APIs to invoke an
+AWS Lambda function. This library provides a uniform API for all Lambda event
+sources regardless of the underlying mechanism they use.
+
+### SQS
+
+Amazon Simple Queue Service (Amazon SQS) allows you to build asynchronous
+workflows. For more information about Amazon SQS, see Amazon Simple Queue
+Service. You can configure AWS Lambda to poll for these messages as they arrive
+and then pass the event to a Lambda function invocation. To view a sample event,
+see [Amazon SQS Event](https://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-sqs).
+
+To set up Amazon Simple Queue Service as an event source for AWS Lambda, you
+first create or update an Amazon SQS queue and select custom values for the
+queue parameters. The following parameters will impact Amazon SQS's polling
+behavior:
+
+* __visibilityTimeoutSec__: May impact the period between retries.
+* __receiveMessageWaitTimeSec__: Will determine [long
+  poll](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html)
+  duration. The default value is 20 seconds.
+
+```ts
+import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';
+
+const queue = new sqs.Queue(this, 'MyQueue', {
+  visibilityTimeoutSec: 30      // default,
+  receiveMessageWaitTimeSec: 20 // default
+});
+
+lambda.addEventSource(new SqsEventSource(queue, {
+  batchSize: 10 // default
+});
+```
+
+### S3
+
+You can write Lambda functions to process S3 bucket events, such as the
+object-created or object-deleted events. For example, when a user uploads a
+photo to a bucket, you might want Amazon S3 to invoke your Lambda function so
+that it reads the image and creates a thumbnail for the photo.
+
+You can use the bucket notification configuration feature in Amazon S3 to
+configure the event source mapping, identifying the bucket events that you want
+Amazon S3 to publish and which Lambda function to invoke.
+
+```ts
+import { S3EventSource } from '@aws-cdk/aws-lambda-event-sources';
+
+const bucket = new s3.Bucket(...);
+
+lambda.addEventSource(new S3EventSource(bucket, {
+  events: [ s3.EventType.ObjectCreated, s3.EventType.ObjectDeleted ],
+  filters: [ { prefix: 'subdir/' } ] // optional
+}));
+```
+
+### SNS
+
+You can write Lambda functions to process Amazon Simple Notification Service
+notifications. When a message is published to an Amazon SNS topic, the service
+can invoke your Lambda function by passing the message payload as a parameter.
+Your Lambda function code can then process the event, for example publish the
+message to other Amazon SNS topics, or send the message to other AWS services.
+
+This also enables you to trigger a Lambda function in response to Amazon
+CloudWatch alarms and other AWS services that use Amazon SNS.
+
+For an example event, see [Appendix: Message and JSON
+Formats](https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) and
+[Amazon SNS Sample
+Event](https://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-sns).
+For an example use case, see [Using AWS Lambda with Amazon SNS from Different
+Accounts](https://docs.aws.amazon.com/lambda/latest/dg/with-sns.html).
+
+```ts
+import { SnsEventSource } from '@aws-cdk/aws-lambda-event-sources';
+
+const topic = new sns.Topic(...);
+
+lambda.addEventSource(new SnsEventSource(topic));
+```
+
+When a user calls the SNS Publish API on a topic that your Lambda function is
+subscribed to, Amazon SNS will call Lambda to invoke your function
+asynchronously. Lambda will then return a delivery status. If there was an error
+calling Lambda, Amazon SNS will retry invoking the Lambda function up to three
+times. After three tries, if Amazon SNS still could not successfully invoke the
+Lambda function, then Amazon SNS will send a delivery status failure message to
+CloudWatch.
+
+## Roadmap
+
+Eventually, this module will support all the event sources described under
+[Supported Event
+Sources](https://docs.aws.amazon.com/lambda/latest/dg/invoking-lambda-function.html)
+in the AWS Lambda Developer Guide.

packages/@aws-cdk/aws-lambda-event-sources/lib/index.ts

@@ -0,0 +1,3 @@
+export * from './sqs';
+export * from './s3';
+export * from './sns';

packages/@aws-cdk/aws-lambda-event-sources/lib/s3.ts

@@ -0,0 +1,33 @@
+import lambda = require('@aws-cdk/aws-lambda');
+import s3 = require('@aws-cdk/aws-s3');
+
+export interface S3EventSourceProps {
+  /**
+   * The s3 event types that will trigger the notification.
+   */
+  events: s3.EventType[];
+
+  /**
+   * S3 object key filter rules to determine which objects trigger this event.
+   * Each filter must include a `prefix` and/or `suffix` that will be matched
+   * against the s3 object key. Refer to the S3 Developer Guide for details
+   * about allowed filter rules.
+   */
+  filters?: s3.NotificationKeyFilter[];
+}
+
+/**
+ * Use S3 bucket notifications as an event source for AWS Lambda.
+ */
+export class S3EventSource implements lambda.IEventSource {
+  constructor(readonly bucket: s3.Bucket, private readonly props: S3EventSourceProps) {
+
+  }
+
+  public bind(target: lambda.FunctionRef) {
+    const filters = this.props.filters || [];
+    for (const event of this.props.events) {
+      this.bucket.onEvent(event, target, ...filters);
+    }
+  }
+}

packages/@aws-cdk/aws-lambda-event-sources/lib/sns.ts

@@ -0,0 +1,14 @@
+import lambda = require('@aws-cdk/aws-lambda');
+import sns = require('@aws-cdk/aws-sns');
+
+/**
+ * Use an Amazon SNS topic as an event source for AWS Lambda.
+ */
+export class SnsEventSource implements lambda.IEventSource {
+  constructor(readonly topic: sns.TopicRef) {
+  }
+
+  public bind(target: lambda.FunctionRef) {
+    this.topic.subscribeLambda(target);
+  }
+}