Skip to main content

aws_sdk_workspacesinstances/operation/modify_volume/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::modify_volume::_modify_volume_input::ModifyVolumeInputBuilder;
3
4pub use crate::operation::modify_volume::_modify_volume_output::ModifyVolumeOutputBuilder;
5
6impl crate::operation::modify_volume::builders::ModifyVolumeInputBuilder {
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::modify_volume::ModifyVolumeOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::modify_volume::ModifyVolumeError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.modify_volume();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ModifyVolume`.
24///
25/// <p>Modifies the size, volume type, IOPS (input/output operations per second), or throughput of a volume. When you modify a volume, you must specify at least one of these parameters. You can modify a volume only after any previous modification for that volume has finished.</p>
26/// <p>To track the progress of a modification, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVolumesModifications.html">DescribeVolumesModifications</a> operation. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html">Monitor the progress of Amazon EBS volume modifications</a> in the <i>Amazon EBS User Guide</i>.</p>
27/// <p>After you increase the size of a volume, you must extend the partition and file system to use the new storage capacity. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/recognize-expanded-volume-linux.html">Extend the file system after resizing an Amazon EBS volume</a> in the <i>Amazon EBS User Guide</i>, which covers both <a href="https://docs.aws.amazon.com/ebs/latest/userguide/recognize-expanded-volume-linux.html#extend-linux">Linux</a> and <a href="https://docs.aws.amazon.com/ebs/latest/userguide/recognize-expanded-volume-linux.html#extend-windows">Windows</a> instances.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct ModifyVolumeFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::modify_volume::builders::ModifyVolumeInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::modify_volume::ModifyVolumeOutput,
37        crate::operation::modify_volume::ModifyVolumeError,
38    > for ModifyVolumeFluentBuilder
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::modify_volume::ModifyVolumeOutput,
46            crate::operation::modify_volume::ModifyVolumeError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl ModifyVolumeFluentBuilder {
53    /// Creates a new `ModifyVolumeFluentBuilder`.
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 ModifyVolume as a reference.
62    pub fn as_input(&self) -> &crate::operation::modify_volume::builders::ModifyVolumeInputBuilder {
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::modify_volume::ModifyVolumeOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::modify_volume::ModifyVolumeError,
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::modify_volume::ModifyVolume::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::modify_volume::ModifyVolume::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::modify_volume::ModifyVolumeOutput,
99        crate::operation::modify_volume::ModifyVolumeError,
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>Specifies the identifier of the volume to modify.</p>
114    pub fn volume_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.volume_id(input.into());
116        self
117    }
118    /// <p>Specifies the identifier of the volume to modify.</p>
119    pub fn set_volume_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_volume_id(input);
121        self
122    }
123    /// <p>Specifies the identifier of the volume to modify.</p>
124    pub fn get_volume_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_volume_id()
126    }
127    /// <p>Specifies the target size of the volume, in GiB. The target size must be greater than or equal to the current size of the volume. If you don't specify a size, the current size is retained.</p>
128    pub fn size_in_gb(mut self, input: i32) -> Self {
129        self.inner = self.inner.size_in_gb(input);
130        self
131    }
132    /// <p>Specifies the target size of the volume, in GiB. The target size must be greater than or equal to the current size of the volume. If you don't specify a size, the current size is retained.</p>
133    pub fn set_size_in_gb(mut self, input: ::std::option::Option<i32>) -> Self {
134        self.inner = self.inner.set_size_in_gb(input);
135        self
136    }
137    /// <p>Specifies the target size of the volume, in GiB. The target size must be greater than or equal to the current size of the volume. If you don't specify a size, the current size is retained.</p>
138    pub fn get_size_in_gb(&self) -> &::std::option::Option<i32> {
139        self.inner.get_size_in_gb()
140    }
141    /// <p>Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.</p>
142    pub fn volume_type(mut self, input: crate::types::VolumeTypeEnum) -> Self {
143        self.inner = self.inner.volume_type(input);
144        self
145    }
146    /// <p>Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.</p>
147    pub fn set_volume_type(mut self, input: ::std::option::Option<crate::types::VolumeTypeEnum>) -> Self {
148        self.inner = self.inner.set_volume_type(input);
149        self
150    }
151    /// <p>Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.</p>
152    pub fn get_volume_type(&self) -> &::std::option::Option<crate::types::VolumeTypeEnum> {
153        self.inner.get_volume_type()
154    }
155    /// <p>Specifies the target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes. If you don't specify IOPS and keep the same volume type, the current IOPS rate is retained.</p>
156    pub fn iops(mut self, input: i32) -> Self {
157        self.inner = self.inner.iops(input);
158        self
159    }
160    /// <p>Specifies the target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes. If you don't specify IOPS and keep the same volume type, the current IOPS rate is retained.</p>
161    pub fn set_iops(mut self, input: ::std::option::Option<i32>) -> Self {
162        self.inner = self.inner.set_iops(input);
163        self
164    }
165    /// <p>Specifies the target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes. If you don't specify IOPS and keep the same volume type, the current IOPS rate is retained.</p>
166    pub fn get_iops(&self) -> &::std::option::Option<i32> {
167        self.inner.get_iops()
168    }
169    /// <p>Specifies the target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. If you don't specify throughput and the volume remains <code>gp3</code>, the current throughput is retained.</p>
170    pub fn throughput(mut self, input: i32) -> Self {
171        self.inner = self.inner.throughput(input);
172        self
173    }
174    /// <p>Specifies the target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. If you don't specify throughput and the volume remains <code>gp3</code>, the current throughput is retained.</p>
175    pub fn set_throughput(mut self, input: ::std::option::Option<i32>) -> Self {
176        self.inner = self.inner.set_throughput(input);
177        self
178    }
179    /// <p>Specifies the target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. If you don't specify throughput and the volume remains <code>gp3</code>, the current throughput is retained.</p>
180    pub fn get_throughput(&self) -> &::std::option::Option<i32> {
181        self.inner.get_throughput()
182    }
183    /// <p>Unique token to ensure idempotent volume modification, preventing duplicate volume modifications.</p>
184    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
185        self.inner = self.inner.client_token(input.into());
186        self
187    }
188    /// <p>Unique token to ensure idempotent volume modification, preventing duplicate volume modifications.</p>
189    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
190        self.inner = self.inner.set_client_token(input);
191        self
192    }
193    /// <p>Unique token to ensure idempotent volume modification, preventing duplicate volume modifications.</p>
194    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
195        self.inner.get_client_token()
196    }
197}