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

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

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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*.

[1]: docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key

Returns:

  • (String) 


2129
2130
2131
2132
2133
 
# File 'lib/aws-sdk-cloudwatchevents/types.rb', line 2129

class KinesisParameters < Struct.new(
  :partition_key_path)
  SENSITIVE = []
  include Aws::Structure
end