2.56.0 • Published 10 days ago

@aws-solutions-constructs/aws-lambda-s3 v2.56.0

Weekly downloads
259
License
Apache-2.0
Repository
github
Last release
10 days ago

aws-lambda-s3 module


Stability: Stable


Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws_lambda_s3
Typescript Logo Typescript@aws-solutions-constructs/aws-lambda-s3
Java Logo Javasoftware.amazon.awsconstructs.services.lambdas3

Overview

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

Here is a minimal deployable pattern definition :

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { LambdaToS3 } from '@aws-solutions-constructs/aws-lambda-s3';
import * as lambda from 'aws-cdk-lib/aws-lambda';

new LambdaToS3(this, 'LambdaToS3Pattern', {
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_16_X,
        handler: 'index.handler',
        code: lambda.Code.fromAsset(`lambda`)
    }
});

Python

from aws_solutions_constructs.aws_lambda_s3 import LambdaToS3
from aws_cdk import (
    aws_lambda as _lambda,
    Stack
)
from constructs import Construct

LambdaToS3(self, 'LambdaToS3Pattern',
        lambda_function_props=_lambda.FunctionProps(
            code=_lambda.Code.from_asset('lambda'),
            runtime=_lambda.Runtime.PYTHON_3_9,
            handler='index.handler'
        )
        )

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.lambda.Runtime;
import software.amazon.awsconstructs.services.lambdas3.*;

new LambdaToS3(this, "LambdaToS3Pattern", new LambdaToS3Props.Builder()
        .lambdaFunctionProps(new FunctionProps.Builder()
                .runtime(Runtime.NODEJS_16_X)
                .code(Code.fromAsset("lambda"))
                .handler("index.handler")
                .build())
        .build());

Pattern Construct Props

NameTypeDescription
existingLambdaObj?lambda.FunctionExisting instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?lambda.FunctionPropsOptional user provided props to override the default props for the Lambda function.
existingBucketObj?s3.IBucketExisting instance of S3 Bucket object. If this is provided, then also providing bucketProps is an error.
bucketProps?s3.BucketPropsOptional user provided props to override the default props for the 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.
existingVpc?ec2.IVpcAn optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for Amazon S3. If an existing VPC is provided, the deployVpc property cannot be true. This uses ec2.IVpc to allow clients to supply VPCs that exist outside the stack using the ec2.Vpc.fromLookup() method.
vpcProps?ec2.VpcPropsOptional user provided properties to override the default properties for the new VPC. enableDnsHostnames, enableDnsSupport, natGateways and subnetConfiguration are set by the pattern, so any values for those properties supplied here will be overridden. If deployVpc is not true then this property will be ignored.
deployVpc?booleanWhether to create a new VPC based on vpcProps into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern: One isolated subnet in each Availability Zone used by the CDK programenableDnsHostnames and enableDnsSupport will both be set to trueIf this property is true then existingVpc cannot be specified. Defaults to false.
bucketEnvironmentVariableName?stringOptional Name for the Lambda function environment variable set to the name of the bucket. Default: S3_BUCKET_NAME
loggingBucketProps?s3.BucketPropsOptional user provided props to override the default props for the S3 Logging Bucket.
logS3AccessLogs?booleanWhether to turn on Access Logging for the S3 bucket. Creates an S3 bucket with associated storage costs for the logs. Enabling Access Logging is a best practice. default - true

Pattern Properties

NameTypeDescription
lambdaFunctionlambda.FunctionReturns an instance of the Lambda function created by the pattern.
s3Bucket?s3.BucketReturns an instance of the S3 bucket created by the pattern.
s3LoggingBucket?s3.BucketReturns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.
vpc?ec2.IVpcReturns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.
s3BucketInterfaces3.IBucketReturns an instance of s3.IBucket created by the construct.

Default settings

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

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
    • (default) S3_BUCKET_NAME
    • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

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

Architecture

Architecture Diagram


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

2.56.0

10 days ago

2.55.0

22 days ago

2.54.1

30 days ago

2.54.0

2 months ago

2.53.0

2 months ago

2.52.1

3 months ago

2.52.0

3 months ago

2.51.0

3 months ago

2.50.0

3 months ago

2.49.0

3 months ago

2.48.0

4 months ago

2.47.0

5 months ago

2.46.0

6 months ago

2.45.0

7 months ago

2.44.0

8 months ago

2.43.0

8 months ago

2.43.1

8 months ago

2.42.0

9 months ago

2.41.0

11 months ago

2.40.0

11 months ago

2.39.0

1 year ago

2.38.0

1 year ago

2.37.0

1 year ago

2.34.0

1 year ago

2.33.0

1 year ago

2.32.0

1 year ago

2.31.0

1 year ago

2.36.0

1 year ago

2.35.0

1 year ago

2.30.0

1 year ago

2.27.0

2 years ago

1.176.0

1 year ago

2.26.0

2 years ago

1.175.0

1 year ago

1.179.0

1 year ago

2.29.0

1 year ago

1.181.0

1 year ago

1.181.1

1 year ago

1.174.0

1 year ago

1.178.0

1 year ago

2.28.0

1 year ago

1.180.0

1 year ago

1.177.0

1 year ago

