Class: Aws::Kinesis::Types::UpdateShardCountInput

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

Overview

Note:

When making an API call, you may pass UpdateShardCountInput data as a hash:

{
  stream_name: "StreamName", # required
  target_shard_count: 1, # required
  scaling_type: "UNIFORM_SCALING", # required, accepts UNIFORM_SCALING
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#scaling_typeString

The scaling type. Uniform scaling creates shards of equal size.

Returns:

  • (String)

2408
2409
2410
2411
2412
2413
2414
# File 'lib/aws-sdk-kinesis/types.rb', line 2408

class UpdateShardCountInput < Struct.new(
  :stream_name,
  :target_shard_count,
  :scaling_type)
  SENSITIVE = []
  include Aws::Structure
end

#stream_nameString

The name of the stream.

Returns:

  • (String)

2408
2409
2410
2411
2412
2413
2414
# File 'lib/aws-sdk-kinesis/types.rb', line 2408

class UpdateShardCountInput < Struct.new(
  :stream_name,
  :target_shard_count,
  :scaling_type)
  SENSITIVE = []
  include Aws::Structure
end

#target_shard_countInteger

The new number of shards. This value has the following default limits. By default, you cannot do the following:

  • Set this value to more than double your current shard count for a stream.

  • Set this value below half your current shard count for a stream.

  • Set this value to more than 500 shards in a stream (the default limit for shard count per stream is 500 per account per region), unless you request a limit increase.

  • Scale a stream with more than 500 shards down unless you set this value to less than 500 shards.

Returns:

  • (Integer)

2408
2409
2410
2411
2412
2413
2414
# File 'lib/aws-sdk-kinesis/types.rb', line 2408

class UpdateShardCountInput < Struct.new(
  :stream_name,
  :target_shard_count,
  :scaling_type)
  SENSITIVE = []
  include Aws::Structure
end