Skip to content

UpdateShardCountInput

Source code in docs_src/capo_kinesis/types/update_shard_count_input.py
class UpdateShardCountInput(TypedDict, closed=True):
    stream_name: NotRequired["capo_kinesis.types.stream_name.StreamName"]
    """<p>The name of the stream.</p>"""
    target_shard_count: (
        "capo_kinesis.types.positive_integer_object.PositiveIntegerObject"
    )
    """<p>The new number of shards. This value has the following default limits. By default, you cannot do the following: </p> <ul> <li> <p>Set this value to more than double your current shard count for a stream.</p> </li> <li> <p>Set this value below half your current shard count for a stream.</p> </li> <li> <p>Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.</p> </li> <li> <p>Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.</p> </li> </ul>"""
    scaling_type: "capo_kinesis.types.scaling_type.ScalingType"
    """<p>The scaling type. Uniform scaling creates shards of equal size.</p>"""
    stream_arn: NotRequired["capo_kinesis.types.stream_arn.StreamARN"]
    """<p>The ARN of the stream.</p>"""
    stream_id: NotRequired["capo_kinesis.types.stream_id.StreamId"]
    """<p>Not Implemented. Reserved for future use.</p>"""

scaling_type instance-attribute

scaling_type: ScalingType

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

stream_arn instance-attribute

stream_arn: NotRequired[StreamARN]

The ARN of the stream.

stream_id instance-attribute

stream_id: NotRequired[StreamId]

Not Implemented. Reserved for future use.

stream_name instance-attribute

stream_name: NotRequired[StreamName]

The name of the stream.

target_shard_count instance-attribute

target_shard_count: PositiveIntegerObject

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 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.

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