2.57.0 • Published 2 days ago

@aws-solutions-constructs/aws-kinesisstreams-lambda v2.57.0

Weekly downloads
282
License
Apache-2.0
Repository
github
Last release
2 days ago

aws-kinesisstreams-lambda module


Stability: Stable


Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws-kinesis-streams-lambda
Typescript Logo Typescript@aws-solutions-constructs/aws-kinesisstreams-lambda
Java Logo Javasoftware.amazon.awsconstructs.services.kinesisstreamslambda

Overview

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:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { KinesisStreamsToLambda } from '@aws-solutions-constructs/aws-kinesisstreams-lambda';
import * as lambda from 'aws-cdk-lib/aws-lambda';

new KinesisStreamsToLambda(this, 'KinesisToLambdaPattern', {
  kinesisEventSourceProps: {
    startingPosition: lambda.StartingPosition.TRIM_HORIZON,
    batchSize: 1
  },
  lambdaFunctionProps: {
    runtime: lambda.Runtime.NODEJS_16_X,
    handler: 'index.handler',
    code: lambda.Code.fromAsset(`lambda`)
  }
});

Python

from aws_solutions_constructs.aws_kinesis_streams_lambda import KinesisStreamsToLambda
from aws_cdk import (
    aws_lambda as _lambda,
    aws_lambda_event_sources as sources,
    aws_kinesis as kinesis,
    Stack
)
from constructs import Construct

KinesisStreamsToLambda(self, 'KinesisToLambdaPattern',
                        kinesis_event_source_props=sources.KinesisEventSourceProps(
                            starting_position=_lambda.StartingPosition.TRIM_HORIZON,
                            batch_size=1
                        ),
                        lambda_function_props=_lambda.FunctionProps(
                            runtime=_lambda.Runtime.PYTHON_3_9,
                            handler='index.handler',
                            code=_lambda.Code.from_asset(
                                'lambda')
                        )
                        )

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.lambda.eventsources.*;
import software.amazon.awscdk.services.lambda.Runtime;
import software.amazon.awsconstructs.services.kinesisstreamslambda.*;

new KinesisStreamsToLambda(this, "KinesisToLambdaPattern", new KinesisStreamsToLambdaProps.Builder()
        .kinesisEventSourceProps(new KinesisEventSourceProps.Builder()
                .startingPosition(StartingPosition.TRIM_HORIZON)
                .batchSize(1)
                .build())
        .lambdaFunctionProps(new FunctionProps.Builder()
                .runtime(Runtime.NODEJS_16_X)
                .code(Code.fromAsset("lambda"))
                .handler("index.handler")
                .build())
        .build());

Pattern Construct Props

NameTypeDescription
existingLambdaObj?lambda.FunctionExisting instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?lambda.FunctionPropsUser provided props to override the default props for the Lambda function.
kinesisStreamProps?kinesis.StreamPropsOptional user-provided props to override the default props for the Kinesis stream.
existingStreamObj?kinesis.StreamExisting instance of Kinesis Stream, providing both this and kinesisStreamProps will cause an error.
kinesisEventSourceProps?aws-lambda-event-sources.KinesisEventSourcePropsOptional user-provided props to override the default props for the Lambda event source mapping.
createCloudWatchAlarmsbooleanWhether to create recommended CloudWatch alarms

Pattern Properties

NameTypeDescription
kinesisStreamkinesis.StreamReturns an instance of the Kinesis stream created by the pattern.
lambdaFunctionlambda.FunctionReturns an instance of the Lambda function created by the pattern.
kinesisStreamRoleiam.RoleReturns 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

Architecture Diagram


© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

2.57.0

2 days ago

2.56.0

14 days ago

2.55.0

26 days ago

2.54.1

1 month ago

2.54.0

2 months ago

2.53.0

3 months ago

2.52.1

3 months ago

2.52.0

3 months ago

2.51.0

3 months ago

2.50.0

3 months ago

2.49.0

4 months ago

2.48.0

4 months ago

2.47.0

5 months ago

2.46.0

6 months ago

2.45.0

7 months ago

2.44.0

8 months ago

2.43.0

8 months ago

2.43.1

8 months ago

2.42.0

9 months ago

2.41.0

11 months ago

2.40.0

11 months ago

2.39.0

1 year ago

2.38.0

1 year ago

2.37.0

1 year ago

2.34.0

1 year ago

2.33.0

1 year ago

2.32.0

1 year ago

2.31.0

1 year ago

2.36.0

1 year ago

2.35.0

1 year ago

2.30.0

1 year ago

2.27.0

2 years ago

1.176.0

1 year ago

2.26.0

2 years ago

1.175.0

1 year ago

1.179.0

1 year ago

2.29.0

1 year ago

1.181.0

1 year ago

1.181.1

1 year ago

1.174.0

1 year ago

1.178.0

1 year ago

2.28.0

1 year ago

1.180.0

1 year ago

1.177.0

1 year ago

1.168.0

2 years ago

2.19.0

2 years ago

1.172.0

2 years ago

2.22.0

2 years ago

1.167.0

