{"_id":"@aws-solutions-konstruk/aws-kinesisstreams-lambda","_rev":"2-2f1862198fc899c8bf97902dc9c177e5","name":"@aws-solutions-konstruk/aws-kinesisstreams-lambda","dist-tags":{"latest":"0.8.1"},"versions":{"0.8.0":{"name":"@aws-solutions-konstruk/aws-kinesisstreams-lambda","version":"0.8.0","description":"CDK constructs for defining an interaction between an Amazon Kinesis Data Stream and an AWS Lambda function.","main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/awslabs/aws-solutions-konstruk.git","directory":"source/patterns/@aws-solutions-konstruk/aws-kinesisstreams-lambda"},"author":{"name":"Amazon Web Services","url":"https://aws.amazon.com"},"license":"Apache-2.0","scripts":{"build":"tsc -b .","lint":"eslint -c ../eslintrc.yml --ext=.js,.ts . && tslint --project .","lint-fix":"eslint -c ../eslintrc.yml --ext=.js,.ts --fix .","test":"jest --coverage","clean":"tsc -b --clean","watch":"tsc -b -w","integ":"cdk-integ","integ-no-clean":"cdk-integ --no-clean","integ-assert":"cdk-integ-assert","jsii":"jsii","jsii-pacmak":"jsii-pacmak","build+lint+test":"npm run jsii && npm run lint && npm test && npm run integ-assert","snapshot-update":"npm run jsii && npm test -- -u && npm run integ-assert"},"jsii":{"outdir":"dist","targets":{"java":{"package":"software.amazon.konstruk.services.kinesisstreamslambda","maven":{"groupId":"software.amazon.konstruk","artifactId":"kinesisstreamslambda"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.KinesisStreamsLambda","packageId":"Amazon.Konstruk.AWS.KinesisStreamsLambda","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-kinesis-streams-lambda","module":"aws_solutions_konstruk.aws_kinesis_streams_lambda"}}},"dependencies":{"@aws-cdk/aws-iam":"~1.25.0","@aws-cdk/aws-kinesis":"~1.25.0","@aws-cdk/aws-kms":"~1.25.0","@aws-cdk/aws-lambda":"~1.25.0","@aws-cdk/core":"~1.25.0","@aws-solutions-konstruk/core":"~0.8.0"},"devDependencies":{"@aws-cdk/assert":"~1.25.0","@types/jest":"^24.0.23","@types/node":"^10.3.0"},"jest":{"moduleFileExtensions":["js"]},"peerDependencies":{"@aws-cdk/aws-iam":"~1.25.0","@aws-cdk/aws-kinesis":"~1.25.0","@aws-cdk/aws-kms":"~1.25.0","@aws-cdk/aws-lambda":"~1.25.0","@aws-cdk/core":"~1.25.0","@aws-solutions-konstruk/core":"~0.8.0"},"_resolved":"","_integrity":"","_from":"file:/codebuild/output/src873081847/src/deployment/publishing/npm/../../dist/js/aws-kinesisstreams-lambda@0.8.0.jsii.tgz","bugs":{"url":"https://github.com/awslabs/aws-solutions-konstruk/issues"},"homepage":"https://github.com/awslabs/aws-solutions-konstruk#readme","_id":"@aws-solutions-konstruk/aws-kinesisstreams-lambda@0.8.0","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-vQjT/vaNjgOl+oGgqRC15Zm5KeZVX6m1eX/OAWNseBxyS7149XW/fjK2nsmm//CaTZ/hb+CwPVIl7XJFmXjpjQ==","shasum":"f2af053cb8af5a890c64cee06417542067d16ad3","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-kinesisstreams-lambda/-/aws-kinesisstreams-lambda-0.8.0.tgz","fileCount":14,"unpackedSize":202255,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJefPWDCRA9TVsSAnZWagAAFcQP/3nBiCuycJgwAdeT5zxa\nFyPEGJ5KJE2NFzq48k7u1wxfOQUjV0DJVuJ1ufx5uGCgh2OD5cyvvKT/EW8I\nhWRKYU4PiWYAwfIcaCp6lE9LQiMOVmsjcvVwzE6N8mZEgNNvUu65qclxpmZJ\njd1rTLeStJ9nOtgXTF6uB0tOWdLRvvj9HUddqF9D5JTGo4vcYd1hKu/KimEQ\nm4IBpg7FnrMuCkDKowSvQpoL8ADXOZsto0MaCjezHZbzr/KGnbIEP+NS3a1v\nfjV3dOkDJR+3WhPK+Ql0IeiSNt/xIjh/zSvrwJ5c648qMEn9r8w2arG4Qk1S\nNxZQnldB37LdcxQHvdgl9m2toF58dfShAW2163e60nYpN64Po638EO6TDZIm\nfCr127KFCzdFq2rRue9FjtV4NadU1UBkLIm2Wesc00Pf5IGaTac9qYY78t55\nZWf45bp0PXZfgA+AvryjqNm2gIVJNRHnOIZXHxTgavVAJS7q3mVNboXtZA7S\nVgnW6+PlfDmTNWmUwmGzyxuIVf7DvdT9dzeCQPNyh34NfZJeJt6g8bggjl+c\neEW/1pAOdyO0y5mZJYvoQwGNhHnfyyC2FPLom2fP/CrEsinCPlAthxNk8562\nk0PZDW/ZdI670nTZzs3g1XTRR/DLFQaT41ti3sNPfq+VRxcS62gZshZUkTLy\n+AY0\r\n=li1g\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC44mEC0aFrZKOqKG3qhpOMyjAK8wmfjjngrU9dx3GQOAiEA5KkaK19WYhEQzQ86WIYoBI2kUXd4GRqhpQt+SF7YXvk="}]},"maintainers":[{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"}],"_npmUser":{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aws-kinesisstreams-lambda_0.8.0_1585247619184_0.3696063403022283"},"_hasShrinkwrap":false},"0.8.1":{"name":"@aws-solutions-konstruk/aws-kinesisstreams-lambda","version":"0.8.1","description":"CDK constructs for defining an interaction between an Amazon Kinesis Data Stream and an AWS Lambda function.","main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/awslabs/aws-solutions-konstruk.git","directory":"source/patterns/@aws-solutions-konstruk/aws-kinesisstreams-lambda"},"author":{"name":"Amazon Web Services","url":"https://aws.amazon.com"},"license":"Apache-2.0","scripts":{"build":"tsc -b .","lint":"eslint -c ../eslintrc.yml --ext=.js,.ts . && tslint --project .","lint-fix":"eslint -c ../eslintrc.yml --ext=.js,.ts --fix .","test":"jest --coverage","clean":"tsc -b --clean","watch":"tsc -b -w","integ":"cdk-integ","integ-no-clean":"cdk-integ --no-clean","integ-assert":"cdk-integ-assert","jsii":"jsii","jsii-pacmak":"jsii-pacmak","build+lint+test":"npm run jsii && npm run lint && npm test && npm run integ-assert","snapshot-update":"npm run jsii && npm test -- -u && npm run integ-assert"},"jsii":{"outdir":"dist","targets":{"java":{"package":"software.amazon.konstruk.services.kinesisstreamslambda","maven":{"groupId":"software.amazon.konstruk","artifactId":"kinesisstreamslambda"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.KinesisStreamsLambda","packageId":"Amazon.Konstruk.AWS.KinesisStreamsLambda","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-kinesis-streams-lambda","module":"aws_solutions_konstruk.aws_kinesis_streams_lambda"}}},"dependencies":{"@aws-cdk/aws-iam":"~1.40.0","@aws-cdk/aws-kinesis":"~1.40.0","@aws-cdk/aws-kms":"~1.40.0","@aws-cdk/aws-lambda":"~1.40.0","@aws-cdk/core":"~1.40.0","@aws-solutions-konstruk/core":"~0.8.1","constructs":"^3.0.2"},"devDependencies":{"@aws-cdk/assert":"~1.40.0","@types/jest":"^24.0.23","@types/node":"^10.3.0"},"jest":{"moduleFileExtensions":["js"]},"peerDependencies":{"@aws-cdk/aws-iam":"~1.40.0","@aws-cdk/aws-kinesis":"~1.40.0","@aws-cdk/aws-kms":"~1.40.0","@aws-cdk/aws-lambda":"~1.40.0","@aws-cdk/core":"~1.40.0","@aws-solutions-konstruk/core":"~0.8.1","constructs":"^3.0.2"},"_resolved":"","_integrity":"","_from":"file:/codebuild/output/src866145426/src/deployment/publishing/npm/../../dist/js/aws-kinesisstreams-lambda@0.8.1.jsii.tgz","bugs":{"url":"https://github.com/awslabs/aws-solutions-konstruk/issues"},"homepage":"https://github.com/awslabs/aws-solutions-konstruk#readme","_id":"@aws-solutions-konstruk/aws-kinesisstreams-lambda@0.8.1","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-L4Bf4LXsXywCQyQOVXO1wl7XGz00+XncbcF4Ej0vqgqoR/ErWXfOV2d5iN3RUerdBDb4JZRc9MhbKDZHWC+R5Q==","shasum":"b7cd0d917cdae4665a21ae4667431ba185e78569","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-kinesisstreams-lambda/-/aws-kinesisstreams-lambda-0.8.1.tgz","fileCount":14,"unpackedSize":194951,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJexvPaCRA9TVsSAnZWagAA6wsP/33nGVWc8qQqU+usKl8u\nwk8mZI/cxzNsRHB4O73BKMruYoDqFEAlqg8lVuA+90IbH2gKrv/sk3sSpXQZ\n1J8xd4iQg2qBJYYI/jEb749nImy41DEvvMtU6+waaW19AjHdBmUyrlA82XOG\nRXuSQTTRSf7is9znZalfhTJHgvD+L38wrCHpzG3GfJEC8s495r38Vem6B9K4\naEQuJe5HjcXSxC6bxBSKAmjbWq3IlchOAvPTUs/oZ/bHe/75z7YOTBPmRzd2\nGsvyqEvGK0UUa5480DlzE4mTJT2oNhz5/DKM4HMNEz3b26LbssPffyLjfa3q\njxvGAEbEiT1iQpcBI3Sqj1KioGo5jNMQt5kjNAhZdnwgUzbks9d91pTJZyWq\nTqyanFB7SE4HFLjnFDFidW+I0z29KhI3YysU8XKuCop7eglwsHJRZLITPbtz\nU/ygb+eSf+0KLsqGIdbdOkOZj1bVDgD3plDuXexQA77OBMJeaUwsp4rrRied\nRlz5sicdzF6g4Hgv+sZbWgHIBzRk9BerCcni7rwxreR6Hg0mXrCuC/EuZdhG\n6rHffvmYjGcaqoS68hbHenjChMUeyTKp+0GJbkFoxXaK2q2OqhDE2rBA9LVa\nyweCHzDGgxN5R331Mv/oSEOfeywVtS+BepItWPYB8jrI0pA/nJ1sWg3VO26l\najCL\r\n=KT+Q\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCXUnoykyYEIbLQXbRE4omKi1oTaAeRLLvK3S+ugOi2UgIgP4M+SK67Bd3jEOyd7mul8Afc0RRBJKKt8Zscx8CsoaY="}]},"maintainers":[{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"}],"_npmUser":{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aws-kinesisstreams-lambda_0.8.1_1590096858505_0.896566364204803"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-26T18:33:38.947Z","0.8.0":"2020-03-26T18:33:39.280Z","modified":"2022-04-04T17:05:45.896Z","0.8.1":"2020-05-21T21:34:18.637Z"},"maintainers":[{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"}],"description":"CDK constructs for defining an interaction between an Amazon Kinesis Data Stream and an AWS Lambda function.","homepage":"https://github.com/awslabs/aws-solutions-konstruk#readme","repository":{"type":"git","url":"git+https://github.com/awslabs/aws-solutions-konstruk.git","directory":"source/patterns/@aws-solutions-konstruk/aws-kinesisstreams-lambda"},"author":{"name":"Amazon Web Services","url":"https://aws.amazon.com"},"bugs":{"url":"https://github.com/awslabs/aws-solutions-konstruk/issues"},"license":"Apache-2.0","readme":"# aws-kinesisstreams-lambda module\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)\n\n> **This is a _developer preview_ (public beta) module.**\n>\n> All classes are under active development and subject to non-backward compatible changes or removal in any\n> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.\n> 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.\n\n---\n<!--END STABILITY BANNER-->\n\n| **API Reference**:| <span style=\"font-weight: normal\">http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-kinesisstreams-lambda/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\n\n| **Language**     | **Package**        |\n|:-------------|-----------------|\n|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png){: style=\"height:16px;width:16px\"} Python|`aws_solutions_konstruk.aws_kinesisstreams_lambda`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png){: style=\"height:16px;width:16px\"} Typescript|`@aws-solutions-konstruk/aws-kinesisstreams-lambda`|\n\nThis AWS Solutions Konstruk deploys a Kinesis Stream and Lambda function with the appropriate resources/properties for interaction and security.\n\nHere is a minimal deployable pattern definition:\n\n``` javascript\nconst { KinesisStreamsToLambda } = require('@aws-solutions-konstruk/aws-kinesisstreams-lambda');\n\nnew KinesisStreamsToLambda(stack, 'KinesisToLambdaPattern', {\n    deployLambda: true,\n    eventSourceProps: {\n        startingPosition: lambda.StartingPosition.TRIM_HORIZON,\n        batchSize: 1\n    },\n    lambdaFunctionProps: {\n        runtime: lambda.Runtime.NODEJS_10_X,\n        handler: 'index.handler',\n        code: lambda.Code.asset(`${__dirname}/lambda`)\n    }\n});\n\n```\n\n## Initializer\n\n``` text\nnew KinesisStreamsToLambda(scope: Construct, id: string, props: KinesisStreamsToLambdaProps);\n```\n\n_Parameters_\n\n* scope [`Construct`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html)\n* id `string`\n* props [`KinesisStreamsToLambdaProps`](#pattern-construct-props)\n\n## Pattern Construct Props\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|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.|\n|existingLambdaObj?|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html)|An optional, existing Lambda function. This property is required if `deployLambda` is set to false.|\n|lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.FunctionProps.html)|Optional user-provided props to override the default props for the Lambda function. This property is only required if `deployLambda` is set to true.|\n|kinesisStreamProps?|[`kinesis.StreamProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesis.StreamProps.html)|Optional user-provided props to override the default props for the Kinesis stream.|\n|eventSourceProps?|[`lambda.EventSourceMappingOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.EventSourceMappingOptions.html)|Optional user-provided props to override the default props for the Lambda event source mapping.|\n|encryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.KeyProps.html)|Optional user-provided props to override the default props for the KMS encryption key.|\n\n## Pattern Properties\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|stream()|[`kinesis.Stream`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesis.Stream.html)|Returns an instance of the Kinesis stream created by the pattern.|\n|lambdaFunction()|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html)|Returns an instance of the Lambda function created by the pattern.|\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.","readmeFilename":"README.md"}