{"_id":"@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3","_rev":"2-46244bd86737c96cb60f70586e2eb22f","name":"@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3","dist-tags":{"latest":"0.8.1"},"versions":{"0.8.0":{"name":"@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3","version":"0.8.0","description":"CDK Constructs for AWS IoT to AWS Kinesis Firehose to AWS S3 integration.","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-iot-kinesisfirehose-s3"},"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.iotkinesisfirehoses3","maven":{"groupId":"software.amazon.konstruk","artifactId":"iotkinesisfirehoses3"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.IotKinesisfirehoseS3","packageId":"Amazon.Konstruk.AWS.IotKinesisfirehoseS3","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-iot-kinesisfirehose-s3","module":"aws_solutions_konstruk.aws_iot_kinesisfirehose_s3"}}},"dependencies":{"@aws-cdk/aws-iam":"~1.25.0","@aws-cdk/aws-kinesisfirehose":"~1.25.0","@aws-cdk/core":"~1.25.0","@aws-cdk/aws-iot":"~1.25.0","@aws-cdk/aws-s3":"~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-kinesisfirehose":"~1.25.0","@aws-cdk/core":"~1.25.0","@aws-cdk/aws-iot":"~1.25.0","@aws-cdk/aws-s3":"~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-iot-kinesisfirehose-s3@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-iot-kinesisfirehose-s3@0.8.0","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-+aLgFrGK6sX3bvZQe0DiI/2D69VnhIyEbZKmNfla5mW+0scaLNnWXLAhPeJHFeg9tObjK1Z5RU9F9xvmFVO05w==","shasum":"1092d896dfa6307c428df4404c5c1c61b15cc996","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3/-/aws-iot-kinesisfirehose-s3-0.8.0.tgz","fileCount":13,"unpackedSize":244123,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJefPX5CRA9TVsSAnZWagAAzqQQAIKqvNdLCjMe4Qu3ywdG\nCJTtinmy6tu3LVFijM1nSkxAtLQG0/+VESHCfE7IsptgqGLDeQbK6QegKLFd\nPnzb5KH++dKO29Wtz0VnTyNaRqfJ2cSmg5WERZ9MWgyVOT5FtrG3LwjnK+4T\nABFO9/PAyrmecYIBvkLLWbQawXl8UgqsgkiodRUrM4RWXT4I7JDz5eWSomdU\ne0MDyKaod2r9mxFlPNh9cASSGZ0SYbrzP2q8LBVgI4bMm3V2u1CumgflFVff\n30VwX4kxJewo05TbB0BiielVyaCBbv9jjUE4v8PG3rdxTGEtRwDR2BgNeg+w\nkHKWe3Cht+mZpMlcwuoZ+Qnva7eNZO01CYwZsHnTTYAmcAPEKlTfCWYJRbVQ\nZvIJm1pFAff9tpCd+Q0KM4rLjhl2JqH0Zek384wtRLn8V0lNM/E0fq10giVO\nR3vm9qfLcFAZwsVU6qIHLtkQv4gVJEQAXdGTUKwBGdgHT+EQL8HwutKno/As\nc1SCns1naBM0I9fPWnbQvzZaWpawoZPv6h+AvC/YSHcl7b3tcOLO/zAqxLwu\n8/eM4mDjqC9TlfpTUxAwZEjV2Qp+QV0xa6PUZhNf+6U/xnFAJoYsQSkNHixC\n9CG1tNFPd4MeHojBl+n9SbRBRPLnv7rfc0H5cqOHD+s9rJ/DowWatw5rgMcF\n8oKD\r\n=5e5h\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBlsVqiJdeYcFjcUA64sk02/j3YqqSiVru0Qf4Reo/qFAiEA0V1I5yBcpdJgLRd0vf+2Xaxrlfnb2csnADrYwym4l/Q="}]},"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-iot-kinesisfirehose-s3_0.8.0_1585247737263_0.7378766871509972"},"_hasShrinkwrap":false},"0.8.1":{"name":"@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3","version":"0.8.1","description":"CDK Constructs for AWS IoT to AWS Kinesis Firehose to AWS S3 integration.","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-iot-kinesisfirehose-s3"},"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.iotkinesisfirehoses3","maven":{"groupId":"software.amazon.konstruk","artifactId":"iotkinesisfirehoses3"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.IotKinesisfirehoseS3","packageId":"Amazon.Konstruk.AWS.IotKinesisfirehoseS3","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-iot-kinesisfirehose-s3","module":"aws_solutions_konstruk.aws_iot_kinesisfirehose_s3"}}},"dependencies":{"@aws-cdk/aws-iam":"~1.40.0","@aws-cdk/aws-kinesisfirehose":"~1.40.0","@aws-cdk/core":"~1.40.0","@aws-cdk/aws-iot":"~1.40.0","@aws-cdk/aws-s3":"~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-kinesisfirehose":"~1.40.0","@aws-cdk/core":"~1.40.0","@aws-cdk/aws-iot":"~1.40.0","@aws-cdk/aws-s3":"~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-iot-kinesisfirehose-s3@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-iot-kinesisfirehose-s3@0.8.1","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-v1e1L3SMUaFR5dzF6oEq4UlDuzGBzvOUH/BTPpJVtpdxsAfrh7KaemazJC/ydmY6hBYUmIvzFzB2fK928g8BzA==","shasum":"29f4c5d791ebb90b0cba5361e6e68ee5c2cf70e9","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3/-/aws-iot-kinesisfirehose-s3-0.8.1.tgz","fileCount":13,"unpackedSize":236531,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJexvOtCRA9TVsSAnZWagAAngAQAJ5VSTxWfBSN9EE2O7HL\nWyANySLp4gBxSkN4fG+rDGpVeuyEBp6S+14PqrBSEtZQ9xQjEMnnRespr51n\nBJoZpttce9yGSATSPzOLRXgZN6P2cr0oo0CG7CTH9xlZscQfSrOFjEIDSgUe\nZEF3SCcaEniNi8LqxfkwNsX7oRX6wywAn0yCse1HXEuiH84mIAc9foxYkhng\ndyb4audRZ2pDkT+/i2CDfGoai1KpMWoiZ7BrNyjv6qxe5Dt87Lkr/HdQROYJ\nk14z/DawC4GRSJb/2AxvL5mTzr7tEUwHaBmzquOug/PZf4VFPVQ5lxfoZ4+W\nazFuTVAntDLBi8aCoHzC4mVN2/aP1gig4kiu32ybUGZObO2z5+G7GVug3+ai\npzQ5qzRRlqAgEpX5S0zuACeBLZZNdYz8qSZ1x9Zo7tR0SdopHhAW1dMbzmzL\nkQDjj/o9rWjlUOxOJiuRNwMzhIf6kqolz97YhFpGGaZL0GfuEo+v3G48piJK\nHVCTYWJNY+mULn+CQ+OT77irg9Nd8wwvOvEdVBKFWNNqBoE6eHVG5h5vj7jS\nBDr0Z8jpyIlrSaNbqcTqWTFmfjm2dyA4Sw95HIxVeeqeekMYekdnP8kplJBm\nNzdjVFNN5W5ULoipWcqJO/4wSLO3N5Jqa5u2PpU9Ru7GFsJQn+nVL2jNBLKo\n9345\r\n=mRz8\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDOnJ5rLjxUo8g9VJCCpHKsUEyde6NqFcvaURimvmcfTAIgf1TvOmdQ/JN9CsDDzTptJH68JVKsa/sME4Z3FS9Ov8Q="}]},"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-iot-kinesisfirehose-s3_0.8.1_1590096812893_0.1902380232098888"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-26T18:35:37.014Z","0.8.0":"2020-03-26T18:35:37.477Z","modified":"2022-04-04T17:05:44.918Z","0.8.1":"2020-05-21T21:33:33.069Z"},"maintainers":[{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"}],"description":"CDK Constructs for AWS IoT to AWS Kinesis Firehose to AWS S3 integration.","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-iot-kinesisfirehose-s3"},"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-iot-kinesisfirehose-s3 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-iot-kinesisfirehose-s3/</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_iot_kinesisfirehose_s3`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png){: style=\"height:16px;width:16px\"} Typescript|`@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3`|\n\nThis AWS Solutions Konstruk implements an AWS IoT MQTT topic rule to send data to an Amazon Kinesis Data Firehose delivery stream connected to an Amazon S3 bucket.\n\nHere is a minimal deployable pattern definition:\n\n``` javascript\nconst { IotToKinesisFirehoseToS3Props, IotToKinesisFirehoseToS3 } = require('@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3');\n\nconst props: IotToKinesisFirehoseToS3Props = {\n    iotTopicRuleProps: {\n        topicRulePayload: {\n            ruleDisabled: false,\n            description: \"Persistent storage of connected vehicle telematics data\",\n            sql: \"SELECT * FROM 'connectedcar/telemetry/#'\",\n            actions: []\n        }\n    }\n};\n\nnew IotToKinesisFirehoseToS3(stack, 'test-iot-firehose-s3', props);\n\n```\n\n## Initializer\n\n``` text\nnew IotToKinesisFirehoseToS3(scope: Construct, id: string, props: IotToKinesisFirehoseToS3Props);\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 [`IotToKinesisFirehoseToS3Props`](#pattern-construct-props)\n\n## Pattern Construct Props\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|iotTopicRuleProps|[`iot.CfnTopicRuleProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iot.CfnTopicRuleProps.html)|User provided CfnTopicRuleProps to override the defaults|\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 Kinesis Firehose Delivery Stream|\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|kinesisFirehose()|[`kinesisfirehose.CfnDeliveryStream`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesisfirehose.CfnDeliveryStream.html)|Returns an instance of kinesisfirehose.CfnDeliveryStream created by the construct|\n|bucket()|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.Bucket.html)|Returns an instance of s3.Bucket created by the construct|\n|iotTopicRule()|[`iot.CfnTopicRule`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iot.CfnTopicRule.html)|Returns an instance of iot.CfnTopicRule created by the construct|\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"}