Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.KinesisActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.KinesisActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.KinesisActionProperty
extends software.amazon.jsii.JsiiSerializable

Describes an action to write data to an Amazon Kinesis stream.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 KinesisActionProperty kinesisActionProperty = KinesisActionProperty.builder()
         .roleArn("roleArn")
         .streamName("streamName")
         // the properties below are optional
         .partitionKey("partitionKey")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTopicRule.KinesisActionProperty.Builder	A builder for CfnTopicRule.KinesisActionProperty
static final class	CfnTopicRule.KinesisActionProperty.Jsii$Proxy	An implementation for CfnTopicRule.KinesisActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.KinesisActionProperty.Builder	builder()
default String	getPartitionKey()	The partition key.
String	getRoleArn()	The ARN of the IAM role that grants access to the Amazon Kinesis stream.
String	getStreamName()	The name of the Amazon Kinesis stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-rolearn

getStreamName

@Stability(Stable)
@NotNull
String getStreamName()

The name of the Amazon Kinesis stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-streamname

getPartitionKey

@Stability(Stable)
@Nullable
default String getPartitionKey()

The partition key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-partitionkey

builder

@Stability(Stable)
static CfnTopicRule.KinesisActionProperty.Builder builder()

Returns:

a CfnTopicRule.KinesisActionProperty.Builder of CfnTopicRule.KinesisActionProperty