Naturally Processed Meals

    @aws-solutions-constructs/aws-kinesisstreams-lambda
    TypeScript icon, indicating that this package has built-in type declarations

    2.30.0 • Public • Published

    aws-kinesisstreams-lambda module


    Stability: Stable


    Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
    Language Package
    Python Logo Python aws_solutions_constructs.aws-kinesis-streams-lambda
    Typescript Logo Typescript @aws-solutions-constructs/aws-kinesisstreams-lambda
    Java Logo Java software.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_14_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_14_X)
                    .code(Code.fromAsset("lambda"))
                    .handler("index.handler")
                    .build())
            .build());

    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

    Architecture Diagram


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

    Install

    npm i @aws-solutions-constructs/aws-kinesisstreams-lambda

    DownloadsWeekly Downloads

    3,733

    Version

    2.30.0

    License

    Apache-2.0

    Unpacked Size

    277 kB

    Total Files

    16

    Last publish

    Collaborators

    • aws-solutions-constructs-team