CDK Constructs for AWS IoT to AWS Kinesis Data Stream.
Project description
aws-iot-kinesisstreams 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.
Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_iot_kinesisstreams |
Typescript | @aws-solutions-constructs/aws-iot-kinesisstreams |
Java | software.amazon.awsconstructs.services.iotkinesisstreams |
This AWS Solutions Construct implements an AWS IoT MQTT topic rule to send data to an Amazon Kinesis Data Stream.
Here is a minimal deployable pattern definition in Typescript:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
# { IotToKinesisStreamsProps,
IotToKinesisStreams } is of type object# from is of type object"@aws-solutions-constructs/aws-iot-kinesisstreams"
props = {
"iot_topic_rule_props": {
"topic_rule_payload": {
"rule_disabled": False,
"description": "Sends data to kinesis data stream",
"sql": "SELECT * FROM 'solutions/construct'",
"actions": []
}
}
}
IotToKinesisStreams(self, "test-iot-kinesisstream", props)
Initializer
new IotToKinesisStreams(scope: Construct, id: string, props: IotToKinesisStreamsProps);
Parameters
- scope
Construct
- id
string
- props
IotToKinesisStreamsProps
Pattern Construct Props
Name | Type | Description |
---|---|---|
iotTopicRuleProps | iot.CfnTopicRuleProps |
User provided CfnTopicRuleProps to override the defaults |
existingStreamObj? | kinesis.Stream |
Existing instance of Kinesis Stream, providing both this and kinesisStreamProps will cause an error. |
kinesisStreamProps? | kinesis.StreamProps |
Optional user-provided props to override the default props for the Kinesis data stream, providing both this and existingStreamObj will cause an error |
createCloudWatchAlarms | boolean |
Whether to create recommended CloudWatch alarms for Kinesis Data Stream. Default value is set to true |
Pattern Properties
Name | Type | Description |
---|---|---|
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 |
kinesisStream | kinesis.Stream |
Returns an instance of the Kinesis stream created by the construct. |
cloudwatchAlarms? | cloudwatch.Alarm[] |
Returns an array of recommended CloudWatch Alarms created by the construct for Kinesis Data 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 Rule
Amazon Kinesis Data Stream
- Configure recommended CloudWatch Alarms for Amazon Kinesis Data Stream
- Configure least privilege access IAM role for Amazon Kinesis Data Stream
Architecture
© Copyright 2021 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-constructs.aws-iot-kinesisstreams-2.0.0rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0bcd2e8b96f52e6cc5d99c2dfb95814c12d9ace96f0e63c8233611dbf1ad0933 |
|
MD5 | 60e397d6cf44293b223f924792e25789 |
|
BLAKE2b-256 | a59e7082c904c2b7b97db3a74dc70de5e9db86e9e520b61a83546c664d37db92 |
Hashes for aws_solutions_constructs.aws_iot_kinesisstreams-2.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f0894ace8e897184ec51d7e8c883fdfa101f2ff4800a6e75b152524e1f8dd3e |
|
MD5 | e78592f408a4a860b73cb11fca49bf17 |
|
BLAKE2b-256 | 8a8fd5807593dc3d587ba415b0508c313bff566cae7f0e6ca102e052652d2fd0 |