awssolutionsconstructsawsiotkinesisstreams

README

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:

const { IotToKinesisStreamsProps,
        IotToKinesisStreams } from '@aws-solutions-constructs/aws-iot-kinesisstreams';

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

new IotToKinesisStreams(this, '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.

Documentation

Overview

CDK Constructs for AWS IoT to AWS Kinesis Data Stream.

Index

• func IotToKinesisStreams_IsConstruct(x interface{}) *bool
• func NewIotToKinesisStreams_Override(i IotToKinesisStreams, scope constructs.Construct, id *string, ...)
• type IotToKinesisStreams
  • func NewIotToKinesisStreams(scope constructs.Construct, id *string, props *IotToKinesisStreamsProps) IotToKinesisStreams
• type IotToKinesisStreamsProps

Functions

func IotToKinesisStreams_IsConstruct

func IotToKinesisStreams_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewIotToKinesisStreams_Override

func NewIotToKinesisStreams_Override(i IotToKinesisStreams, scope constructs.Construct, id *string, props *IotToKinesisStreamsProps)

Types

type IotToKinesisStreams

type IotToKinesisStreams interface {
	constructs.Construct
	CloudwatchAlarms() *[]awscloudwatch.Alarm
	IotActionsRole() awsiam.Role
	IotTopicRule() awsiot.CfnTopicRule
	KinesisStream() awskinesis.Stream
	Node() constructs.Node
	ToString() *string
}

func NewIotToKinesisStreams

func NewIotToKinesisStreams(scope constructs.Construct, id *string, props *IotToKinesisStreamsProps) IotToKinesisStreams

type IotToKinesisStreamsProps

type IotToKinesisStreamsProps struct {
	// User provided CfnTopicRuleProps to override the defaults.
	IotTopicRuleProps *awsiot.CfnTopicRuleProps `json:"iotTopicRuleProps"`
	// Whether to create recommended CloudWatch alarms.
	CreateCloudWatchAlarms *bool `json:"createCloudWatchAlarms"`
	// Existing instance of Kinesis Stream object, providing both this and KinesisStreamProps will cause an error.
	ExistingStreamObj awskinesis.Stream `json:"existingStreamObj"`
	// User provided props to override the default props for the Kinesis Stream.
	KinesisStreamProps interface{} `json:"kinesisStreamProps"`
}