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_kinesisstreams_lambda
Typescript
@aws-solutions-constructs/aws-kinesisstreams-lambda
Java
software.amazon.awsconstructs.services.kinesisstreamslambda

This AWS Solutions Constructs deploys a Kinesis Stream and Lambda function with the appropriate resources/properties for interaction and security.

Here is a minimal deployable pattern definition:

const { KinesisStreamsToLambda } = require('@aws-solutions-constructs/aws-kinesisstreams-lambda'); new KinesisStreamsToLambda(stack, 'KinesisToLambdaPattern', { eventSourceProps: { startingPosition: lambda.StartingPosition.TRIM_HORIZON, batchSize: 1 }, lambdaFunctionProps: { runtime: lambda.Runtime.NODEJS_10_X, handler: 'index.handler', code: lambda.Code.asset(`${__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.
eventSourceProps? lambda.EventSourceMappingOptions Optional user-provided props to override the default props for the Lambda event source mapping.

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.

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

AWS Lambda Function

  • Configure least privilege access IAM role for Lambda function

  • Enable reusing connections with Keep-Alive for NodeJs Lambda function

Architecture