aws_sdk_docdbelastic/operation/copy_cluster_snapshot/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::copy_cluster_snapshot::_copy_cluster_snapshot_output::CopyClusterSnapshotOutputBuilder;
3
4pub use crate::operation::copy_cluster_snapshot::_copy_cluster_snapshot_input::CopyClusterSnapshotInputBuilder;
5
6impl crate::operation::copy_cluster_snapshot::builders::CopyClusterSnapshotInputBuilder {
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::copy_cluster_snapshot::CopyClusterSnapshotOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::copy_cluster_snapshot::CopyClusterSnapshotError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.copy_cluster_snapshot();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CopyClusterSnapshot`.
24///
25/// <p>Copies a snapshot of an elastic cluster.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CopyClusterSnapshotFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::copy_cluster_snapshot::builders::CopyClusterSnapshotInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::copy_cluster_snapshot::CopyClusterSnapshotOutput,
35        crate::operation::copy_cluster_snapshot::CopyClusterSnapshotError,
36    > for CopyClusterSnapshotFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::copy_cluster_snapshot::CopyClusterSnapshotOutput,
44            crate::operation::copy_cluster_snapshot::CopyClusterSnapshotError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CopyClusterSnapshotFluentBuilder {
51    /// Creates a new `CopyClusterSnapshotFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the CopyClusterSnapshot as a reference.
60    pub fn as_input(&self) -> &crate::operation::copy_cluster_snapshot::builders::CopyClusterSnapshotInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::copy_cluster_snapshot::CopyClusterSnapshotOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::copy_cluster_snapshot::CopyClusterSnapshotError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::copy_cluster_snapshot::CopyClusterSnapshot::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::copy_cluster_snapshot::CopyClusterSnapshot::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::copy_cluster_snapshot::CopyClusterSnapshotOutput,
97        crate::operation::copy_cluster_snapshot::CopyClusterSnapshotError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.</p>
112    pub fn snapshot_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.snapshot_arn(input.into());
114        self
115    }
116    /// <p>The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.</p>
117    pub fn set_snapshot_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_snapshot_arn(input);
119        self
120    }
121    /// <p>The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.</p>
122    pub fn get_snapshot_arn(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_snapshot_arn()
124    }
125    /// <p>The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.</p>
126    /// <p>Constraints:</p>
127    /// <ul>
128    /// <li>
129    /// <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p></li>
130    /// <li>
131    /// <p>The first character must be a letter.</p></li>
132    /// <li>
133    /// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
134    /// </ul>
135    /// <p>Example: <code>elastic-cluster-snapshot-5</code></p>
136    pub fn target_snapshot_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
137        self.inner = self.inner.target_snapshot_name(input.into());
138        self
139    }
140    /// <p>The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.</p>
141    /// <p>Constraints:</p>
142    /// <ul>
143    /// <li>
144    /// <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p></li>
145    /// <li>
146    /// <p>The first character must be a letter.</p></li>
147    /// <li>
148    /// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
149    /// </ul>
150    /// <p>Example: <code>elastic-cluster-snapshot-5</code></p>
151    pub fn set_target_snapshot_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
152        self.inner = self.inner.set_target_snapshot_name(input);
153        self
154    }
155    /// <p>The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.</p>
156    /// <p>Constraints:</p>
157    /// <ul>
158    /// <li>
159    /// <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p></li>
160    /// <li>
161    /// <p>The first character must be a letter.</p></li>
162    /// <li>
163    /// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
164    /// </ul>
165    /// <p>Example: <code>elastic-cluster-snapshot-5</code></p>
166    pub fn get_target_snapshot_name(&self) -> &::std::option::Option<::std::string::String> {
167        self.inner.get_target_snapshot_name()
168    }
169    /// <p>The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.</p>
170    /// <p>If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the elastic cluster snapshot is encrypted with the same <code>AWS</code> KMS key as the source elastic cluster snapshot.</p>
171    /// <p>To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set <code>KmsKeyId</code> to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.</p>
172    /// <p>If you copy an unencrypted elastic cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>
173    pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
174        self.inner = self.inner.kms_key_id(input.into());
175        self
176    }
177    /// <p>The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.</p>
178    /// <p>If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the elastic cluster snapshot is encrypted with the same <code>AWS</code> KMS key as the source elastic cluster snapshot.</p>
179    /// <p>To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set <code>KmsKeyId</code> to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.</p>
180    /// <p>If you copy an unencrypted elastic cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>
181    pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
182        self.inner = self.inner.set_kms_key_id(input);
183        self
184    }
185    /// <p>The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.</p>
186    /// <p>If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the elastic cluster snapshot is encrypted with the same <code>AWS</code> KMS key as the source elastic cluster snapshot.</p>
187    /// <p>To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set <code>KmsKeyId</code> to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.</p>
188    /// <p>If you copy an unencrypted elastic cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>
189    pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
190        self.inner.get_kms_key_id()
191    }
192    /// <p>Set to <code>true</code> to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is <code>false</code>.</p>
193    pub fn copy_tags(mut self, input: bool) -> Self {
194        self.inner = self.inner.copy_tags(input);
195        self
196    }
197    /// <p>Set to <code>true</code> to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is <code>false</code>.</p>
198    pub fn set_copy_tags(mut self, input: ::std::option::Option<bool>) -> Self {
199        self.inner = self.inner.set_copy_tags(input);
200        self
201    }
202    /// <p>Set to <code>true</code> to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is <code>false</code>.</p>
203    pub fn get_copy_tags(&self) -> &::std::option::Option<bool> {
204        self.inner.get_copy_tags()
205    }
206    ///
207    /// Adds a key-value pair to `tags`.
208    ///
209    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
210    ///
211    /// <p>The tags to be assigned to the elastic cluster snapshot.</p>
212    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
213        self.inner = self.inner.tags(k.into(), v.into());
214        self
215    }
216    /// <p>The tags to be assigned to the elastic cluster snapshot.</p>
217    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
218        self.inner = self.inner.set_tags(input);
219        self
220    }
221    /// <p>The tags to be assigned to the elastic cluster snapshot.</p>
222    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
223        self.inner.get_tags()
224    }
225}