Skip to main content

CDK Constructs for AWS S3 to AWS Lambda integration

Project description

aws-s3-lambda 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_s3_lambda
Typescript Logo Typescript @aws-solutions-constructs/aws-s3-lambda
Java Logo 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 in Typescript:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_solutions_constructs.aws_s3_lambda import S3ToLambdaProps, S3ToLambda

S3ToLambda(self, "test-s3-lambda",
    lambda_function_props=FunctionProps(
        code=lambda_.Code.from_asset(f"{__dirname}/lambda"),
        runtime=lambda_.Runtime.NODEJS_12_X,
        handler="index.handler"
    )
)

Initializer

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

Parameters

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
  • Applies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 days

AWS Lambda Function

  • Configure limited privilege access IAM role for Lambda function

  • Enable reusing connections with Keep-Alive for NodeJs Lambda function

  • Enable X-Ray Tracing

  • Set Environment Variables

    • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

Architecture

Architecture Diagram


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

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file aws-solutions-constructs.aws-s3-lambda-1.84.0.tar.gz.

File metadata

  • Download URL: aws-solutions-constructs.aws-s3-lambda-1.84.0.tar.gz
  • Upload date:
  • Size: 94.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.6

File hashes

Hashes for aws-solutions-constructs.aws-s3-lambda-1.84.0.tar.gz
Algorithm Hash digest
SHA256 55245f18cf9ecd8f6339054d288033f49c4d6cf445e398236c82d2220693893b
MD5 51a82f44e2355eba58b9178adbf30d07
BLAKE2b-256 a7534ecb65acc23f072acc51a44561f27dab27b602198fb6c7f312399a1e742a

See more details on using hashes here.

File details

Details for the file aws_solutions_constructs.aws_s3_lambda-1.84.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_constructs.aws_s3_lambda-1.84.0-py3-none-any.whl
Algorithm Hash digest
SHA256 22c1d87b872518ae40801292f0814789646769e9c07f073334809b33446ecbba
MD5 22476bf43e63322b757f00a76915cf94
BLAKE2b-256 72eb890eb8ec22cb6c04b51d0ed240623ec226aa887a69963b8135ac544e509b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page