aws-iot-kinesisfirehose-s3 module

---

Stability: Experimental

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.

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	`aws_solutions_constructs.aws_iot_kinesisfirehose_s3`
Typescript	`@aws-solutions-constructs/aws-iot-kinesisfirehose-s3`
Java	`software.amazon.awsconstructs.services.iotkinesisfirehoses3`

This AWS Solutions Construct implements an AWS IoT MQTT topic rule to send data to an Amazon Kinesis Data Firehose delivery stream connected to an Amazon S3 bucket.

Here is a minimal deployable pattern definition in Typescript:

const { IotToKinesisFirehoseToS3Props, IotToKinesisFirehoseToS3 } from '@aws-solutions-constructs/aws-iot-kinesisfirehose-s3';

const props: IotToKinesisFirehoseToS3Props = {
    iotTopicRuleProps: {
        topicRulePayload: {
            ruleDisabled: false,
            description: "Persistent storage of connected vehicle telematics data",
            sql: "SELECT * FROM 'connectedcar/telemetry/#'",
            actions: []
        }
    }
};

new IotToKinesisFirehoseToS3(this, 'test-iot-firehose-s3', props);

Initializer

new IotToKinesisFirehoseToS3(scope: Construct, id: string, props: IotToKinesisFirehoseToS3Props);

Parameters

scope Construct
id string
props IotToKinesisFirehoseToS3Props

Pattern Construct Props

Name	Type	Description
iotTopicRuleProps	`iot.CfnTopicRuleProps`	User provided CfnTopicRuleProps to override the defaults
kinesisFirehoseProps?	`kinesisfirehose.CfnDeliveryStreamProps`	Optional user provided props to override the default props for Kinesis Firehose Delivery Stream
existingBucketObj?	`s3.IBucket`	Existing instance of S3 Bucket object, if this is set then the bucketProps is ignored.
bucketProps?	`s3.BucketProps`	User provided props to override the default props for the S3 Bucket.
logGroupProps?	`logs.LogGroupProps`	User provided props to override the default props for for the CloudWatchLogs LogGroup.

Pattern Properties

Name	Type	Description
kinesisFirehose	`kinesisfirehose.CfnDeliveryStream`	Returns an instance of kinesisfirehose.CfnDeliveryStream created by the construct
s3Bucket?	`s3.Bucket`	Returns an instance of s3.Bucket created by the construct
s3LoggingBucket?	`s3.Bucket`	Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.
iotTopicRule	`iot.CfnTopicRule`	Returns an instance of iot.CfnTopicRule created by the construct
iotActionsRole	`iam.Role`	Returns an instance of the iam.Role created by the construct for IoT Rule
kinesisFirehoseRole	`iam.Role`	Returns an instance of the iam.Role created by the construct for Kinesis Data Firehose delivery stream
kinesisFirehoseLogGroup	`logs.LogGroup`	Returns an instance of the LogGroup created by the construct for Kinesis Data Firehose delivery stream

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon IoT Rule

Configure least privilege access IAM role for Amazon IoT

Amazon Kinesis Firehose

Enable CloudWatch logging for Kinesis Firehose
Configure least privilege access IAM role for Amazon Kinesis Firehose

Amazon S3 Bucket

Configure Access logging for S3 Bucket
Enable server-side encryption for S3 Bucket using AWS managed KMS Key
Enforce encryption of data in transit
Turn on the versioning for S3 Bucket
Don't allow public access for S3 Bucket
Retain the S3 Bucket when deleting the CloudFormation stack
Applies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 days

Architecture

Architecture Diagram

Release files for aws-solutions-constructs.aws-iot-kinesisfirehose-s3 1.82.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-solutions-constructs.aws-iot-kinesisfirehose-s3 1.82.0
File	Size	Uploaded
aws-solutions-constructs.aws-iot-kinesisfirehose-s3-1.82.0.tar.gz	153.7 kB	Jan 21, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for aws-solutions-constructs.aws-iot-kinesisfirehose-s3 1.82.0
File	Interpreter	ABI	Platform	Reset
aws_solutions_constructs.aws_iot_kinesisfirehose_s3-1.82.0-py3-none-any.whl 152.7 kB Jan 21, 2021	Python 3	none	any	Details

Total release size: 306.5 kB

Release files / aws-solutions-constructs.aws-iot-kinesisfirehose-s3-1.82.0.tar.gz

Download URL	aws-solutions-constructs.aws-iot-kinesisfirehose-s3-1.82.0.tar.gz
Size	153.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`73ac18c566addb19fe6d9a388b106782f5945d6030b92fa89ba3ae8914669c6e`
BLAKE2b-256 checksum How to use checksums	`371222feb5c6f86a3b17e7d7a0b3981a626776195c581fe7c5a205aa3d1ed240`
Upload date	Jan 21, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.7.0 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.6`

Release files / aws_solutions_constructs.aws_iot_kinesisfirehose_s3-1.82.0-py3-none-any.whl

Download URL	aws_solutions_constructs.aws_iot_kinesisfirehose_s3-1.82.0-py3-none-any.whl
Size	152.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c653c891169cd020018cba845744cbeb858a0cad4ecbd534fb66e6a09bddd930`
BLAKE2b-256 checksum How to use checksums	`3bc05243c6fe0a8ba2e084a583b86e5a849102451fb855cd6c807a610a0f3836`
Upload date	Jan 21, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.7.0 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.6`