{"_id":"@aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics","_rev":"2-e3ab99b204c32b4d66af5d01ad6163df","name":"@aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics","dist-tags":{"latest":"0.8.1"},"versions":{"0.8.0":{"name":"@aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics","version":"0.8.0","description":"CDK constructs for defining an interaction between an Amazon Kinesis Data Firehose delivery stream and (1) an Amazon S3 bucket, and (2) an Amazon Kinesis Data Analytics application.","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-kinesisfirehose-s3-and-kinesisanalytics"},"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-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.kinesisfirehoses3kinesisanalytics","maven":{"groupId":"software.amazon.konstruk","artifactId":"kinesisfirehoses3kinesisanalytics"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.KinesisFirehoseS3KinesisAnalytics","packageId":"Amazon.Konstruk.AWS.KinesisFirehoseS3KinesisAnalytics","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-kinesis-firehose-s3-kinesis-analytics","module":"aws_solutions_konstruk.aws_kinesis_firehose_s3_kinesis_analytics"}}},"dependencies":{"@aws-cdk/aws-iam":"~1.25.0","@aws-cdk/aws-kinesis":"~1.25.0","@aws-cdk/aws-kinesisanalytics":"~1.25.0","@aws-cdk/aws-kinesisfirehose":"~1.25.0","@aws-cdk/aws-s3":"~1.25.0","@aws-cdk/core":"~1.25.0","@aws-solutions-konstruk/core":"~0.8.0","@aws-solutions-konstruk/aws-kinesisfirehose-s3":"~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-kinesisanalytics":"~1.25.0","@aws-cdk/aws-kinesisfirehose":"~1.25.0","@aws-cdk/aws-s3":"~1.25.0","@aws-cdk/core":"~1.25.0","@aws-solutions-konstruk/core":"~0.8.0","@aws-solutions-konstruk/aws-kinesisfirehose-s3":"~0.8.0"},"_resolved":"","_integrity":"","_from":"file:/codebuild/output/src873081847/src/deployment/publishing/npm/../../dist/js/aws-kinesisfirehose-s3-and-kinesisanalytics@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-kinesisfirehose-s3-and-kinesisanalytics@0.8.0","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-or51rPD84VIhKHY/dIVfxbhIpU8mr9vKO5hSfkxVsEQkphEJVTcrqOM2Pun8OztF+dox4oNN3J8cdaqnJ7ZngQ==","shasum":"d770c2f6315bc0f81ed97558e8f1f4e4c855fb1d","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics/-/aws-kinesisfirehose-s3-and-kinesisanalytics-0.8.0.tgz","fileCount":14,"unpackedSize":237191,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJefPX0CRA9TVsSAnZWagAAq+wP/1KI2DUaFSjRf8/3tiLk\ns/wjWbVor8B69HClY1EjfEMUQm+OU5v3iX5nhdDwZCk7NxFX9Iwl9Zf/HU7D\nNRgl8Fygk4GmYtAMyN4oD3ZNsilu0nBi7Uzg4rdISHY/3fYrMUKGWC0RGXpf\nCOy0zVUs96iupU1uWDnfdBMW0Pq/xHQSMl6pBSoRmh19Q37MyIKLysWqENlK\nBSs7FEt633HYFZUcCmWprznGcex0R98fStwT1l6rNlf1/JagYGDI8TMAfMGi\n43d2FjiKo2FsWg/wKvV7m52DlqptEdI9EMYzk+6n+dZwEA77MD4a5lm4a7rM\nEClS42240RuCkOJe3IUx6nZUkdrwXN4U0CJ02Kv0SMCs8bPgx3qkDRpcfVkt\nXZefc24OmIMAu4wzCDi+07CO/0oKJNYPBr0uTVKzxJ/rvjVyNlEUe99hnvMn\nhvjTsP5BL2hrEJb/NcHYzNk0Yd7m6ZMPzxqYwK8i9ALD4ecpPtFgvqbVydTt\n4LoYIm9ADsu4oA7MXmIrH+21+zx4rqsg3sBWcQWbQVn6GsvZZjuci3cXzouh\nIVAEKYeXyHduA/cXfcii8JlGxM2fbWGbLW1yQsevo8xJyPug7GS7tvr3NVwv\nz7g9PVkdRdIS5fVF1gwyxjw2+DB9LjgtbqX4IGjX5JEEDY8QErdhZx6Mk7hC\nzToL\r\n=QLNL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDfcd31M+fa8PJsvtCFWbI/wbu0A0rLM7GF/j3PXvvoQwIgYMlq3ic0c3KTa5FbHXdWkuG88XzdoDBkyrwiotch9XI="}]},"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-kinesisfirehose-s3-and-kinesisanalytics_0.8.0_1585247732002_0.04919432217702413"},"_hasShrinkwrap":false},"0.8.1":{"name":"@aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics","version":"0.8.1","description":"CDK constructs for defining an interaction between an Amazon Kinesis Data Firehose delivery stream and (1) an Amazon S3 bucket, and (2) an Amazon Kinesis Data Analytics application.","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-kinesisfirehose-s3-and-kinesisanalytics"},"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-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.kinesisfirehoses3kinesisanalytics","maven":{"groupId":"software.amazon.konstruk","artifactId":"kinesisfirehoses3kinesisanalytics"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.KinesisFirehoseS3KinesisAnalytics","packageId":"Amazon.Konstruk.AWS.KinesisFirehoseS3KinesisAnalytics","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-kinesis-firehose-s3-kinesis-analytics","module":"aws_solutions_konstruk.aws_kinesis_firehose_s3_kinesis_analytics"}}},"dependencies":{"@aws-cdk/aws-iam":"~1.40.0","@aws-cdk/aws-kinesis":"~1.40.0","@aws-cdk/aws-kinesisanalytics":"~1.40.0","@aws-cdk/aws-kinesisfirehose":"~1.40.0","@aws-cdk/aws-s3":"~1.40.0","@aws-cdk/core":"~1.40.0","@aws-solutions-konstruk/core":"~0.8.1","@aws-solutions-konstruk/aws-kinesisfirehose-s3":"~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-kinesisanalytics":"~1.40.0","@aws-cdk/aws-kinesisfirehose":"~1.40.0","@aws-cdk/aws-s3":"~1.40.0","@aws-cdk/core":"~1.40.0","@aws-solutions-konstruk/core":"~0.8.1","@aws-solutions-konstruk/aws-kinesisfirehose-s3":"~0.8.1","constructs":"^3.0.2"},"_resolved":"","_integrity":"","_from":"file:/codebuild/output/src866145426/src/deployment/publishing/npm/../../dist/js/aws-kinesisfirehose-s3-and-kinesisanalytics@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-kinesisfirehose-s3-and-kinesisanalytics@0.8.1","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-WJyKArznJ0taGjkyuzBDMocZtSaBU9t/Kg9yEZv4YcvQ++GpuMRGvOZNm+Q9yJ0C9wqINqdtKUUGb8rd0Sbefg==","shasum":"6a95cba9f70b857d432a1ac9a79686ca0dd79010","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics/-/aws-kinesisfirehose-s3-and-kinesisanalytics-0.8.1.tgz","fileCount":14,"unpackedSize":229599,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJexvQvCRA9TVsSAnZWagAAfKgQAJzIJe0/xKwGYS/S/C/e\nHlNKPMmLHg+x3GKFsqMcwVtlqkBhQe2UXl4hggzERVT/9/bXfrPCOwp04awN\n005aoOvSTTXH4ZslQprASyVLncv8UUc+iYpQqjibhFT+/XE9ycOnngOIP7we\nh/XoTu4gVKyfJfcBOLJeArYMGtZrahC9AZOCT5dYXgPT1UagF7pI+UWwQ61V\nIzWwicnDyHFeSuNdPzIeLnhTMdQZ1in8+nNRFfGIUhvAk+g8CD0ri23OT6VF\neI/bsN64/ES7/8WbyI3TOqN5LTeNdzM11mGMSEV9sE2EQdeddpZbbcIReUs/\nNUcrRaeGIKZ/ARK+5QPcvlm9jgbBlnySb4+evQdmO+2CF6xRRbiVLtcmtmyP\nW8nI922q/7hAqC8w0qJeXvjXQ62b8kOHW6Oytspat7NNhy3iTsNqOxXNQpP8\n+cFO8oHQ+UJAy8suH2NWuCgkvhk7WnrUXmLt9PzBIUXbQLR1x4CXN1ok7CVG\n6HcNn90kc7e72nzhIhPZJ/kAbeUBlERyUQaNZN+q2oNpiJFHSzHTnwF13L/0\n6LjRjZQNLyYwk4UPAd8LN7gxW6MHE/z5IScfPIC5xLmAR+d9I615ewZ53R+s\nAIEGqxfS5zQB52/1TKao/5OKBpGaOiuEzVAUGXDPgLM0Cjsc++NADmqmeZiK\n8GHY\r\n=HA6n\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG6lCCNh/h13jjB453xc9gYVdhFC1ytmJyxBJWNFG71TAiEAlHhF+G1E45RR9SypwVg3ceh6fs5Bs067F55//EdFTZ0="}]},"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-kinesisfirehose-s3-and-kinesisanalytics_0.8.1_1590096943324_0.4215118872322994"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-26T18:35:31.771Z","0.8.0":"2020-03-26T18:35:32.132Z","modified":"2022-04-04T17:05:45.662Z","0.8.1":"2020-05-21T21:35:43.513Z"},"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 Firehose delivery stream and (1) an Amazon S3 bucket, and (2) an Amazon Kinesis Data Analytics application.","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-kinesisfirehose-s3-and-kinesisanalytics"},"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-kinesisfirehose-s3-and-kinesisanalytics 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-kinesisfirehose-s3-and-kinesisanalytics/</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_kinesisfirehose_s3_and_kinesisanalytics`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png){: style=\"height:16px;width:16px\"} Typescript|`@aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics`|\n\nThis AWS Solutions Konstruk implements an Amazon Kinesis Firehose delivery stream connected to:\n1. An Amazon S3 bucket, and\n1. An Amazon Kinesis Analytics application.\n\nHere is a minimal deployable pattern definition:\n\n``` javascript\nconst { KinesisFirehoseToAnalyticsAndS3 } = require('@aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics');\n\nnew KinesisFirehoseToAnalyticsAndS3(stack, 'FirehoseToS3AndAnalyticsPattern', {\n    kinesisAnalyticsProps: {\n        inputs: [{\n            inputSchema: {\n                recordColumns: [{\n                    name: 'ticker_symbol',\n                    sqlType: 'VARCHAR(4)',\n                    mapping: '$.ticker_symbol'\n                }, {\n                    name: 'sector',\n                    sqlType: 'VARCHAR(16)',\n                    mapping: '$.sector'\n                }, {\n                    name: 'change',\n                    sqlType: 'REAL',\n                    mapping: '$.change'\n                }, {\n                    name: 'price',\n                    sqlType: 'REAL',\n                    mapping: '$.price'\n                }],\n                recordFormat: {\n                    recordFormatType: 'JSON'\n                },\n                recordEncoding: 'UTF-8'\n            },\n            namePrefix: 'SOURCE_SQL_STREAM'\n        }]\n    }\n});\n\n```\n\n## Initializer\n\n``` text\nnew KinesisFirehoseToAnalyticsAndS3(scope: Construct, id: string, props: KinesisFirehoseToAnalyticsAndS3Props);\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 [`KinesisFirehoseToAnalyticsAndS3Props`](#pattern-construct-props)\n\n## Pattern Construct Props\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|kinesisFirehoseProps?|[`kinesisFirehose.CfnDeliveryStreamProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesisfirehose.CfnDeliveryStreamProps.html)|Optional user-provided props to override the default props for the Kinesis Firehose delivery stream.|\n|kinesisAnalyticsProps?|[`kinesisAnalytics.CfnApplicationProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesisanalytics.CfnApplicationProps.html)|Optional user-provided props to override the default props for the Kinesis Analytics application.|\n|deployBucket?|`boolean`|Whether to create a S3 Bucket or use an existing S3 Bucket|\n|existingBucketObj?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.Bucket.html)|Existing instance of S3 Bucket object|\n|bucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.BucketProps.html)|Optional user provided props to override the default props for S3 Bucket|\n\n## Pattern Properties\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|kinesisAnalytics()|[`kinesisAnalytics.CfnApplication`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesisanalytics.CfnApplication.html)|Returns an instance of the Kinesis Analytics application created by the pattern.|\n|kinesisFirehose()|[`kinesisFirehose.CfnDeliveryStream`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesisfirehose.CfnDeliveryStream.html)|Returns an instance of the Kinesis Firehose delivery stream created by the pattern.|\n|bucket()|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.Bucket.html)|Returns an instance of the S3 bucket 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"}