Struct ConfigureShard

#[non_exhaustive]
pub struct ConfigureShard {
    pub node_group_id: Option<String>,
    pub new_replica_count: Option<i32>,
    pub preferred_availability_zones: Option<Vec<String>>,
    pub preferred_outpost_arns: Option<Vec<String>>,
}

Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

node_group_id: Option<String>

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.

new_replica_count: Option<i32>

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)

preferred_availability_zones: Option<Vec<String>>

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: Option<Vec<String>>

The outpost ARNs in which the cache cluster is created.

Implementations

impl ConfigureShard

pub fn node_group_id(&self) -> Option<&str>

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.

pub fn new_replica_count(&self) -> Option<i32>

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)

pub fn preferred_availability_zones(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .preferred_availability_zones.is_none().

pub fn preferred_outpost_arns(&self) -> &[String]

The outpost ARNs in which the cache cluster is created.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .preferred_outpost_arns.is_none().

impl ConfigureShard

pub fn builder() -> ConfigureShardBuilder

Creates a new builder-style object to manufacture ConfigureShard.

Trait Implementations

impl Clone for ConfigureShard

fn clone(&self) -> ConfigureShard

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfigureShard

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ConfigureShard

fn eq(&self, other: &ConfigureShard) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConfigureShard