@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3

aws-iot-kinesisfirehose-s3 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-iot-kinesisfirehose-s3/

Language	Package
{: style="height:16px;width:16px"} Python	`aws_solutions_konstruk.aws_iot_kinesisfirehose_s3`
{: style="height:16px;width:16px"} Typescript	`@aws-solutions-konstruk/aws-iot-kinesisfirehose-s3`

This 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.

Here is a minimal deployable pattern definition:

const { IotToKinesisFirehoseToS3Props, IotToKinesisFirehoseToS3 } = require('@aws-solutions-konstruk/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(stack, 'test-iot-firehose-s3', props);

Initializer

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

Parameters

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
deployBucket?	`boolean`	Whether to create a S3 Bucket or use an existing S3 Bucket
existingBucketObj?	`s3.Bucket`	Existing instance of S3 Bucket object
bucketProps?	`s3.BucketProps`	Optional user provided props to override the default props for S3 Bucket

Pattern Properties

Name	Type	Description
kinesisFirehose()	`kinesisfirehose.CfnDeliveryStream`	Returns an instance of kinesisfirehose.CfnDeliveryStream created by the construct
bucket()	`s3.Bucket`	Returns an instance of s3.Bucket created by the construct
iotTopicRule()	`iot.CfnTopicRule`	Returns an instance of iot.CfnTopicRule created by the construct

Architecture

Architecture Diagram

@aws-cdk/aws-iam @aws-cdk/aws-kinesisfirehose @aws-cdk/core @aws-cdk/aws-iot @aws-cdk/aws-s3 @aws-solutions-konstruk/core @aws-solutions-konstruk/aws-kinesisfirehose-s3 constructs

@infinitebrahmanuniverse/nolb-_aws-so @everything-registry/sub-chunk-103

0.8.1

4 years ago

0.8.0

4 years ago