@aws-solutions-konstruk/aws-lambda-dynamodb
v0.8.1
Published
CDK Constructs for AWS Lambda to AWS DynamoDB integration.
Downloads
23
Readme
aws-lambda-dynamodb module
This is a developer preview (public beta) module.
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.
| API Reference:| http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-lambda-dynamodb/| |:-------------|:-------------|
| Language | Package |
|:-------------|-----------------|
|{: style="height:16px;width:16px"} Python|aws_solutions_konstruk.aws_lambda_dynamodb
|
|{: style="height:16px;width:16px"} Typescript|@aws-solutions-konstruk/aws-lambda-dynamodb
|
This AWS Solutions Konstruk implements the AWS Lambda function and Amazon DynamoDB table with the least privileged permissions.
Here is a minimal deployable pattern definition:
const { LambdaToDynamoDBProps, LambdaToDynamoDB } = require('@aws-solutions-konstruk/aws-lambda-dynamodb');
const props: LambdaToDynamoDBProps = {
deployLambda: true,
lambdaFunctionProps: {
code: lambda.Code.asset(`${__dirname}/lambda`),
runtime: lambda.Runtime.NODEJS_12_X,
handler: 'index.handler'
},
};
new LambdaToDynamoDB(stack, 'test-lambda-dynamodb-stack', props);
Initializer
new LambdaToDynamoDB(scope: Construct, id: string, props: LambdaToDynamoDBProps);
Parameters
- scope
Construct
- id
string
- props
LambdaToDynamoDBProps
Pattern Construct Props
| Name | Type | Description |
|:-------------|:----------------|-----------------|
|deployLambda|boolean
|Whether to create a new Lambda function or use an existing Lambda function|
|existingLambdaObj?|lambda.Function
|Existing instance of Lambda Function object|
|lambdaFunctionProps?|lambda.FunctionProps
|Optional user provided props to override the default props for Lambda function|
|dynamoTableProps|dynamodb.TableProps
|Optional user provided props to override the default props for DynamoDB Table|
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|
Architecture
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.