Skip to main content

CDK Constructs for AWS S3 to AWS Lambda integration

Project description

aws-s3-lambda module


Stability: Experimental

This is a developer preview (public beta) module.

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

API Reference:
Language Package
Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_s3_lambda
Typescript Logo{: style="height:16px;width:16px"} Typescript @aws-solutions-konstruk/aws-s3-lambda

This AWS Solutions Konstruk implements an Amazon S3 bucket connected to an AWS Lambda function.

Here is a minimal deployable pattern definition:

const { S3ToLambdaProps, S3ToLambda } = require('@aws-solutions-konstruk/aws-s3-lambda');

const stack = new Stack(app, 'test-s3-lambda-stack');

const props: S3ToLambdaProps = {
    deployLambda: true,
    lambdaFunctionProps: {
        code: lambda.Code.asset(`${__dirname}/lambda`),
        runtime: lambda.Runtime.NODEJS_12_X,
        handler: 'index.handler'

new S3ToLambda(stack, 'test-s3-lambda', props);


new S3ToLambda(scope: Construct, id: string, props: S3ToLambdaProps);


Pattern Construct Props

Name Type Description
deployLambda boolean Whether to create a new Lambda function or use an existing Lambda function. If set to false, you must provide an existing function for the existingLambdaObj property.
existingLambdaObj? lambda.Function An optional, existing Lambda function. This property is required if deployLambda is set to false.
lambdaFunctionProps? lambda.FunctionProps Optional user-provided props to override the default props for the Lambda function. This property is only required if deployLambda is set to true.
deployBucket? boolean Whether to create a S3 Bucket or use an existing S3 Bucket
existingBucketObj? s3.Bucket Existing instance of S3 Bucket object
bucketProps? s3.BucketProps Optional user provided props to override the default props for S3 Bucket
s3EventSourceProps? S3EventSourceProps Optional user provided props to override the default props for S3EventSourceProps

Pattern Properties

Name Type Description
lambdaFunction() lambda.Function Returns an instance of the lambda.Function created by the construct
s3Bucket() s3.Bucket Returns an instance of the s3.Bucket created by the construct


Architecture Diagram

© Copyright 2020, Inc. or its affiliates. All Rights Reserved.

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for, version 0.8.0
Filename, size File type Python version Upload date Hashes
Filename, size aws_solutions_konstruk.aws_s3_lambda-0.8.0-py3-none-any.whl (92.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size (93.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page