awssolutionsconstructsawslambdas3

README

aws-lambda-s3 module

---

---

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

Language	Package
Python	aws_solutions_constructs.aws_lambda_s3
Typescript	@aws-solutions-constructs/aws-lambda-s3
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 in Typescript:

import { LambdaToS3 } from '@aws-solutions-constructs/aws-lambda-s3';

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

Initializer

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

Parameters

• scope Construct
• id string
• props LambdaToS3Props

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	lambda.Function	Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?	lambda.FunctionProps	Optional user provided props to override the default props for the Lambda function.
existingBucketObj?	s3.IBucket	Existing instance of S3 Bucket object. If this is provided, then also providing bucketProps is an error.
bucketProps?	s3.BucketProps	Optional 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.IVpc	An 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 SQS. 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.VpcProps	Optional 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 overrriden. If deployVpc is not true then this property will be ignored.
deployVpc?	boolean	Whether 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 program enableDnsHostnames and enableDnsSupport will both be set to true If this property is true then existingVpc cannot be specified. Defaults to false.
bucketEnvironmentVariableName?	string	Optional name for the S3 bucket environment variable set for the Lambda function.
loggingBucketProps?	s3.BucketProps	Optional user provided props to override the default props for the S3 Logging Bucket.
logS3AccessLogs?	boolean	Whether 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

Name	Type	Description
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.
s3LoggingBucket?	s3.Bucket	Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.
vpc?	ec2.IVpc	Returns 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.
s3BucketInterface	s3.IBucket	Returns 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

---

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

Documentation

Overview

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

Index

• func LambdaToS3_IsConstruct(x interface{}) *bool
• func NewLambdaToS3_Override(l LambdaToS3, scope constructs.Construct, id *string, props *LambdaToS3Props)
• type LambdaToS3
  • func NewLambdaToS3(scope constructs.Construct, id *string, props *LambdaToS3Props) LambdaToS3
• type LambdaToS3Props

Functions

func LambdaToS3_IsConstruct

func LambdaToS3_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewLambdaToS3_Override

func NewLambdaToS3_Override(l LambdaToS3, scope constructs.Construct, id *string, props *LambdaToS3Props)

Types

type LambdaToS3

type LambdaToS3 interface {
	constructs.Construct
	LambdaFunction() awslambda.Function
	Node() constructs.Node
	S3Bucket() awss3.Bucket
	S3BucketInterface() awss3.IBucket
	S3LoggingBucket() awss3.Bucket
	Vpc() awsec2.IVpc
	ToString() *string
}

func NewLambdaToS3

func NewLambdaToS3(scope constructs.Construct, id *string, props *LambdaToS3Props) LambdaToS3

type LambdaToS3Props

type LambdaToS3Props struct {
	// Optional name for the S3 bucket environment variable set for the Lambda function.
	BucketEnvironmentVariableName *string `json:"bucketEnvironmentVariableName"`
	// Optional bucket permissions to grant to the Lambda function.
	//
	// One or more of the following may be specified: "Delete", "Put", "Read", "ReadWrite", "Write".
	BucketPermissions *[]*string `json:"bucketPermissions"`
	// Optional user provided props to override the default props for the S3 Bucket.
	BucketProps *awss3.BucketProps `json:"bucketProps"`
	// Whether to deploy a new VPC.
	DeployVpc *bool `json:"deployVpc"`
	// Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error.
	ExistingBucketObj awss3.IBucket `json:"existingBucketObj"`
	// Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
	ExistingLambdaObj awslambda.Function `json:"existingLambdaObj"`
	// An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
	ExistingVpc awsec2.IVpc `json:"existingVpc"`
	// Optional user provided props to override the default props for the Lambda function.
	LambdaFunctionProps *awslambda.FunctionProps `json:"lambdaFunctionProps"`
	// Optional user provided props to override the default props for the S3 Logging Bucket.
	LoggingBucketProps *awss3.BucketProps `json:"loggingBucketProps"`
	// Whether to turn on Access Logs for the S3 bucket with the associated storage costs.
	//
	// Enabling Access Logging is a best practice.
	LogS3AccessLogs *bool `json:"logS3AccessLogs"`
	// Properties to override default properties if deployVpc is true.
	VpcProps *awsec2.VpcProps `json:"vpcProps"`
}