aws_sdk_ec2/operation/detach_volume/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::detach_volume::_detach_volume_output::DetachVolumeOutputBuilder;
3
4pub use crate::operation::detach_volume::_detach_volume_input::DetachVolumeInputBuilder;
5
6impl crate::operation::detach_volume::builders::DetachVolumeInputBuilder {
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::detach_volume::DetachVolumeOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::detach_volume::DetachVolumeError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.detach_volume();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DetachVolume`.
24///
25/// <p>Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the <code>busy</code> state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.</p>
26/// <p>When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.</p>
27/// <p>You can't detach or force detach volumes that are attached to Amazon ECS or Fargate tasks. Attempting to do this results in the <code>UnsupportedOperationException</code> exception with the <code>Unable to detach volume attached to ECS tasks</code> error message.</p>
28/// <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-detaching-volume.html">Detach an Amazon EBS volume</a> in the <i>Amazon EBS User Guide</i>.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct DetachVolumeFluentBuilder {
31 handle: ::std::sync::Arc<crate::client::Handle>,
32 inner: crate::operation::detach_volume::builders::DetachVolumeInputBuilder,
33 config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36 crate::client::customize::internal::CustomizableSend<
37 crate::operation::detach_volume::DetachVolumeOutput,
38 crate::operation::detach_volume::DetachVolumeError,
39 > for DetachVolumeFluentBuilder
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::detach_volume::DetachVolumeOutput,
47 crate::operation::detach_volume::DetachVolumeError,
48 >,
49 > {
50 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51 }
52}
53impl DetachVolumeFluentBuilder {
54 /// Creates a new `DetachVolumeFluentBuilder`.
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 DetachVolume as a reference.
63 pub fn as_input(&self) -> &crate::operation::detach_volume::builders::DetachVolumeInputBuilder {
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::detach_volume::DetachVolumeOutput,
78 ::aws_smithy_runtime_api::client::result::SdkError<
79 crate::operation::detach_volume::DetachVolumeError,
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::detach_volume::DetachVolume::operation_runtime_plugins(
88 self.handle.runtime_plugins.clone(),
89 &self.handle.conf,
90 self.config_override,
91 );
92 crate::operation::detach_volume::DetachVolume::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::detach_volume::DetachVolumeOutput,
100 crate::operation::detach_volume::DetachVolumeError,
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 device name.</p>
115 pub fn device(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116 self.inner = self.inner.device(input.into());
117 self
118 }
119 /// <p>The device name.</p>
120 pub fn set_device(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121 self.inner = self.inner.set_device(input);
122 self
123 }
124 /// <p>The device name.</p>
125 pub fn get_device(&self) -> &::std::option::Option<::std::string::String> {
126 self.inner.get_device()
127 }
128 /// <p>Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.</p>
129 pub fn force(mut self, input: bool) -> Self {
130 self.inner = self.inner.force(input);
131 self
132 }
133 /// <p>Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.</p>
134 pub fn set_force(mut self, input: ::std::option::Option<bool>) -> Self {
135 self.inner = self.inner.set_force(input);
136 self
137 }
138 /// <p>Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.</p>
139 pub fn get_force(&self) -> &::std::option::Option<bool> {
140 self.inner.get_force()
141 }
142 /// <p>The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.</p>
143 pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
144 self.inner = self.inner.instance_id(input.into());
145 self
146 }
147 /// <p>The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.</p>
148 pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
149 self.inner = self.inner.set_instance_id(input);
150 self
151 }
152 /// <p>The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.</p>
153 pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
154 self.inner.get_instance_id()
155 }
156 /// <p>The ID of the volume.</p>
157 pub fn volume_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
158 self.inner = self.inner.volume_id(input.into());
159 self
160 }
161 /// <p>The ID of the volume.</p>
162 pub fn set_volume_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
163 self.inner = self.inner.set_volume_id(input);
164 self
165 }
166 /// <p>The ID of the volume.</p>
167 pub fn get_volume_id(&self) -> &::std::option::Option<::std::string::String> {
168 self.inner.get_volume_id()
169 }
170 /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
171 pub fn dry_run(mut self, input: bool) -> Self {
172 self.inner = self.inner.dry_run(input);
173 self
174 }
175 /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
176 pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
177 self.inner = self.inner.set_dry_run(input);
178 self
179 }
180 /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
181 pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
182 self.inner.get_dry_run()
183 }
184}