Skip to content

IncreaseReplicaCountMessage

Source code in docs_src/capo_elasticache/types/increase_replica_count_message.py
class IncreaseReplicaCountMessage(TypedDict, closed=True):
    replication_group_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The id of the replication group to which you want to add replica nodes.</p>"""
    new_replica_count: NotRequired[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ]
    """<p>The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.</p>"""
    replica_configuration: NotRequired[
        "capo_elasticache.types.replica_configuration_list.ReplicaConfigurationList"
    ]
    """<p>A list of <code>ConfigureShard</code> objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The <code>ConfigureShard</code> has three members: <code>NewReplicaCount</code>, <code>NodeGroupId</code>, and <code>PreferredAvailabilityZones</code>.</p>"""
    apply_immediately: NotRequired["capo_elasticache.types.boolean.Boolean"]
    """<p>If <code>True</code>, the number of replica nodes is increased immediately. <code>ApplyImmediately=False</code> is not currently supported.</p>"""

apply_immediately instance-attribute

apply_immediately: NotRequired[Boolean]

If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

new_replica_count instance-attribute

new_replica_count: NotRequired[IntegerOptional]

The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

replica_configuration instance-attribute

replica_configuration: NotRequired[ReplicaConfigurationList]

A list of ConfigureShard objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

replication_group_id instance-attribute

replication_group_id: NotRequired[String]

The id of the replication group to which you want to add replica nodes.