aws_sdk_elasticache/client/
create_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 [`CreateGlobalReplicationGroup`](crate::operation::create_global_replication_group::builders::CreateGlobalReplicationGroupFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`global_replication_group_id_suffix(impl Into<String>)`](crate::operation::create_global_replication_group::builders::CreateGlobalReplicationGroupFluentBuilder::global_replication_group_id_suffix) / [`set_global_replication_group_id_suffix(Option<String>)`](crate::operation::create_global_replication_group::builders::CreateGlobalReplicationGroupFluentBuilder::set_global_replication_group_id_suffix):<br>required: **true**<br><p>The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.</p> <p>For a full list of Amazon Regions and their respective Global datastore iD prefixes, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastores-CLI.html">Using the Amazon CLI with Global datastores </a>.</p><br>
7    ///   - [`global_replication_group_description(impl Into<String>)`](crate::operation::create_global_replication_group::builders::CreateGlobalReplicationGroupFluentBuilder::global_replication_group_description) / [`set_global_replication_group_description(Option<String>)`](crate::operation::create_global_replication_group::builders::CreateGlobalReplicationGroupFluentBuilder::set_global_replication_group_description):<br>required: **false**<br><p>Provides details of the Global datastore</p><br>
8    ///   - [`primary_replication_group_id(impl Into<String>)`](crate::operation::create_global_replication_group::builders::CreateGlobalReplicationGroupFluentBuilder::primary_replication_group_id) / [`set_primary_replication_group_id(Option<String>)`](crate::operation::create_global_replication_group::builders::CreateGlobalReplicationGroupFluentBuilder::set_primary_replication_group_id):<br>required: **true**<br><p>The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.</p><br>
9    /// - On success, responds with [`CreateGlobalReplicationGroupOutput`](crate::operation::create_global_replication_group::CreateGlobalReplicationGroupOutput) with field(s):
10    ///   - [`global_replication_group(Option<GlobalReplicationGroup>)`](crate::operation::create_global_replication_group::CreateGlobalReplicationGroupOutput::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<CreateGlobalReplicationGroupError>`](crate::operation::create_global_replication_group::CreateGlobalReplicationGroupError)
12    pub fn create_global_replication_group(
13        &self,
14    ) -> crate::operation::create_global_replication_group::builders::CreateGlobalReplicationGroupFluentBuilder {
15        crate::operation::create_global_replication_group::builders::CreateGlobalReplicationGroupFluentBuilder::new(self.handle.clone())
16    }
17}