aws_sdk_elasticache/client/failover_global_replication_group.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`FailoverGlobalReplicationGroup`](crate::operation::failover_global_replication_group::builders::FailoverGlobalReplicationGroupFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`global_replication_group_id(impl Into<String>)`](crate::operation::failover_global_replication_group::builders::FailoverGlobalReplicationGroupFluentBuilder::global_replication_group_id) / [`set_global_replication_group_id(Option<String>)`](crate::operation::failover_global_replication_group::builders::FailoverGlobalReplicationGroupFluentBuilder::set_global_replication_group_id):<br>required: **true**<br><p>The name of the Global datastore</p><br>
7 /// - [`primary_region(impl Into<String>)`](crate::operation::failover_global_replication_group::builders::FailoverGlobalReplicationGroupFluentBuilder::primary_region) / [`set_primary_region(Option<String>)`](crate::operation::failover_global_replication_group::builders::FailoverGlobalReplicationGroupFluentBuilder::set_primary_region):<br>required: **true**<br><p>The Amazon region of the primary cluster of the Global datastore</p><br>
8 /// - [`primary_replication_group_id(impl Into<String>)`](crate::operation::failover_global_replication_group::builders::FailoverGlobalReplicationGroupFluentBuilder::primary_replication_group_id) / [`set_primary_replication_group_id(Option<String>)`](crate::operation::failover_global_replication_group::builders::FailoverGlobalReplicationGroupFluentBuilder::set_primary_replication_group_id):<br>required: **true**<br><p>The name of the primary replication group</p><br>
9 /// - On success, responds with [`FailoverGlobalReplicationGroupOutput`](crate::operation::failover_global_replication_group::FailoverGlobalReplicationGroupOutput) with field(s):
10 /// - [`global_replication_group(Option<GlobalReplicationGroup>)`](crate::operation::failover_global_replication_group::FailoverGlobalReplicationGroupOutput::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>
11 /// - On failure, responds with [`SdkError<FailoverGlobalReplicationGroupError>`](crate::operation::failover_global_replication_group::FailoverGlobalReplicationGroupError)
12 pub fn failover_global_replication_group(
13 &self,
14 ) -> crate::operation::failover_global_replication_group::builders::FailoverGlobalReplicationGroupFluentBuilder {
15 crate::operation::failover_global_replication_group::builders::FailoverGlobalReplicationGroupFluentBuilder::new(self.handle.clone())
16 }
17}