Skip to main content

CDK Constructs for AWS Lambda to AWS DynamoDB integration.

Project description

aws-lambda-dynamodb module

---

Stability: Stable


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package
Python Logo Python aws_solutions_constructs.aws_lambda_dynamodb
Typescript Logo Typescript @aws-solutions-constructs/aws-lambda-dynamodb
Java Logo 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_14_X,
        handler: 'index.handler'
    },
};

new LambdaToDynamoDB(this, 'test-lambda-dynamodb-stack', props);

Initializer

new LambdaToDynamoDB(scope: Construct, id: string, props: LambdaToDynamoDBProps);

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
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:
  • One isolated subnet in each Availability Zone used by the CDK program
  • enableDnsHostnames and enableDnsSupport will both be set to true
If this property is 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

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-lambda-dynamodb-1.138.1.tar.gz.

File metadata

File hashes

Hashes for aws-solutions-constructs.aws-lambda-dynamodb-1.138.1.tar.gz
Algorithm Hash digest
SHA256 d5915f171a457f2c780dfb4215d8ade96240baf5d22da43ddd49629ca7492935
MD5 8ccb83680e8306bc7d04dbb4b893f5a7
BLAKE2b-256 61ff1ec4245ec1311030c6bd130e35bac60f28d4e522b0b9ca4fe9c1ae129c77

See more details on using hashes here.

File details

Details for the file aws_solutions_constructs.aws_lambda_dynamodb-1.138.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_constructs.aws_lambda_dynamodb-1.138.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1f2c023af64dd6e45c24a075c2934a50650af219365a7c5b50214a6f0eff0517
MD5 e220c4a41e09900c9c9c87cec2cd2599
BLAKE2b-256 526ac30c3d2eb8653f6da6a6b248b55edee1732e8d426e6f3977f08a6e8f2b31

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