Skip to content

ConfigureShard

Source code in docs_src/capo_elasticache/types/configure_shard.py
class ConfigureShard(TypedDict, closed=True):
    node_group_id: NotRequired[
        "capo_elasticache.types.allowed_node_group_id.AllowedNodeGroupId"
    ]
    """<p>The 4-digit id for the node group you are configuring. For Valkey or Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Valkey or Redis OSS (cluster mode enabled)'s node group's (shard's) id, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/shard-find-id.html">Finding a Shard's Id</a>.</p>"""
    new_replica_count: NotRequired["capo_elasticache.types.integer.Integer"]
    """<p>The number of replicas you want in this node group at the end of this operation. The maximum value for <code>NewReplicaCount</code> is 5. The minimum value depends upon the type of Valkey or Redis OSS replication group you are working with.</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: 1</p> </li> <li> <p>If Multi-AZ: 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>"""
    preferred_availability_zones: NotRequired[
        "capo_elasticache.types.preferred_availability_zone_list.PreferredAvailabilityZoneList"
    ]
    """<p>A list of <code>PreferredAvailabilityZone</code> strings that specify which availability zones the replication group's nodes are to be in. The nummber of <code>PreferredAvailabilityZone</code> values must equal the value of <code>NewReplicaCount</code> plus 1 to account for the primary node. If this member of <code>ReplicaConfiguration</code> is omitted, ElastiCache selects the availability zone for each of the replicas.</p>"""
    preferred_outpost_arns: NotRequired[
        "capo_elasticache.types.preferred_outpost_arn_list.PreferredOutpostArnList"
    ]
    """<p>The outpost ARNs in which the cache cluster is created.</p>"""

new_replica_count instance-attribute

new_replica_count: NotRequired[Integer]

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Valkey or Redis OSS replication group you are working with.

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

  • Valkey or Redis OSS (cluster mode disabled)

    • If Multi-AZ: 1

    • If Multi-AZ: 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)

node_group_id instance-attribute

node_group_id: NotRequired[AllowedNodeGroupId]

The 4-digit id for the node group you are configuring. For Valkey or Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Valkey or Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

preferred_availability_zones instance-attribute

preferred_availability_zones: NotRequired[PreferredAvailabilityZoneList]

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache selects the availability zone for each of the replicas.

preferred_outpost_arns instance-attribute

preferred_outpost_arns: NotRequired[PreferredOutpostArnList]

The outpost ARNs in which the cache cluster is created.