Struct aws_sdk_elasticache::input::ModifyReplicationGroupShardConfigurationInput

#[non_exhaustive]
pub struct ModifyReplicationGroupShardConfigurationInput {
    pub replication_group_id: Option<String>,
    pub node_group_count: i32,
    pub apply_immediately: bool,
    pub resharding_configuration: Option<Vec<ReshardingConfiguration>>,
    pub node_groups_to_remove: Option<Vec<String>>,
    pub node_groups_to_retain: Option<Vec<String>>,
}

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

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.

replication_group_id: Option<String>

The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

node_group_count: i32

The number of node groups (shards) that results from the modification of the shard configuration.

apply_immediately: bool

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Value: true

resharding_configuration: Option<Vec<ReshardingConfiguration>>

Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

node_groups_to_remove: Option<Vec<String>>

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

node_groups_to_retain: Option<Vec<String>>

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

Implementations

impl ModifyReplicationGroupShardConfigurationInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<ModifyReplicationGroupShardConfiguration, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<ModifyReplicationGroupShardConfiguration>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ModifyReplicationGroupShardConfigurationInput

impl ModifyReplicationGroupShardConfigurationInput

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

The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

pub fn node_group_count(&self) -> i32

The number of node groups (shards) that results from the modification of the shard configuration.

pub fn apply_immediately(&self) -> bool

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Value: true

pub fn resharding_configuration(&self) -> Option<&[ReshardingConfiguration]>

Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

pub fn node_groups_to_remove(&self) -> Option<&[String]>

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

pub fn node_groups_to_retain(&self) -> Option<&[String]>

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

Trait Implementations

impl Clone for ModifyReplicationGroupShardConfigurationInput

fn clone(&self) -> ModifyReplicationGroupShardConfigurationInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifyReplicationGroupShardConfigurationInput

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

Formats the value using the given formatter.

impl PartialEq<ModifyReplicationGroupShardConfigurationInput> for ModifyReplicationGroupShardConfigurationInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ModifyReplicationGroupShardConfigurationInput