software.amazon.awscdk.services.events

Interface CfnRule.KinesisParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRule.KinesisParametersProperty.Jsii$Proxy

Enclosing class:

CfnRule

@Stability(value=Stable)
public static interface CfnRule.KinesisParametersProperty
extends software.amazon.jsii.JsiiSerializable

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes.

If you do not include this parameter, the default is to use the eventId as the partition key.

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.events.*;
 KinesisParametersProperty kinesisParametersProperty = KinesisParametersProperty.builder()
         .partitionKeyPath("partitionKeyPath")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRule.KinesisParametersProperty.Builder	builder()
String	getPartitionKeyPath() The JSON path to be extracted from the event and used as the partition key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPartitionKeyPath

@Stability(value=Stable)
 @NotNull
String getPartitionKeyPath()

The JSON path to be extracted from the event and used as the partition key.

For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .

builder

@Stability(value=Stable)
static CfnRule.KinesisParametersProperty.Builder builder()

Returns:

a CfnRule.KinesisParametersProperty.Builder of CfnRule.KinesisParametersProperty