1.168.0

2 years ago

2.19.0

2 years ago

1.172.0

2 years ago

2.22.0

2 years ago

1.167.0

2 years ago

2.18.0

2 years ago

2.21.0

2 years ago

1.171.0

2 years ago

2.25.0

2 years ago

2.17.0

2 years ago

1.170.0

2 years ago

2.20.0

2 years ago

1.170.1

2 years ago

2.24.0

2 years ago

1.169.0

2 years ago

2.16.0

2 years ago

1.173.0

2 years ago

2.23.0

2 years ago

2.11.0

2 years ago

1.160.0

2 years ago

1.164.0

2 years ago

1.157.0

2 years ago

1.163.0

2 years ago

2.10.0

2 years ago

1.163.2

2 years ago

1.163.1

2 years ago

2.14.0

2 years ago

1.162.0

2 years ago

1.166.1

2 years ago

2.13.0

2 years ago

1.159.0

2 years ago

2.12.0

2 years ago

1.161.0

2 years ago

1.165.0

2 years ago

2.9.0

2 years ago

1.158.0

2 years ago

2.8.0

2 years ago

1.153.0

2 years ago

1.153.1

2 years ago

2.7.0

2 years ago

1.156.0

2 years ago

1.156.1

2 years ago

2.6.0

2 years ago

1.155.0

2 years ago

1.154.0

2 years ago

2.4.0

2 years ago

1.149.0

2 years ago

1.148.0

2 years ago

1.152.0

2 years ago

1.147.0

2 years ago

1.151.0

2 years ago

2.5.0

2 years ago

1.150.0

2 years ago

1.145.0

2 years ago

1.141.0

2 years ago

1.144.0

2 years ago

1.140.0

2 years ago

1.143.0

2 years ago

1.142.0

2 years ago

1.146.0

2 years ago

1.134.0

2 years ago

1.130.0

2 years ago

1.138.2

2 years ago

1.138.1

2 years ago

1.138.0

2 years ago

2.3.0

2 years ago

1.133.0

2 years ago

1.137.0

2 years ago

2.2.0

2 years ago

1.132.0

2 years ago

1.136.0

2 years ago

2.1.0

2 years ago

1.131.0

2 years ago

1.139.0

2 years ago

1.135.0

2 years ago

2.0.0

2 years ago

1.129.0

2 years ago

1.128.0

2 years ago

1.127.0

2 years ago

2.0.0-rc.2

3 years ago

1.126.0

3 years ago

2.0.0-rc.1

3 years ago

1.125.0

3 years ago

1.124.0

3 years ago

1.123.0

3 years ago

1.122.0

3 years ago

1.121.0

3 years ago

1.120.0

3 years ago

1.119.0

3 years ago

1.118.0

3 years ago

1.117.0

3 years ago

1.115.0

3 years ago

1.116.0

3 years ago

1.113.0

3 years ago

1.114.0

3 years ago

1.112.0

3 years ago

1.111.0

3 years ago

1.110.1

3 years ago

1.109.0

3 years ago

1.108.1

3 years ago

1.110.0

3 years ago

1.108.0

3 years ago

1.107.0

3 years ago

1.106.1

3 years ago

1.105.0

3 years ago

1.106.0

3 years ago

1.101.0

3 years ago

1.103.0

3 years ago

1.99.0

3 years ago

1.100.0

3 years ago

1.104.0

3 years ago

1.102.0

3 years ago

1.98.0

3 years ago

1.97.0

3 years ago

1.96.0

3 years ago

1.94.1

3 years ago

1.95.2

3 years ago

1.95.1

3 years ago

1.95.0

3 years ago

1.94.0

3 years ago

1.92.0

3 years ago

1.93.0

3 years ago

1.91.0

3 years ago

1.90.1

3 years ago

1.90.0

3 years ago

1.89.0

3 years ago

1.88.0

3 years ago

1.87.1

3 years ago

1.86.0

3 years ago

1.87.0

3 years ago

1.85.0

3 years ago

1.84.0

3 years ago

1.82.0

3 years ago

1.83.0

3 years ago

1.81.0

3 years ago

1.80.0

3 years ago

1.79.0

3 years ago

1.78.0

3 years ago

1.77.0

3 years ago

1.76.0

3 years ago

1.75.0

3 years ago

1.74.0

3 years ago

1.73.0

3 years ago

1.72.0

3 years ago

1.71.0

4 years ago

1.70.0

4 years ago

1.69.0

4 years ago

1.68.0

4 years ago

1.67.0

4 years ago

1.66.0

4 years ago

1.65.0

4 years ago

1.64.1

4 years ago

1.64.0

4 years ago

1.63.0

4 years ago

1.62.0

4 years ago

1.61.1

4 years ago

1.61.0

4 years ago

1.60.0

4 years ago

1.59.0

4 years ago

1.58.0

4 years ago

1.57.0

4 years ago

1.56.0

4 years ago

1.55.0

4 years ago

1.54.0

4 years ago

1.53.0

4 years ago

1.52.0

4 years ago

1.51.0

4 years ago

1.50.0

4 years ago

1.49.0

4 years ago

1.48.0

4 years ago

1.47.0

4 years ago

1.46.0

4 years ago