CDK Constructs for AWS Lambda to AWS DynamoDB integration.
Project description
aws-lambda-dynamodb module
---Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_lambda_dynamodb |
Typescript | @aws-solutions-constructs/aws-lambda-dynamodb |
Java | software.amazon.awsconstructs.services.lambdadynamodb |
This AWS Solutions Construct implements the AWS Lambda function and Amazon DynamoDB table with the least privileged permissions.
Here is a minimal deployable pattern definition in Typescript:
const { LambdaToDynamoDBProps, LambdaToDynamoDB } from '@aws-solutions-constructs/aws-lambda-dynamodb';
const props: LambdaToDynamoDBProps = {
lambdaFunctionProps: {
code: lambda.Code.fromAsset(`${__dirname}/lambda`),
runtime: lambda.Runtime.NODEJS_12_X,
handler: 'index.handler'
},
};
new LambdaToDynamoDB(this, 'test-lambda-dynamodb-stack', props);
Initializer
new LambdaToDynamoDB(scope: Construct, id: string, props: LambdaToDynamoDBProps);
Parameters
- scope
Construct
- id
string
- props
LambdaToDynamoDBProps
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 |
User provided props to override the default props for the Lambda function. |
dynamoTableProps? | dynamodb.TableProps |
Optional user provided props to override the default props for DynamoDB Table |
existingTableObj? | dynamodb.Table |
Existing instance of DynamoDB table object, providing both this and dynamoTableProps will cause an error. |
tablePermissions? | string |
Optional table permissions to grant to the Lambda function. One of the following may be specified: All , Read , ReadWrite , Write . |
tableEnvironmentVariableName? | string |
Optional Name for the DynamoDB table environment variable set for the Lambda function. |
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 a Gateway Endpoint will be created in the VPC for Amazon DynamoDB. 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:
true then existingVpc cannot be specified. Defaults to false . |
Pattern Properties
Name | Type | Description |
---|---|---|
lambdaFunction | lambda.Function |
Returns an instance of lambda.Function created by the construct |
dynamoTable | dynamodb.Table |
Returns an instance of dynamodb.Table created by the construct |
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
- (default) DDB_TABLE_NAME
- AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
Amazon DynamoDB Table
- Set the billing mode for DynamoDB Table to On-Demand (Pay per request)
- Enable server-side encryption for DynamoDB Table using AWS managed KMS Key
- Creates a partition key called 'id' for DynamoDB Table
- Retain the Table when deleting the CloudFormation stack
- Enable continuous backups and point-in-time recovery
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
Close
Hashes for aws-solutions-constructs.aws-lambda-dynamodb-2.0.0rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c4e03ab445fde35660a84e3af84b62bb6c8ebd4a181aee94ea23a04f8bbf7a2 |
|
MD5 | 933fee5568a4d8e9511dd23c6e45495e |
|
BLAKE2b-256 | f5dd1e090ec940a996cbb8d9391531863206287707b4c6b74b830305eac5ba8b |
Close
Hashes for aws_solutions_constructs.aws_lambda_dynamodb-2.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc7a243db6420403d508d7c63640970f24a74dfbdd066b2419925e17ede52815 |
|
MD5 | ad4335ce49f35636f24177e770c3cf67 |
|
BLAKE2b-256 | 6a5e1494b34cb3b426de4641fef70d223a1ac5620b64e170bb9cdb2991ff3e3c |