You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EventBridge::Types::KinesisParameters

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing KinesisParameters as input to an Aws::Client method, you can use a vanilla Hash:

{
  partition_key_path: "TargetPartitionKeyPath", # required
}

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#partition_key_path ⇒ String

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.

Returns:

  • (String) —

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