CDK Constructs for AWS DynamoDB Stream to AWS Lambda integration.
Project description
aws-dynamodb-stream-lambda module
---Some of our early constructs don’t meet the naming standards that evolved for the library. We are releasing completely feature compatible versions with corrected names. The underlying implementation code is the same regardless of whether you deploy the construct using the old or new name. We will support both names for all 1.x releases, but in 2.x we will only publish the correctly named constructs. This construct is being replaced by the functionally identical aws-dynamodbstreams-lambda.
Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
aws_solutions_constructs.aws_dynamodb_stream_lambda |
|
@aws-solutions-constructs/aws-dynamodb-stream-lambda |
|
software.amazon.awsconstructs.services.dynamodbstreamlambda |
This AWS Solutions Construct implements a pattern Amazon DynamoDB table with stream to invoke the AWS Lambda function with the least privileged permissions.
Here is a minimal deployable pattern definition in Typescript:
import { DynamoDBStreamToLambdaProps, DynamoDBStreamToLambda} from '@aws-solutions-constructs/aws-dynamodb-stream-lambda';
new DynamoDBStreamToLambda(this, 'test-dynamodb-stream-lambda', {
lambdaFunctionProps: {
code: lambda.Code.fromAsset(`${__dirname}/lambda`),
runtime: lambda.Runtime.NODEJS_14_X,
handler: 'index.handler'
},
});
Initializer
new DynamoDBStreamToLambda(scope: Construct, id: string, props: DynamoDBStreamToLambdaProps);
Parameters
- scope
Construct
- id
string
- props
DynamoDBStreamToLambdaProps
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 |
existingTableInterface? | dynamodb.ITable |
Existing instance of DynamoDB table object or interface, providing both this and dynamoTableProps will cause an error. |
dynamoEventSourceProps? | aws-lambda-event-sources.DynamoEventSourceProps |
Optional user provided props to override the default props for DynamoDB Event Source |
Pattern Properties
Name | Type | Description |
---|---|---|
dynamoTableInterface | dynamodb.ITable |
Returns an instance of dynamodb.ITable created by the construct |
dynamoTable? | dynamodb.Table |
Returns an instance of dynamodb.Table created by the construct. IMPORTANT: If existingTableInterface was provided in Pattern Construct Props, this property will be undefined |
lambdaFunction | lambda.Function |
Returns an instance of lambda.Function created by the construct |
Lambda Function
This pattern requires a lambda function that can post data into the Elasticsearch. A sample function is provided here.
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
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
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
-
Enable Failure-Handling features like enable bisect on function Error, set defaults for Maximum Record Age (24 hours) & Maximum Retry Attempts (500) and deploy SQS dead-letter queue as destination on failure
-
Set Environment Variables
- AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
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-dynamodb-stream-lambda-1.141.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6d2f846eb9d9b0e50e6ad00f83a686bc60d2fd764b97408cbb098e4b26c3282 |
|
MD5 | 8b529be244e29caab43edcc5243bd661 |
|
BLAKE2b-256 | ae3c6d1540aadbf7c74b05a2353464a771528368f06267dcf74a89c6bb58b525 |
Hashes for aws_solutions_constructs.aws_dynamodb_stream_lambda-1.141.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdfeb3e22b75e899752d0535a53b288527012ff0766d61c46ac0cfd6a60ec9af |
|
MD5 | 7817f385e6495686da262c8e23118c2a |
|
BLAKE2b-256 | 2fc05ede28565018e1c2f73607a7c6cf71f81359a23dcedfa0d328e87281c6fb |