Categorygithub.com/christian-korneck/awssc-go-dist/awssolutionsconstructsawslambdadynamodb/v2
modulepackage
2.2.0
Repository: https://github.com/christian-korneck/awssc-go-dist.git
Documentation: pkg.go.dev

# README

aws-lambda-dynamodb module


Stability: Stable


Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws_lambda_dynamodb
Typescript Logo Typescript@aws-solutions-constructs/aws-lambda-dynamodb
Java Logo Javasoftware.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

NameTypeDescription
existingLambdaObj?lambda.FunctionExisting instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?lambda.FunctionPropsUser provided props to override the default props for the Lambda function.
dynamoTableProps?dynamodb.TablePropsOptional user provided props to override the default props for DynamoDB Table
existingTableObj?dynamodb.TableExisting instance of DynamoDB table object, providing both this and dynamoTableProps will cause an error.
tablePermissions?stringOptional table permissions to grant to the Lambda function. One of the following may be specified: All, Read, ReadWrite, Write.
tableEnvironmentVariableName?stringOptional Name for the DynamoDB table environment variable set for the Lambda function.
existingVpc?ec2.IVpcAn 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.VpcPropsOptional 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?booleanWhether 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

NameTypeDescription
lambdaFunctionlambda.FunctionReturns an instance of lambda.Function created by the construct
dynamoTabledynamodb.TableReturns an instance of dynamodb.Table created by the construct
vpc?ec2.IVpcReturns 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.

# Packages

Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

# Functions

Checks if `x` is a construct.
No description provided by the author
No description provided by the author

# Structs

No description provided by the author

# Interfaces

No description provided by the author