@aws-solutions-konstruk/aws-s3-lambda NPM

aws-s3-lambda module

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:	http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-s3-lambda/

Language	Package
{: style="height:16px;width:16px"} Python	`aws_solutions_konstruk.aws_s3_lambda`
{: 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);

Initializer

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

Parameters

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

Architecture Diagram

@aws-cdk/aws-s3 @aws-cdk/aws-s3-notifications @aws-cdk/aws-lambda @aws-cdk/aws-lambda-event-sources @aws-cdk/aws-iam @aws-cdk/core @aws-solutions-konstruk/core constructs

@infinitebrahmanuniverse/nolb-_aws-so @everything-registry/sub-chunk-103

0.8.1

4 years ago

0.8.0

4 years ago