@aws-solutions-konstruk/aws-dynamodb-stream-lambda
v0.8.1
Published
CDK Constructs for AWS DynamoDB Stream to AWS Lambda integration.
Downloads
10
Readme
aws-dynamodb-stream-lambda 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-dynamodb-stream-lambda/| |:-------------|:-------------|
| Language | Package |
|:-------------|-----------------|
|{: style="height:16px;width:16px"} Python|aws_solutions_konstruk.aws_dynamodb_stream_lambda
|
|{: style="height:16px;width:16px"} Typescript|@aws-solutions-konstruk/aws-dynamodb-stream-lambda
|
This AWS Solutions Konstruk 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:
const { DynamoDBStreamToLambdaProps, DynamoDBStreamToLambda} = require('@aws-solutions-konstruk/aws-dynamodb-stream-lambda');
const props: DynamoDBStreamToLambdaProps = {
deployLambda: true,
lambdaFunctionProps: {
code: lambda.Code.asset(`${__dirname}/lambda`),
runtime: lambda.Runtime.NODEJS_12_X,
handler: 'index.handler'
},
};
new DynamoDBStreamToLambda(stack, 'test-dynamodb-stream-lambda', props);
Initializer
new DynamoDBStreamToLambda(scope: Construct, id: string, props: DynamoDBStreamToLambdaProps);
Parameters
- scope
Construct
- id
string
- props
DynamoDBStreamToLambdaProps
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|
|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|
Architecture
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.