aws-solutions-constructs.aws-s3-lambda 1.58.0

CDK Constructs for AWS S3 to AWS Lambda integration

aws-s3-lambda 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.

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	aws_solutions_constructs.aws_s3_lambda
Typescript	@aws-solutions-constructs/aws-s3-lambda
Java	software.amazon.awsconstructs.services.s3lambda

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

Here is a minimal deployable pattern definition:

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

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

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

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

Initializer

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

Parameters

• scope Construct
• id string
• props S3ToLambdaProps

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	lambda.Function	Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored.
lambdaFunctionProps?	lambda.FunctionProps	User provided props to override the default props for the Lambda function.
existingBucketObj?	s3.Bucket	Existing instance of S3 Bucket object, if this is set then the bucketProps is ignored.
bucketProps?	s3.BucketProps	User provided props to override the default props for the 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
s3LoggingBucket?	s3.Bucket	Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon S3 Bucket

• Configure Access logging for S3 Bucket
• Enable server-side encryption for S3 Bucket using AWS managed KMS Key
• Enforce encryption of data in transit
• Turn on the versioning for S3 Bucket
• Don't allow public access for S3 Bucket
• Retain the S3 Bucket when deleting the CloudFormation stack

AWS Lambda Function

• Configure least privilege access IAM role for Lambda function
• Enable reusing connections with Keep-Alive for NodeJs Lambda function

Architecture

---

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