CDK constructs for defining an interaction between an Amazon Kinesis Data Stream and an AWS Lambda function.
Project description
aws-kinesisstreams-lambda module
---Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
aws_solutions_constructs.aws-kinesis-streams-lambda |
|
@aws-solutions-constructs/aws-kinesisstreams-lambda |
|
software.amazon.awsconstructs.services.kinesisstreamslambda |
This AWS Solutions Construct deploys a Kinesis Stream and Lambda function with the appropriate resources/properties for interaction and security.
Here is a minimal deployable pattern definition in Typescript:
const { KinesisStreamsToLambda } from '@aws-solutions-constructs/aws-kinesisstreams-lambda';
new KinesisStreamsToLambda(this, 'KinesisToLambdaPattern', {
kinesisEventSourceProps: {
startingPosition: lambda.StartingPosition.TRIM_HORIZON,
batchSize: 1
},
lambdaFunctionProps: {
runtime: lambda.Runtime.NODEJS_10_X,
handler: 'index.handler',
code: lambda.Code.fromAsset(`${__dirname}/lambda`)
}
});
Initializer
new KinesisStreamsToLambda(scope: Construct, id: string, props: KinesisStreamsToLambdaProps);
Parameters
- scope
Construct
- id
string
- props
KinesisStreamsToLambdaProps
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. |
kinesisStreamProps? | kinesis.StreamProps |
Optional user-provided props to override the default props for the Kinesis stream. |
existingStreamObj? | kinesis.Stream |
Existing instance of Kinesis Stream, providing both this and kinesisStreamProps will cause an error. |
kinesisEventSourceProps? | aws-lambda-event-sources.KinesisEventSourceProps |
Optional user-provided props to override the default props for the Lambda event source mapping. |
createCloudWatchAlarms | boolean |
Whether to create recommended CloudWatch alarms |
Pattern Properties
Name | Type | Description |
---|---|---|
kinesisStream | kinesis.Stream |
Returns an instance of the Kinesis stream created by the pattern. |
lambdaFunction | lambda.Function |
Returns an instance of the Lambda function created by the pattern. |
kinesisStreamRole | iam.Role |
Returns an instance of the iam.Role created by the construct for Kinesis stream. |
cloudwatchAlarms? | cloudwatch.Alarm[] |
Returns a list of cloudwatch.Alarm created by the construct |
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
Amazon Kinesis Stream
- Configure least privilege access IAM role for Kinesis Stream
- Enable server-side encryption for Kinesis Stream using AWS Managed KMS Key
- Deploy best practices CloudWatch Alarms for the Kinesis Stream
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
© 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
Hashes for aws-solutions-constructs.aws-kinesis-streams-lambda-1.130.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84ad614dc771c75c494cd3b9844a2c4dc2ddaf6b172b975fa22fec43871af06d |
|
MD5 | a2c486ba711598de69b19b9d9dff0e7b |
|
BLAKE2b-256 | 10edb17619b471fe4930ecc52ad17713c85e3b974fc0120eb6a121a29aeb4f26 |
Hashes for aws_solutions_constructs.aws_kinesis_streams_lambda-1.130.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 883e92f61e7fd1b36280f69b3c3f1d94a74e5554881162e9ec68e35db2f6db59 |
|
MD5 | f0024565874062174a3b124981e76510 |
|
BLAKE2b-256 | 0c3287c8180af0161dd5ea81e05581586dae1a3f39f1b81a73fb8fed08822365 |