Skip to main content

CDK Constructs for AWS DynamoDB Stream to AWS Lambda integration.

Project description

aws-dynamodb-stream-lambda module

---

Stability: Experimental

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 Logo Python aws_solutions_constructs.aws_dynamodb_stream_lambda
Typescript Logo Typescript @aws-solutions-constructs/aws-dynamodb-stream-lambda
Java Logo Java 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:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_solutions_constructs.aws_dynamodb_stream_lambda import DynamoDBStreamToLambdaProps, DynamoDBStreamToLambda

DynamoDBStreamToLambda(self, "test-dynamodb-stream-lambda",
    lambda_function_props=FunctionProps(
        code=lambda_.Code.from_asset(f"{__dirname}/lambda"),
        runtime=lambda_.Runtime.NODEJS_12_X,
        handler="index.handler"
    )
)

Initializer

new DynamoDBStreamToLambda(scope: Construct, id: string, props: DynamoDBStreamToLambdaProps);

Parameters

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.
dynamoTableProps? dynamodb.TableProps Optional user provided props to override the default props for DynamoDB Table
existingTableObj? dynamodb.Table Existing instance of DynamoDB table object, If this is set then the dynamoTableProps is ignored
dynamoEventSourceProps? aws-lambda-event-sources.DynamoEventSourceProps Optional user provided props to override the default props for DynamoDB Event Source

Pattern Properties

Name Type Description
dynamoTable dynamodb.Table Returns an instance of dynamodb.Table created by the construct
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 least 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

Architecture

Architecture Diagram


© Copyright 2020 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

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file aws-solutions-constructs.aws-dynamodb-stream-lambda-1.68.0.tar.gz.

File metadata

File hashes

Hashes for aws-solutions-constructs.aws-dynamodb-stream-lambda-1.68.0.tar.gz
Algorithm Hash digest
SHA256 f27177727e352379e7cb696867e4f9bc785e274f7f6c0fffd99131ad4638b8c8
MD5 2d6cddc2e5b39c1d0ee9f890177cf109
BLAKE2b-256 8cad7beb299ee9838c4173c55c6033fbfff5f65cebeeff45a53eecb47cc6dfe6

See more details on using hashes here.

File details

Details for the file aws_solutions_constructs.aws_dynamodb_stream_lambda-1.68.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_constructs.aws_dynamodb_stream_lambda-1.68.0-py3-none-any.whl
Algorithm Hash digest
SHA256 87cd788530486c7d8e24c2438b609404958e76c869a5e36ff73edd402269e986
MD5 7000b06bea706eb50dd1ee483bb46e48
BLAKE2b-256 e23a79ce5637b2eb9be5843c8ccf69eadb70602d9522948b35d703fa82356b74

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page