JSPM

@aws-solutions-constructs/aws-lambda-s3

1.46.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1389
  • Score
    100M100P100Q125450F
  • License Apache-2.0

CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.

Package Exports

  • @aws-solutions-constructs/aws-lambda-s3

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-solutions-constructs/aws-lambda-s3) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

aws-lambda-s3 module

Stability: Experimental

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 Logo Python aws_solutions_constructs.aws_lambda_s3
Typescript Logo Typescript @aws-solutions-constructs/aws-lambda-s3
Java Logo Java software.amazon.awsconstructs.services.lambdas3

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

Here is a minimal deployable pattern definition:

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

new LambdaToS3(stack, 'LambdaToS3Pattern', {
    deployLambda: true,
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_10_X,
        handler: 'index.handler',
        code: lambda.Code.asset(`${__dirname}/lambda`)
    }
});

Initializer

new LambdaToS3(scope: Construct, id: string, props: LambdaToS3Props);

Parameters

Pattern Construct Props

Name Type Description
deployLambda boolean Whether to create a new Lambda function or use an existing Lambda function.
existingLambdaObj? lambda.Function An optional, existing Lambda function.
lambdaFunctionProps? lambda.FunctionProps Optional user-provided props to override the default props for the Lambda function.
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
bucketPermissions? string[] Optional bucket permissions to grant to the Lambda function. One or more of the following may be specified: Delete, Put, Read, ReadWrite, Write.

Pattern Properties

|lambdaFunction|lambda.Function|Returns an instance of the Lambda function created by the pattern.| |s3Bucket|s3.Bucket|Returns an instance of the S3 bucket created by the pattern.|

Default settings

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

AWS Lambda Function

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

Amazon S3 Bucket

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

Architecture

Architecture Diagram

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