Package software.amazon.awscdk.services.iot.actions.alpha

Interface KinesisPutRecordActionProps

All Superinterfaces:

CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

KinesisPutRecordActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:16.111Z")
@Stability(Experimental)
public interface KinesisPutRecordActionProps
extends software.amazon.jsii.JsiiSerializable, CommonActionProps

(experimental) Configuration properties of an action for the Kinesis Data stream.

Example:

 import software.amazon.awscdk.services.kinesis.*;
 Stream stream = new Stream(this, "MyStream");
 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"))
         .actions(List.of(
             KinesisPutRecordAction.Builder.create(stream)
                     .partitionKey("${newuuid()}")
                     .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static KinesisPutRecordActionProps.Builder	builder()
String	getPartitionKey()	(experimental) The partition key used to determine to which shard the data is written.

Methods inherited from interface software.amazon.awscdk.services.iot.actions.alpha.CommonActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPartitionKey

@Stability(Experimental)
@NotNull
String getPartitionKey()

(experimental) The partition key used to determine to which shard the data is written.

The partition key is usually composed of an expression (for example, ${topic()} or ${timestamp()}).

See Also:

• https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html#API_PutRecord_RequestParameters

builder

@Stability(Experimental)
static KinesisPutRecordActionProps.Builder builder()

Returns:

a KinesisPutRecordActionProps.Builder of KinesisPutRecordActionProps