aws-kinesisstreams-lambda module

This is a developer preview (public beta) 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.

| API Reference:| http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-kinesisstreams-lambda/| |:-------------|:-------------|

| Language | Package | |:-------------|-----------------| |{: style="height:16px;width:16px"} Python|aws_solutions_konstruk.aws_kinesisstreams_lambda| |{: style="height:16px;width:16px"} Typescript|@aws-solutions-konstruk/aws-kinesisstreams-lambda|

This AWS Solutions Konstruk 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-konstruk/aws-kinesisstreams-lambda');

new KinesisStreamsToLambda(stack, 'KinesisToLambdaPattern', {
    deployLambda: true,
    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

• scope Construct
• id string
• props KinesisStreamsToLambdaProps

Pattern Construct Props

| Name | Type | Description | |:-------------|:----------------|-----------------| |deployLambda|boolean|Whether to create a new Lambda function or use an existing Lambda function. If set to false, you must provide an existing function for the existingLambdaObj property.| |existingLambdaObj?|lambda.Function|An optional, existing Lambda function. This property is required if deployLambda is set to false.| |lambdaFunctionProps?|lambda.FunctionProps|Optional user-provided props to override the default props for the Lambda function. This property is only required if deployLambda is set to true.| |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.| |encryptionKeyProps?|kms.KeyProps|Optional user-provided props to override the default props for the KMS encryption key.|

Pattern Properties

| Name | Type | Description | |:-------------|:----------------|-----------------| |stream()|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.|

Architecture

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