Struct aws_sdk_elasticache::client::fluent_builders::ModifyReplicationGroupShardConfiguration

pub struct ModifyReplicationGroupShardConfiguration<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to ModifyReplicationGroupShardConfiguration.

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

Implementations

impl<C, M, R> ModifyReplicationGroupShardConfiguration<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<ModifyReplicationGroupShardConfigurationOutput, SdkError<ModifyReplicationGroupShardConfigurationError>> where
    R::Policy: SmithyRetryPolicy<ModifyReplicationGroupShardConfigurationInputOperationOutputAlias, ModifyReplicationGroupShardConfigurationOutput, ModifyReplicationGroupShardConfigurationError, ModifyReplicationGroupShardConfigurationInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn replication_group_id(self, inp: impl Into<String>) -> Self

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

pub fn set_replication_group_id(self, input: Option<String>) -> Self

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, inp: i32) -> Self

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

pub fn set_node_group_count(self, input: Option<i32>) -> Self

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

pub fn apply_immediately(self, inp: bool) -> Self

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

Value: true

pub fn set_apply_immediately(self, input: Option<bool>) -> Self

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,
    inp: impl Into<ReshardingConfiguration>
) -> Self

Appends an item to ReshardingConfiguration.

To override the contents of this collection use set_resharding_configuration.

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 set_resharding_configuration(
    self,
    input: Option<Vec<ReshardingConfiguration>>
) -> Self

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, inp: impl Into<String>) -> Self

Appends an item to NodeGroupsToRemove.

To override the contents of this collection use set_node_groups_to_remove.

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 set_node_groups_to_remove(self, input: Option<Vec<String>>) -> Self

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, inp: impl Into<String>) -> Self

Appends an item to NodeGroupsToRetain.

To override the contents of this collection use set_node_groups_to_retain.

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.

pub fn set_node_groups_to_retain(self, input: Option<Vec<String>>) -> Self

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<C: Debug, M: Debug, R: Debug> Debug for ModifyReplicationGroupShardConfiguration<C, M, R>

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

Formats the value using the given formatter.