Skip to content

DecreaseReplicaCountMessage

Source code in docs_src/capo_elasticache/types/decrease_replica_count_message.py
class DecreaseReplicaCountMessage(TypedDict, closed=True):
    replication_group_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The id of the replication group from which you want to remove 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> <p>The minimum number of replicas in a shard or replication group is:</p> <ul> <li> <p>Valkey or Redis OSS (cluster mode disabled)</p> <ul> <li> <p>If Multi-AZ is enabled: 1</p> </li> <li> <p>If Multi-AZ is not enabled: 0</p> </li> </ul> </li> <li> <p>Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)</p> </li> </ul>"""
    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 replication group. The <code>ConfigureShard</code> has three members: <code>NewReplicaCount</code>, <code>NodeGroupId</code>, and <code>PreferredAvailabilityZones</code>.</p>"""
    replicas_to_remove: NotRequired[
        "capo_elasticache.types.remove_replicas_list.RemoveReplicasList"
    ]
    """<p>A list of the node ids to remove from the replication group or node group (shard).</p>"""
    apply_immediately: NotRequired["capo_elasticache.types.boolean.Boolean"]
    """<p>If <code>True</code>, the number of replica nodes is decreased 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 decreased 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.

The minimum number of replicas in a shard or replication group is:

  • Valkey or Redis OSS (cluster mode disabled)

    • If Multi-AZ is enabled: 1

    • If Multi-AZ is not enabled: 0

  • Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

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 replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

replicas_to_remove instance-attribute

replicas_to_remove: NotRequired[RemoveReplicasList]

A list of the node ids to remove from the replication group or node group (shard).

replication_group_id instance-attribute

replication_group_id: NotRequired[String]

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