aws_sdk_elasticache/client/

modify_replication_group_shard_configuration.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyReplicationGroupShardConfiguration`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`replication_group_id(impl Into<String>)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::replication_group_id) / [`set_replication_group_id(Option<String>)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::set_replication_group_id):<br>required: **true**<br><p>The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.</p><br>
    ///   - [`node_group_count(i32)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::node_group_count) / [`set_node_group_count(Option<i32>)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::set_node_group_count):<br>required: **true**<br><p>The number of node groups (shards) that results from the modification of the shard configuration.</p><br>
    ///   - [`apply_immediately(bool)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::apply_immediately) / [`set_apply_immediately(Option<bool>)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::set_apply_immediately):<br>required: **true**<br><p>Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is <code>true</code>.</p> <p>Value: true</p><br>
    ///   - [`resharding_configuration(ReshardingConfiguration)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::resharding_configuration) / [`set_resharding_configuration(Option<Vec::<ReshardingConfiguration>>)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::set_resharding_configuration):<br>required: **false**<br><p>Specifies the preferred availability zones for each node group in the cluster. If the value of <code>NodeGroupCount</code> 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.</p> <p>You can specify this parameter only if the value of <code>NodeGroupCount</code> is greater than the current number of node groups (shards).</p><br>
    ///   - [`node_groups_to_remove(impl Into<String>)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::node_groups_to_remove) / [`set_node_groups_to_remove(Option<Vec::<String>>)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::set_node_groups_to_remove):<br>required: **false**<br><p>If the value of <code>NodeGroupCount</code> is less than the current number of node groups (shards), then either <code>NodeGroupsToRemove</code> or <code>NodeGroupsToRetain</code> is required. <code>NodeGroupsToRemove</code> is a list of <code>NodeGroupId</code>s to remove from the cluster.</p> <p>ElastiCache will attempt to remove all node groups listed by <code>NodeGroupsToRemove</code> from the cluster.</p><br>
    ///   - [`node_groups_to_retain(impl Into<String>)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::node_groups_to_retain) / [`set_node_groups_to_retain(Option<Vec::<String>>)`](crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::set_node_groups_to_retain):<br>required: **false**<br><p>If the value of <code>NodeGroupCount</code> is less than the current number of node groups (shards), then either <code>NodeGroupsToRemove</code> or <code>NodeGroupsToRetain</code> is required. <code>NodeGroupsToRetain</code> is a list of <code>NodeGroupId</code>s to retain in the cluster.</p> <p>ElastiCache will attempt to remove all node groups except those listed by <code>NodeGroupsToRetain</code> from the cluster.</p><br>
    /// - On success, responds with [`ModifyReplicationGroupShardConfigurationOutput`](crate::operation::modify_replication_group_shard_configuration::ModifyReplicationGroupShardConfigurationOutput) with field(s):
    ///   - [`replication_group(Option<ReplicationGroup>)`](crate::operation::modify_replication_group_shard_configuration::ModifyReplicationGroupShardConfigurationOutput::replication_group): <p>Contains all of the attributes of a specific Valkey or Redis OSS replication group.</p>
    /// - On failure, responds with [`SdkError<ModifyReplicationGroupShardConfigurationError>`](crate::operation::modify_replication_group_shard_configuration::ModifyReplicationGroupShardConfigurationError)
    pub fn modify_replication_group_shard_configuration(
        &self,
    ) -> crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder {
        crate::operation::modify_replication_group_shard_configuration::builders::ModifyReplicationGroupShardConfigurationFluentBuilder::new(
            self.handle.clone(),
        )
    }
}