Skip to main content

CDK Constructs for AWS DynamoDB Streams to AWS Lambda integration.

Project description

aws-dynamodbstreams-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_dynamodbstreams_lambda
Typescript Logo Typescript @aws-solutions-constructs/aws-dynamodbstreams-lambda
Java Logo Java software.amazon.awsconstructs.services.dynamodbstreamslambda

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_dynamodbstreams_lambda import DynamoDBStreamsToLambdaProps, DynamoDBStreamsToLambda

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

Initializer

new DynamoDBStreamsToLambda(scope: Construct, id: string, props: DynamoDBStreamsToLambdaProps);

Parameters

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

Architecture Diagram


© 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

File details

Details for the file aws-solutions-constructs.aws-dynamodbstreams-lambda-1.125.0.tar.gz.

File metadata

File hashes

Hashes for aws-solutions-constructs.aws-dynamodbstreams-lambda-1.125.0.tar.gz
Algorithm Hash digest
SHA256 86325d75474f20d4c65518d62bfb92f29fc734a7b80e4d68b5b339619cbd4d2a
MD5 98f924045787a72171fd2599e1b18cb2
BLAKE2b-256 46050a2b3d75ee6008eaf63813018a0beee0fdb3562006b52d273f80a72f7025

See more details on using hashes here.

File details

Details for the file aws_solutions_constructs.aws_dynamodbstreams_lambda-1.125.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_constructs.aws_dynamodbstreams_lambda-1.125.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f3e71878b04ddb8734121fa93a12f666eb533e9ac9e60761569b84816857a89f
MD5 fa12483edef3ce67e2516610131ada1c
BLAKE2b-256 9c0a2719495b4fbfa2e638ef81b834532ebea87438431681297f2332033b6fe8

See more details on using hashes here.

Supported by

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