Skip to main content

CDK Constructs for AWS IoT to AWS Kinesis Firehose to AWS S3 integration.

Project description

aws-iot-kinesisfirehose-s3 module

---

Stability: Experimental

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
Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_iot_kinesisfirehose_s3
Typescript Logo{: 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 Retruns an instance of kinesisfirehose.CfnDeliveryStream created by the construct
bucket() s3.Bucket Retruns an instance of s3.Bucket created by the construct
iotTopicRule() iot.CfnTopicRule Retruns an instance of iot.CfnTopicRule created by the construct

Architecture

Architecture Diagram


© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file aws-solutions-konstruk.aws-iot-kinesisfirehose-s3-0.8.0.tar.gz.

File metadata

File hashes

Hashes for aws-solutions-konstruk.aws-iot-kinesisfirehose-s3-0.8.0.tar.gz
Algorithm Hash digest
SHA256 8ee47cfac2c2ede796e0d2ab91b881826897543bdde56020019dfdd551764140
MD5 d71219b5c5aa7bd1d969b7f873846b9d
BLAKE2b-256 d6b1e49edb27fce7bf66a28b17577622861b14e829726a448b4bd3c8ecc830c6

See more details on using hashes here.

File details

Details for the file aws_solutions_konstruk.aws_iot_kinesisfirehose_s3-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_konstruk.aws_iot_kinesisfirehose_s3-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 15eed1d4266d1ebdd64da2d49b6f76c28794bab6c29843f5fbbe5a9e0a1e1d9d
MD5 3a50613e8a62f1849d1ebbf3e8290984
BLAKE2b-256 35b3d3db4474661b683b92aee987d822dd300aabebd1d6fb149decac6bfe7b02

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page