aws_sdk_elasticache/client/

modify_global_replication_group.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyGlobalReplicationGroup`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`global_replication_group_id(impl Into<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::global_replication_group_id) / [`set_global_replication_group_id(Option<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::set_global_replication_group_id):<br>required: **true**<br><p>The name of the Global datastore</p><br>
    ///   - [`apply_immediately(bool)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::apply_immediately) / [`set_apply_immediately(Option<bool>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::set_apply_immediately):<br>required: **true**<br><p>This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.</p><br>
    ///   - [`cache_node_type(impl Into<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::cache_node_type) / [`set_cache_node_type(Option<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::set_cache_node_type):<br>required: **false**<br><p>A valid cache node type that you want to scale this Global datastore to.</p><br>
    ///   - [`engine(impl Into<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::engine) / [`set_engine(Option<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::set_engine):<br>required: **false**<br><p>Modifies the engine listed in a global replication group message. The options are redis, memcached or valkey.</p><br>
    ///   - [`engine_version(impl Into<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::engine_version) / [`set_engine_version(Option<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::set_engine_version):<br>required: **false**<br><p>The upgraded version of the cache engine to be run on the clusters in the Global datastore.</p><br>
    ///   - [`cache_parameter_group_name(impl Into<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::cache_parameter_group_name) / [`set_cache_parameter_group_name(Option<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::set_cache_parameter_group_name):<br>required: **false**<br><p>The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.</p><br>
    ///   - [`global_replication_group_description(impl Into<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::global_replication_group_description) / [`set_global_replication_group_description(Option<String>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::set_global_replication_group_description):<br>required: **false**<br><p>A description of the Global datastore</p><br>
    ///   - [`automatic_failover_enabled(bool)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::automatic_failover_enabled) / [`set_automatic_failover_enabled(Option<bool>)`](crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::set_automatic_failover_enabled):<br>required: **false**<br><p>Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.</p><br>
    /// - On success, responds with [`ModifyGlobalReplicationGroupOutput`](crate::operation::modify_global_replication_group::ModifyGlobalReplicationGroupOutput) with field(s):
    ///   - [`global_replication_group(Option<GlobalReplicationGroup>)`](crate::operation::modify_global_replication_group::ModifyGlobalReplicationGroupOutput::global_replication_group): <p>Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.</p> <ul>  <li>   <p>The <b>GlobalReplicationGroupIdSuffix</b> represents the name of the Global datastore, which is what you use to associate a secondary cluster.</p></li> </ul>
    /// - On failure, responds with [`SdkError<ModifyGlobalReplicationGroupError>`](crate::operation::modify_global_replication_group::ModifyGlobalReplicationGroupError)
    pub fn modify_global_replication_group(
        &self,
    ) -> crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder {
        crate::operation::modify_global_replication_group::builders::ModifyGlobalReplicationGroupFluentBuilder::new(self.handle.clone())
    }
}