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

Class: Aws::CloudWatchEvents::Types::KinesisParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb

Overview

Note:

When making an API call, you may pass KinesisParameters data as a 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 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.

Instance Attribute Summary collapse

Instance Attribute Details

#partition_key_pathString

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)


246
247
248
249
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 246

class KinesisParameters < Struct.new(
  :partition_key_path)
  include Aws::Structure
end