Show / Hide Table of Contents

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
object
CfnRule.KinesisParametersProperty
Implements
CfnRule.IKinesisParametersProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRule.KinesisParametersProperty : CfnRule.IKinesisParametersProperty
Syntax (vb)
Public Class CfnRule.KinesisParametersProperty Implements CfnRule.IKinesisParametersProperty
Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html

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()

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.

Properties

PartitionKeyPath

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

Constructors

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.

public KinesisParametersProperty()
Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html

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"
             };

Properties

PartitionKeyPath

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

public string PartitionKeyPath { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath

Implements

CfnRule.IKinesisParametersProperty
Back to top Generated by DocFX