Overview Pattern Construct Props Pattern Properties Default settings Architecture Github

aws-iot-kinesisstreams

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:

Example

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