CDK Constructs for AWS IoT to AWS Kinesis Firehose to AWS S3 integration.
Project description
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 |
---|---|
aws_solutions_konstruk.aws_iot_kinesisfirehose_s3 |
|
@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
- 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 |
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
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Project details
Release history Release notifications | RSS feed
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
Hashes for aws-solutions-konstruk.aws-iot-kinesisfirehose-s3-0.8.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74650ec326f6faa40731737c5f895d4650cad4d3abfa7fd3bdbd2323aef5daf1 |
|
MD5 | 03e4a20f9c68f1bac0ac6b33e7031e02 |
|
BLAKE2b-256 | 197e12b3fc0520a38ff987f0db87cb9e5e4a17f4f08fc437f7a8ae25601c7000 |
Hashes for aws_solutions_konstruk.aws_iot_kinesisfirehose_s3-0.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e17bc9f6acb9b2b887cb21428499492b1a513473291d5619b955a3203c84ed72 |
|
MD5 | 0652b6ccec2eb840558ac222adf2dfe7 |
|
BLAKE2b-256 | 8aff390719c62bb9408e3f0fb0da321e4bb6e5d8f72f51bced1c2752e711bd63 |