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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateShardCountInput as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#scaling_type ⇒ String

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

Possible values:

  • UNIFORM_SCALING

Returns:

  • (String) —

    The scaling type.

#stream_name ⇒ String

The name of the stream.

Returns:

  • (String) —

    The name of the stream.

#target_shard_count ⇒ Integer

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) —

    The new number of shards.