aws-solutions-constructs.aws-iot-kinesisstreams 2.70.0

Description:

awssolutionsconstructs.awsiotkinesisstreams 2.70.0

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



Overview
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:
Typescript
import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { IotToKinesisStreamsProps, IotToKinesisStreams } from '@aws-solutions-constructs/aws-iot-kinesisstreams';

const constructProps: IotToKinesisStreamsProps = {
iotTopicRuleProps: {
topicRulePayload: {
ruleDisabled: false,
description: "Sends data to kinesis data stream",
sql: "SELECT * FROM 'solutions/construct'",
actions: []
}
}
};

new IotToKinesisStreams(this, 'test-iot-kinesisstreams', constructProps);

Python
from aws_solutions_constructs.aws_iot_kinesisstreams import IotToKinesisStreamsProps, IotToKinesisStreams
from aws_cdk import (
aws_iot as iot,
Stack
)
from constructs import Construct

IotToKinesisStreams(self, 'test-iot-kinesisstreams',
iot_topic_rule_props=iot.CfnTopicRuleProps(
topic_rule_payload=iot.CfnTopicRule.TopicRulePayloadProperty(
rule_disabled=False,
description="Sends data to kinesis data stream",
sql="SELECT * FROM 'solutions/construct'",
actions=[]
)
))

Java
import software.constructs.Construct;
import java.util.List;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.iot.*;
import software.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty;
import software.amazon.awsconstructs.services.iotkinesisstreams.*;

new IotToKinesisStreams(this, "test-iot-kinesisstreams", new IotToKinesisStreamsProps.Builder()
.iotTopicRuleProps(new CfnTopicRuleProps.Builder()
.topicRulePayload(new TopicRulePayloadProperty.Builder()
.ruleDisabled(false)
.description("Sends data to kinesis data stream")
.sql("SELECT * FROM 'solutions/construct'")
.actions(List.of())
.build())
.build())
.build());

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 Amazon.com, Inc. or its affiliates. All Rights Reserved.