aws_sdk_rds/operation/switchover_global_cluster/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::switchover_global_cluster::_switchover_global_cluster_output::SwitchoverGlobalClusterOutputBuilder;
3
4pub use crate::operation::switchover_global_cluster::_switchover_global_cluster_input::SwitchoverGlobalClusterInputBuilder;
5
6impl crate::operation::switchover_global_cluster::builders::SwitchoverGlobalClusterInputBuilder {
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::switchover_global_cluster::SwitchoverGlobalClusterOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::switchover_global_cluster::SwitchoverGlobalClusterError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.switchover_global_cluster();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `SwitchoverGlobalCluster`.
24///
25/// <p>Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."</p>
26/// <p>Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover">Performing switchovers for Amazon Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p><note>
27/// <p>This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.</p>
28/// </note>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct SwitchoverGlobalClusterFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::switchover_global_cluster::builders::SwitchoverGlobalClusterInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::switchover_global_cluster::SwitchoverGlobalClusterOutput,
38        crate::operation::switchover_global_cluster::SwitchoverGlobalClusterError,
39    > for SwitchoverGlobalClusterFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::switchover_global_cluster::SwitchoverGlobalClusterOutput,
47            crate::operation::switchover_global_cluster::SwitchoverGlobalClusterError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl SwitchoverGlobalClusterFluentBuilder {
54    /// Creates a new `SwitchoverGlobalClusterFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the SwitchoverGlobalCluster as a reference.
63    pub fn as_input(&self) -> &crate::operation::switchover_global_cluster::builders::SwitchoverGlobalClusterInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::switchover_global_cluster::SwitchoverGlobalClusterOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::switchover_global_cluster::SwitchoverGlobalClusterError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::switchover_global_cluster::SwitchoverGlobalCluster::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::switchover_global_cluster::SwitchoverGlobalCluster::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::switchover_global_cluster::SwitchoverGlobalClusterOutput,
100        crate::operation::switchover_global_cluster::SwitchoverGlobalClusterError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// <p>The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.</p>
115    /// <p>Constraints:</p>
116    /// <ul>
117    /// <li>
118    /// <p>Must match the identifier of an existing global database cluster (Aurora global database).</p></li>
119    /// </ul>
120    pub fn global_cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.global_cluster_identifier(input.into());
122        self
123    }
124    /// <p>The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.</p>
125    /// <p>Constraints:</p>
126    /// <ul>
127    /// <li>
128    /// <p>Must match the identifier of an existing global database cluster (Aurora global database).</p></li>
129    /// </ul>
130    pub fn set_global_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
131        self.inner = self.inner.set_global_cluster_identifier(input);
132        self
133    }
134    /// <p>The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.</p>
135    /// <p>Constraints:</p>
136    /// <ul>
137    /// <li>
138    /// <p>Must match the identifier of an existing global database cluster (Aurora global database).</p></li>
139    /// </ul>
140    pub fn get_global_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
141        self.inner.get_global_cluster_identifier()
142    }
143    /// <p>The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.</p>
144    pub fn target_db_cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
145        self.inner = self.inner.target_db_cluster_identifier(input.into());
146        self
147    }
148    /// <p>The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.</p>
149    pub fn set_target_db_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
150        self.inner = self.inner.set_target_db_cluster_identifier(input);
151        self
152    }
153    /// <p>The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.</p>
154    pub fn get_target_db_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
155        self.inner.get_target_db_cluster_identifier()
156    }
157}
aws_sdk_rds/operation/switchover_global_cluster/builders.rs

aws_sdk_rds/operation/switchover_global_cluster/
builders.rs
