aws-kinesisstreams-lambda - AWS Solutions Constructs

aws-kinesisstreams-lambda

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.

Language Package
Python
aws_solutions_constructs.aws-kinesis-streams-lambda
Typescript
@aws-solutions-constructs/aws-kinesisstreams-lambda
Java
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:

import { 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

Pattern Construct Props

Name Type Description
existingLambdaObj? lambda.Function An optional, existing Lambda function to be used instead of the default function. If an existing function is provided, the lambdaFunctionProps property will be ignored.
lambdaFunctionProps? lambda.FunctionProps Optional user-provided properties to override the default properties for the Lambda function. Ignored if an existingLambdaObj is provided.
kinesisStreamProps? kinesis.StreamProps Optional user-provided props to override the default props for the Kinesis stream.
existingStreamObj? kinesis.Stream An optional, existing Kinesis stream to be used instead of the default stream. If an existing stream is provided, the kinesisStreamProps property will be 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 pattern for the Kinesis stream.
cloudwatchAlarms? cloudwatch.Alarm[] Returns a list of one or more CloudWatch alarms created by the pattern.

Default settings

Out-of-the-box implementation of this pattern without any overrides 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-practice 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: enable bisect on function Error; set default Maximum Record Age (24 hours); set default 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

GitHub

To view the code for this pattern, create/view issues and pull requests, and more:
@aws-solutions-constructs/aws-kinesisstreams-lambda