You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Kinesis::Types::SplitShardInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kinesis::Types::SplitShardInput
- Defined in:
- (unknown)
Overview
When passing SplitShardInput as input to an Aws::Client method, you can use a vanilla Hash:
{
stream_name: "StreamName", # required
shard_to_split: "ShardId", # required
new_starting_hash_key: "HashKey", # required
}
Represents the input for SplitShard
.
Instance Attribute Summary collapse
-
#new_starting_hash_key ⇒ String
A hash key value for the starting hash key of one of the child shards created by the split.
-
#shard_to_split ⇒ String
The shard ID of the shard to split.
-
#stream_name ⇒ String
The name of the stream for the shard split.
Instance Attribute Details
#new_starting_hash_key ⇒ String
A hash key value for the starting hash key of one of the child shards
created by the split. The hash key range for a given shard constitutes a
set of ordered contiguous positive integers. The value for
NewStartingHashKey
must be in the range of hash keys being mapped into
the shard. The NewStartingHashKey
hash key value and all higher hash
key values in hash key range are distributed to one of the child shards.
All the lower hash key values in the range are distributed to the other
child shard.
#shard_to_split ⇒ String
The shard ID of the shard to split.
#stream_name ⇒ String
The name of the stream for the shard split.