2 years ago

2.18.0

2 years ago

2.21.0

2 years ago

1.171.0

2 years ago

2.25.0

2 years ago

2.17.0

2 years ago

1.170.0

2 years ago

2.20.0

2 years ago

1.170.1

2 years ago

2.24.0

2 years ago

1.169.0

2 years ago

2.16.0

2 years ago

1.173.0

2 years ago

2.23.0

2 years ago

2.11.0

2 years ago

1.160.0

2 years ago

1.164.0

2 years ago

1.157.0

2 years ago

1.163.0

2 years ago

2.10.0

2 years ago

1.163.2

2 years ago

1.163.1

2 years ago

2.14.0

2 years ago

1.162.0

2 years ago

1.166.1

2 years ago

2.13.0

2 years ago

1.159.0

2 years ago

2.12.0

2 years ago

1.161.0

2 years ago

1.165.0

2 years ago

2.9.0

2 years ago

1.158.0

2 years ago

2.8.0

2 years ago

1.153.0

2 years ago

1.153.1

2 years ago

2.7.0

2 years ago

1.156.0

2 years ago

1.156.1

2 years ago

2.6.0

2 years ago

1.155.0

2 years ago

1.154.0

2 years ago

2.4.0

2 years ago

1.149.0

2 years ago

1.148.0

2 years ago

1.152.0

2 years ago

1.147.0

2 years ago

1.151.0

2 years ago

2.5.0

2 years ago

1.150.0

2 years ago

1.145.0

2 years ago

1.141.0

2 years ago

1.144.0

2 years ago

1.140.0

2 years ago

1.143.0

2 years ago

1.142.0

2 years ago

1.146.0

2 years ago

1.134.0

2 years ago

1.130.0

2 years ago

1.138.2

2 years ago

1.138.1

2 years ago

1.138.0

2 years ago

2.3.0

2 years ago

1.133.0

2 years ago

1.137.0

2 years ago

2.2.0

2 years ago

1.132.0

2 years ago

1.136.0

2 years ago

2.1.0

2 years ago

1.131.0

2 years ago

1.139.0

2 years ago

1.135.0

2 years ago

2.0.0

2 years ago

1.129.0

2 years ago

1.128.0

2 years ago

1.127.0

2 years ago

2.0.0-rc.2

3 years ago

1.126.0

3 years ago

2.0.0-rc.1

3 years ago

1.125.0

3 years ago

1.124.0

3 years ago

1.123.0

3 years ago

1.122.0

3 years ago

1.121.0

3 years ago

1.120.0

3 years ago

1.119.0

3 years ago

1.118.0

3 years ago

1.117.0

3 years ago

1.115.0

3 years ago

1.116.0

3 years ago

1.113.0

3 years ago

1.114.0

3 years ago

1.112.0

3 years ago

1.111.0

3 years ago

1.110.1

3 years ago

1.109.0

3 years ago

1.108.1

3 years ago

1.110.0

3 years ago

1.108.0

3 years ago

1.107.0

3 years ago

1.106.1

3 years ago

1.105.0

3 years ago

1.106.0

3 years ago

1.101.0

3 years ago

1.103.0

3 years ago

1.99.0

3 years ago

1.100.0

3 years ago

1.104.0

3 years ago

1.102.0

3 years ago

1.98.0

3 years ago

1.97.0

3 years ago

1.96.0

3 years ago

1.94.1

3 years ago

1.95.2

3 years ago

1.95.1

3 years ago

1.95.0

3 years ago

1.94.0

3 years ago

1.92.0

3 years ago

1.93.0

3 years ago

1.91.0

3 years ago

1.90.1

3 years ago

1.90.0

3 years ago

1.89.0

3 years ago

1.88.0

3 years ago

1.87.1

3 years ago

1.86.0

3 years ago

1.87.0

3 years ago

1.85.0

3 years ago

1.84.0

3 years ago

1.82.0

3 years ago

1.83.0

3 years ago

1.81.0

3 years ago

1.80.0

3 years ago

1.79.0

3 years ago

1.78.0

3 years ago

1.77.0

3 years ago

1.76.0

3 years ago

1.75.0

3 years ago

1.74.0

3 years ago

1.73.0

3 years ago

1.72.0

3 years ago

1.71.0

4 years ago

1.70.0

4 years ago

1.69.0

4 years ago

1.68.0

4 years ago

1.67.0

4 years ago

1.66.0

4 years ago

1.65.0

4 years ago

1.64.1

4 years ago

1.64.0

4 years ago

1.63.0

4 years ago

1.62.0

4 years ago

1.61.1

4 years ago

1.61.0

4 years ago

1.60.0

4 years ago

1.59.0

4 years ago

1.58.0

4 years ago

1.57.0

4 years ago

1.56.0

4 years ago

1.55.0

4 years ago

1.54.0

4 years ago

1.53.0

4 years ago

1.52.0

4 years ago

1.51.0

4 years ago

1.50.0

4 years ago

1.49.0

4 years ago

1.48.0

4 years ago

1.47.0

4 years ago

1.46.0

4 years ago