Package: aws-solutions-constructs.aws-iot-kinesisstreams
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 theSemantic Versioningmodel.
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/LanguagePackagePythonaws_solutions_constructs.aws_iot_kinesisstreamsTypescript@aws-solutions-constructs/aws-iot-kinesisstreamsJavasoftware.amazon.awsconstructs.services.iotkinesisstreamsOverviewThis 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:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{IotToKinesisStreamsProps,IotToKinesisStreams}from'@aws-solutions-constructs/aws-iot-kinesisstreams';constconstructProps:IotToKinesisStreamsProps={iotTopicRuleProps:{topicRulePayload:{ruleDisabled:false,description:"Sends data to kinesis data stream",sql:"SELECT * FROM 'solutions/construct'",actions:[]}}};newIotToKinesisStreams(this,'test-iot-kinesisstreams',constructProps);Pythonfromaws_solutions_constructs.aws_iot_kinesisstreamsimportIotToKinesisStreamsProps,IotToKinesisStreamsfromaws_cdkimport(aws_iotasiot,Stack)fromconstructsimportConstructIotToKinesisStreams(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=[])))Javaimportsoftware.constructs.Construct;importjava.util.List;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awscdk.services.iot.*;importsoftware.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty;importsoftware.amazon.awsconstructs.services.iotkinesisstreams.*;newIotToKinesisStreams(this,"test-iot-kinesisstreams",newIotToKinesisStreamsProps.Builder().iotTopicRuleProps(newCfnTopicRuleProps.Builder().topicRulePayload(newTopicRulePayloadProperty.Builder().ruleDisabled(false).description("Sends data to kinesis data stream").sql("SELECT * FROM 'solutions/construct'").actions(List.of()).build()).build()).build());Pattern Construct PropsNameTypeDescriptioniotTopicRulePropsiot.CfnTopicRulePropsUser provided CfnTopicRuleProps to override the defaultsexistingStreamObj?kinesis.StreamExisting instance of Kinesis Stream, providing both this andkinesisStreamPropswill cause an error.kinesisStreamProps?kinesis.StreamPropsOptional user-provided props to override the default props for the Kinesis data stream, providing both this andexistingStreamObjwill cause an errorcreateCloudWatchAlarmsbooleanWhether to create recommended CloudWatch alarms for Kinesis Data Stream. Default value is set totruePattern PropertiesNameTypeDescriptioniotTopicRuleiot.CfnTopicRuleReturns an instance of iot.CfnTopicRule created by the constructiotActionsRoleiam.RoleReturns an instance of the iam.Role created by the construct for IoT RulekinesisStreamkinesis.StreamReturns 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 streamDefault settingsOut of the box implementation of the Construct without any override will set the following defaults:Amazon IoT RuleConfigure least privilege access IAM role for Amazon IoT RuleAmazon Kinesis Data StreamConfigure recommended CloudWatch Alarms for Amazon Kinesis Data StreamConfigure least privilege access IAM role for Amazon Kinesis Data StreamArchitecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.