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

Class: Aws::Kinesis::Types::SplitShardInput

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

Overview

Note:

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

Instance Attribute Details

#new_starting_hash_keyString

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.

Returns:

  • (String)


1090
1091
1092
1093
1094
1095
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1090

class SplitShardInput < Struct.new(
  :stream_name,
  :shard_to_split,
  :new_starting_hash_key)
  include Aws::Structure
end

#shard_to_splitString

The shard ID of the shard to split.

Returns:

  • (String)


1090
1091
1092
1093
1094
1095
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1090

class SplitShardInput < Struct.new(
  :stream_name,
  :shard_to_split,
  :new_starting_hash_key)
  include Aws::Structure
end

#stream_nameString

The name of the stream for the shard split.

Returns:

  • (String)


1090
1091
1092
1093
1094
1095
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1090

class SplitShardInput < Struct.new(
  :stream_name,
  :shard_to_split,
  :new_starting_hash_key)
  include Aws::Structure
end