CDK constructs for defining an interaction between an Amazon Kinesis Data Stream and an AWS Lambda function.
Project description
aws-kinesisstreams-lambda 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.
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', {
eventSourceProps: {
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, if this is set then the lambdaFunctionProps is ignored. |
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, if this is set then kinesisStreamProps is ignored. |
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
Architecture
© Copyright 2020 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.75.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9f66f331bd09a9d1963c9a2b1a61503cbfc74a7b31ac2561553f18fef0decd1 |
|
MD5 | 5066d1b801ab14029bc193f0fbf0f472 |
|
BLAKE2b-256 | 907d3ff3b7ebe1e1edc73db6089b2905a496944c29c733fbc7ab3647c09cf43f |
Hashes for aws_solutions_constructs.aws_kinesis_streams_lambda-1.75.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2d12cfc2b7f4617e093f027080da92ff45ae10f44ae0b9ffe682323ed0119e0 |
|
MD5 | d59eedb8c2e24e21808a67db99c0a654 |
|
BLAKE2b-256 | 8326fd12451c3fa06740e61c202c462071bbc414f7f850959713118d12dd3e4f |