CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.
Project description
aws-lambda-s3 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.
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:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_solutions_constructs.aws_lambda_s3 import LambdaToS3
LambdaToS3(self, "LambdaToS3Pattern",
lambda_function_props=FunctionProps(
runtime=lambda_.Runtime.NODEJS_10_X,
handler="index.handler",
code=lambda_.Code.from_asset(f"{__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, 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.IBucket |
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. |
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. |
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
andenableDnsSupport
will both be set to true
If this property is true
then existingVpc
cannot be specified. Defaults to false
.|
|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.|
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. |
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
- 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.
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
Hashes for aws-solutions-constructs.aws-lambda-s3-1.84.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 339b041850514dc5513aac0551d5073e206e1837238421e79f9c118df9a37cab |
|
MD5 | fcdb76b047fb1e734ce57d98a354f175 |
|
BLAKE2b-256 | b4c60efac04fa4194839e90f75b76428752adaa9ca089fea9c0b3906d4bae1ee |
Hashes for aws_solutions_constructs.aws_lambda_s3-1.84.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9295e62c395823671c985a3544a5a92ddf8e7ebd2cdf461eee0279c3911a9cde |
|
MD5 | f6da99a5b5a384c97a76a104376cde56 |
|
BLAKE2b-256 | cf42c52ddd51fbc3be690671fdbbaa14b87b7a4a71e992065e2f7e789e364c47 |