Class CfnRule.KinesisParametersProperty
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.
Inheritance
System.Object
CfnRule.KinesisParametersProperty
Implements
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class KinesisParametersProperty : Object, CfnRule.IKinesisParametersProperty
Syntax (vb)
Public Class KinesisParametersProperty
Inherits Object
Implements CfnRule.IKinesisParametersProperty
Remarks
If you do not include this parameter, the default is to use the eventId
as the partition key.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
var kinesisParametersProperty = new KinesisParametersProperty {
PartitionKeyPath = "partitionKeyPath"
};
Synopsis
Constructors
KinesisParametersProperty() |
Properties
PartitionKeyPath | The JSON path to be extracted from the event and used as the partition key. |
Constructors
KinesisParametersProperty()
public KinesisParametersProperty()
Properties
PartitionKeyPath
The JSON path to be extracted from the event and used as the partition key.
public string PartitionKeyPath { get; set; }
Property Value
System.String
Remarks
For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .