aws_sdk_redshift/operation/delete_cluster/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_cluster::_delete_cluster_output::DeleteClusterOutputBuilder;
3
4pub use crate::operation::delete_cluster::_delete_cluster_input::DeleteClusterInputBuilder;
5
6impl crate::operation::delete_cluster::builders::DeleteClusterInputBuilder {
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::delete_cluster::DeleteClusterOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::delete_cluster::DeleteClusterError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.delete_cluster();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DeleteCluster`.
24///
25/// <p>Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use <code>DescribeClusters</code> to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
26/// <p>If you want to shut down the cluster and retain it for future use, set <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster.</p>
27/// <p>For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct DeleteClusterFluentBuilder {
30 handle: ::std::sync::Arc<crate::client::Handle>,
31 inner: crate::operation::delete_cluster::builders::DeleteClusterInputBuilder,
32 config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35 crate::client::customize::internal::CustomizableSend<
36 crate::operation::delete_cluster::DeleteClusterOutput,
37 crate::operation::delete_cluster::DeleteClusterError,
38 > for DeleteClusterFluentBuilder
39{
40 fn send(
41 self,
42 config_override: crate::config::Builder,
43 ) -> crate::client::customize::internal::BoxFuture<
44 crate::client::customize::internal::SendResult<
45 crate::operation::delete_cluster::DeleteClusterOutput,
46 crate::operation::delete_cluster::DeleteClusterError,
47 >,
48 > {
49 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50 }
51}
52impl DeleteClusterFluentBuilder {
53 /// Creates a new `DeleteClusterFluentBuilder`.
54 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55 Self {
56 handle,
57 inner: ::std::default::Default::default(),
58 config_override: ::std::option::Option::None,
59 }
60 }
61 /// Access the DeleteCluster as a reference.
62 pub fn as_input(&self) -> &crate::operation::delete_cluster::builders::DeleteClusterInputBuilder {
63 &self.inner
64 }
65 /// Sends the request and returns the response.
66 ///
67 /// If an error occurs, an `SdkError` will be returned with additional details that
68 /// can be matched against.
69 ///
70 /// By default, any retryable failures will be retried twice. Retry behavior
71 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72 /// set when configuring the client.
73 pub async fn send(
74 self,
75 ) -> ::std::result::Result<
76 crate::operation::delete_cluster::DeleteClusterOutput,
77 ::aws_smithy_runtime_api::client::result::SdkError<
78 crate::operation::delete_cluster::DeleteClusterError,
79 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80 >,
81 > {
82 let input = self
83 .inner
84 .build()
85 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86 let runtime_plugins = crate::operation::delete_cluster::DeleteCluster::operation_runtime_plugins(
87 self.handle.runtime_plugins.clone(),
88 &self.handle.conf,
89 self.config_override,
90 );
91 crate::operation::delete_cluster::DeleteCluster::orchestrate(&runtime_plugins, input).await
92 }
93
94 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95 pub fn customize(
96 self,
97 ) -> crate::client::customize::CustomizableOperation<
98 crate::operation::delete_cluster::DeleteClusterOutput,
99 crate::operation::delete_cluster::DeleteClusterError,
100 Self,
101 > {
102 crate::client::customize::CustomizableOperation::new(self)
103 }
104 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105 self.set_config_override(::std::option::Option::Some(config_override.into()));
106 self
107 }
108
109 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110 self.config_override = config_override;
111 self
112 }
113 /// <p>The identifier of the cluster to be deleted.</p>
114 /// <p>Constraints:</p>
115 /// <ul>
116 /// <li>
117 /// <p>Must contain lowercase characters.</p></li>
118 /// <li>
119 /// <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p></li>
120 /// <li>
121 /// <p>First character must be a letter.</p></li>
122 /// <li>
123 /// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
124 /// </ul>
125 pub fn cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
126 self.inner = self.inner.cluster_identifier(input.into());
127 self
128 }
129 /// <p>The identifier of the cluster to be deleted.</p>
130 /// <p>Constraints:</p>
131 /// <ul>
132 /// <li>
133 /// <p>Must contain lowercase characters.</p></li>
134 /// <li>
135 /// <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p></li>
136 /// <li>
137 /// <p>First character must be a letter.</p></li>
138 /// <li>
139 /// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
140 /// </ul>
141 pub fn set_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
142 self.inner = self.inner.set_cluster_identifier(input);
143 self
144 }
145 /// <p>The identifier of the cluster to be deleted.</p>
146 /// <p>Constraints:</p>
147 /// <ul>
148 /// <li>
149 /// <p>Must contain lowercase characters.</p></li>
150 /// <li>
151 /// <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p></li>
152 /// <li>
153 /// <p>First character must be a letter.</p></li>
154 /// <li>
155 /// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
156 /// </ul>
157 pub fn get_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
158 self.inner.get_cluster_identifier()
159 }
160 /// <p>Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If <code>false</code>, a final cluster snapshot is created before the cluster is deleted.</p><note>
161 /// <p>The <i>FinalClusterSnapshotIdentifier</i> parameter must be specified if <i>SkipFinalClusterSnapshot</i> is <code>false</code>.</p>
162 /// </note>
163 /// <p>Default: <code>false</code></p>
164 pub fn skip_final_cluster_snapshot(mut self, input: bool) -> Self {
165 self.inner = self.inner.skip_final_cluster_snapshot(input);
166 self
167 }
168 /// <p>Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If <code>false</code>, a final cluster snapshot is created before the cluster is deleted.</p><note>
169 /// <p>The <i>FinalClusterSnapshotIdentifier</i> parameter must be specified if <i>SkipFinalClusterSnapshot</i> is <code>false</code>.</p>
170 /// </note>
171 /// <p>Default: <code>false</code></p>
172 pub fn set_skip_final_cluster_snapshot(mut self, input: ::std::option::Option<bool>) -> Self {
173 self.inner = self.inner.set_skip_final_cluster_snapshot(input);
174 self
175 }
176 /// <p>Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If <code>false</code>, a final cluster snapshot is created before the cluster is deleted.</p><note>
177 /// <p>The <i>FinalClusterSnapshotIdentifier</i> parameter must be specified if <i>SkipFinalClusterSnapshot</i> is <code>false</code>.</p>
178 /// </note>
179 /// <p>Default: <code>false</code></p>
180 pub fn get_skip_final_cluster_snapshot(&self) -> &::std::option::Option<bool> {
181 self.inner.get_skip_final_cluster_snapshot()
182 }
183 /// <p>The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, <i>SkipFinalClusterSnapshot</i> must be <code>false</code>.</p>
184 /// <p>Constraints:</p>
185 /// <ul>
186 /// <li>
187 /// <p>Must be 1 to 255 alphanumeric characters.</p></li>
188 /// <li>
189 /// <p>First character must be a letter.</p></li>
190 /// <li>
191 /// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
192 /// </ul>
193 pub fn final_cluster_snapshot_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
194 self.inner = self.inner.final_cluster_snapshot_identifier(input.into());
195 self
196 }
197 /// <p>The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, <i>SkipFinalClusterSnapshot</i> must be <code>false</code>.</p>
198 /// <p>Constraints:</p>
199 /// <ul>
200 /// <li>
201 /// <p>Must be 1 to 255 alphanumeric characters.</p></li>
202 /// <li>
203 /// <p>First character must be a letter.</p></li>
204 /// <li>
205 /// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
206 /// </ul>
207 pub fn set_final_cluster_snapshot_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
208 self.inner = self.inner.set_final_cluster_snapshot_identifier(input);
209 self
210 }
211 /// <p>The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, <i>SkipFinalClusterSnapshot</i> must be <code>false</code>.</p>
212 /// <p>Constraints:</p>
213 /// <ul>
214 /// <li>
215 /// <p>Must be 1 to 255 alphanumeric characters.</p></li>
216 /// <li>
217 /// <p>First character must be a letter.</p></li>
218 /// <li>
219 /// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
220 /// </ul>
221 pub fn get_final_cluster_snapshot_identifier(&self) -> &::std::option::Option<::std::string::String> {
222 self.inner.get_final_cluster_snapshot_identifier()
223 }
224 /// <p>The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.</p>
225 /// <p>The value must be either -1 or an integer between 1 and 3,653.</p>
226 /// <p>The default value is -1.</p>
227 pub fn final_cluster_snapshot_retention_period(mut self, input: i32) -> Self {
228 self.inner = self.inner.final_cluster_snapshot_retention_period(input);
229 self
230 }
231 /// <p>The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.</p>
232 /// <p>The value must be either -1 or an integer between 1 and 3,653.</p>
233 /// <p>The default value is -1.</p>
234 pub fn set_final_cluster_snapshot_retention_period(mut self, input: ::std::option::Option<i32>) -> Self {
235 self.inner = self.inner.set_final_cluster_snapshot_retention_period(input);
236 self
237 }
238 /// <p>The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.</p>
239 /// <p>The value must be either -1 or an integer between 1 and 3,653.</p>
240 /// <p>The default value is -1.</p>
241 pub fn get_final_cluster_snapshot_retention_period(&self) -> &::std::option::Option<i32> {
242 self.inner.get_final_cluster_snapshot_retention_period()
243 }
244}