aws_sdk_dynamodb/operation/create_global_table/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_global_table::_create_global_table_output::CreateGlobalTableOutputBuilder;
3
4pub use crate::operation::create_global_table::_create_global_table_input::CreateGlobalTableInputBuilder;
5
6impl crate::operation::create_global_table::builders::CreateGlobalTableInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::create_global_table::CreateGlobalTableOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_global_table::CreateGlobalTableError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_global_table();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateGlobalTable`.
24///
25/// <p>Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.</p><important>
26/// <p>This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Global Tables version 2019.11.21 (Current)</a> when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).</p>
27/// <p>To determine which version you're using, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the global table version you are using</a>. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">Upgrading global tables</a>.</p>
28/// </important>
29/// <p>If you want to add a new replica table to a global table, each of the following conditions must be true:</p>
30/// <ul>
31/// <li>
32/// <p>The table must have the same primary key as all of the other replicas.</p></li>
33/// <li>
34/// <p>The table must have the same name as all of the other replicas.</p></li>
35/// <li>
36/// <p>The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.</p></li>
37/// <li>
38/// <p>None of the replica tables in the global table can contain any data.</p></li>
39/// </ul>
40/// <p>If global secondary indexes are specified, then the following conditions must also be met:</p>
41/// <ul>
42/// <li>
43/// <p>The global secondary indexes must have the same name.</p></li>
44/// <li>
45/// <p>The global secondary indexes must have the same hash key and sort key (if present).</p></li>
46/// </ul>
47/// <p>If local secondary indexes are specified, then the following conditions must also be met:</p>
48/// <ul>
49/// <li>
50/// <p>The local secondary indexes must have the same name.</p></li>
51/// <li>
52/// <p>The local secondary indexes must have the same hash key and sort key (if present).</p></li>
53/// </ul><important>
54/// <p>Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.</p>
55/// <p>If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.</p>
56/// </important>
57#[derive(::std::clone::Clone, ::std::fmt::Debug)]
58pub struct CreateGlobalTableFluentBuilder {
59    handle: ::std::sync::Arc<crate::client::Handle>,
60    inner: crate::operation::create_global_table::builders::CreateGlobalTableInputBuilder,
61    config_override: ::std::option::Option<crate::config::Builder>,
62}
63impl
64    crate::client::customize::internal::CustomizableSend<
65        crate::operation::create_global_table::CreateGlobalTableOutput,
66        crate::operation::create_global_table::CreateGlobalTableError,
67    > for CreateGlobalTableFluentBuilder
68{
69    fn send(
70        self,
71        config_override: crate::config::Builder,
72    ) -> crate::client::customize::internal::BoxFuture<
73        crate::client::customize::internal::SendResult<
74            crate::operation::create_global_table::CreateGlobalTableOutput,
75            crate::operation::create_global_table::CreateGlobalTableError,
76        >,
77    > {
78        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
79    }
80}
81impl CreateGlobalTableFluentBuilder {
82    /// Creates a new `CreateGlobalTableFluentBuilder`.
83    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
84        Self {
85            handle,
86            inner: ::std::default::Default::default(),
87            config_override: ::std::option::Option::None,
88        }
89    }
90    /// Access the CreateGlobalTable as a reference.
91    pub fn as_input(&self) -> &crate::operation::create_global_table::builders::CreateGlobalTableInputBuilder {
92        &self.inner
93    }
94    /// Sends the request and returns the response.
95    ///
96    /// If an error occurs, an `SdkError` will be returned with additional details that
97    /// can be matched against.
98    ///
99    /// By default, any retryable failures will be retried twice. Retry behavior
100    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
101    /// set when configuring the client.
102    pub async fn send(
103        self,
104    ) -> ::std::result::Result<
105        crate::operation::create_global_table::CreateGlobalTableOutput,
106        ::aws_smithy_runtime_api::client::result::SdkError<
107            crate::operation::create_global_table::CreateGlobalTableError,
108            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
109        >,
110    > {
111        let input = self
112            .inner
113            .build()
114            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
115        let runtime_plugins = crate::operation::create_global_table::CreateGlobalTable::operation_runtime_plugins(
116            self.handle.runtime_plugins.clone(),
117            &self.handle.conf,
118            self.config_override,
119        );
120        crate::operation::create_global_table::CreateGlobalTable::orchestrate(&runtime_plugins, input).await
121    }
122
123    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
124    pub fn customize(
125        self,
126    ) -> crate::client::customize::CustomizableOperation<
127        crate::operation::create_global_table::CreateGlobalTableOutput,
128        crate::operation::create_global_table::CreateGlobalTableError,
129        Self,
130    > {
131        crate::client::customize::CustomizableOperation::new(self)
132    }
133    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
134        self.set_config_override(::std::option::Option::Some(config_override.into()));
135        self
136    }
137
138    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
139        self.config_override = config_override;
140        self
141    }
142    /// <p>The global table name.</p>
143    pub fn global_table_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
144        self.inner = self.inner.global_table_name(input.into());
145        self
146    }
147    /// <p>The global table name.</p>
148    pub fn set_global_table_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
149        self.inner = self.inner.set_global_table_name(input);
150        self
151    }
152    /// <p>The global table name.</p>
153    pub fn get_global_table_name(&self) -> &::std::option::Option<::std::string::String> {
154        self.inner.get_global_table_name()
155    }
156    ///
157    /// Appends an item to `ReplicationGroup`.
158    ///
159    /// To override the contents of this collection use [`set_replication_group`](Self::set_replication_group).
160    ///
161    /// <p>The Regions where the global table needs to be created.</p>
162    pub fn replication_group(mut self, input: crate::types::Replica) -> Self {
163        self.inner = self.inner.replication_group(input);
164        self
165    }
166    /// <p>The Regions where the global table needs to be created.</p>
167    pub fn set_replication_group(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Replica>>) -> Self {
168        self.inner = self.inner.set_replication_group(input);
169        self
170    }
171    /// <p>The Regions where the global table needs to be created.</p>
172    pub fn get_replication_group(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Replica>> {
173        self.inner.get_replication_group()
174    }
175}