// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::modify_volume::_modify_volume_input::ModifyVolumeInputBuilder;
pub use crate::operation::modify_volume::_modify_volume_output::ModifyVolumeOutputBuilder;
impl crate::operation::modify_volume::builders::ModifyVolumeInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::modify_volume::ModifyVolumeOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::modify_volume::ModifyVolumeError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.modify_volume();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `ModifyVolume`.
///
/// <p>You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-modify-volume.html">Amazon EBS Elastic Volumes</a> in the <i>Amazon EBS User Guide</i>.</p>
/// <p>When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of 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</a>.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html">Monitor the progress of volume modifications</a> in the <i>Amazon EBS User Guide</i>.</p>
/// <p>With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.</p>
/// <p>After you initiate a volume modification, you must wait for that modification to reach the <code>completed</code> state before you can initiate another modification for the same volume. You can modify a volume up to four times within a rolling 24-hour period, as long as the volume is in the <code>in-use</code> or <code>available</code> state, and all previous modifications for that volume are <code>completed</code>. If you exceed this limit, you get an error message that indicates when you can perform your next modification.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ModifyVolumeFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::modify_volume::builders::ModifyVolumeInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::modify_volume::ModifyVolumeOutput,
crate::operation::modify_volume::ModifyVolumeError,
> for ModifyVolumeFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::modify_volume::ModifyVolumeOutput,
crate::operation::modify_volume::ModifyVolumeError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl ModifyVolumeFluentBuilder {
/// Creates a new `ModifyVolumeFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the ModifyVolume as a reference.
pub fn as_input(&self) -> &crate::operation::modify_volume::builders::ModifyVolumeInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::modify_volume::ModifyVolumeOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::modify_volume::ModifyVolumeError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::modify_volume::ModifyVolume::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::modify_volume::ModifyVolume::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::modify_volume::ModifyVolumeOutput,
crate::operation::modify_volume::ModifyVolumeError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <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>
pub fn dry_run(mut self, input: bool) -> Self {
self.inner = self.inner.dry_run(input);
self
}
/// <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>
pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_dry_run(input);
self
}
/// <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>
pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
self.inner.get_dry_run()
}
/// <p>The ID of the volume.</p>
pub fn volume_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.volume_id(input.into());
self
}
/// <p>The ID of the volume.</p>
pub fn set_volume_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_volume_id(input);
self
}
/// <p>The ID of the volume.</p>
pub fn get_volume_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_volume_id()
}
/// <p>The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.</p>
/// <p>The following are the supported volumes sizes for each volume type:</p>
/// <ul>
/// <li>
/// <p><code>gp2</code>: 1 - 16,384 GiB</p></li>
/// <li>
/// <p><code>gp3</code>: 1 - 65,536 GiB</p></li>
/// <li>
/// <p><code>io1</code>: 4 - 16,384 GiB</p></li>
/// <li>
/// <p><code>io2</code>: 4 - 65,536 GiB</p></li>
/// <li>
/// <p><code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p></li>
/// <li>
/// <p><code>standard</code>: 1 - 1024 GiB</p></li>
/// </ul>
/// <p>Default: The existing size is retained.</p>
pub fn size(mut self, input: i32) -> Self {
self.inner = self.inner.size(input);
self
}
/// <p>The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.</p>
/// <p>The following are the supported volumes sizes for each volume type:</p>
/// <ul>
/// <li>
/// <p><code>gp2</code>: 1 - 16,384 GiB</p></li>
/// <li>
/// <p><code>gp3</code>: 1 - 65,536 GiB</p></li>
/// <li>
/// <p><code>io1</code>: 4 - 16,384 GiB</p></li>
/// <li>
/// <p><code>io2</code>: 4 - 65,536 GiB</p></li>
/// <li>
/// <p><code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p></li>
/// <li>
/// <p><code>standard</code>: 1 - 1024 GiB</p></li>
/// </ul>
/// <p>Default: The existing size is retained.</p>
pub fn set_size(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_size(input);
self
}
/// <p>The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.</p>
/// <p>The following are the supported volumes sizes for each volume type:</p>
/// <ul>
/// <li>
/// <p><code>gp2</code>: 1 - 16,384 GiB</p></li>
/// <li>
/// <p><code>gp3</code>: 1 - 65,536 GiB</p></li>
/// <li>
/// <p><code>io1</code>: 4 - 16,384 GiB</p></li>
/// <li>
/// <p><code>io2</code>: 4 - 65,536 GiB</p></li>
/// <li>
/// <p><code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p></li>
/// <li>
/// <p><code>standard</code>: 1 - 1024 GiB</p></li>
/// </ul>
/// <p>Default: The existing size is retained.</p>
pub fn get_size(&self) -> &::std::option::Option<i32> {
self.inner.get_size()
}
/// <p>The target EBS volume type of the volume. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html">Amazon EBS volume types</a> in the <i>Amazon EBS User Guide</i>.</p>
/// <p>Default: The existing type is retained.</p>
pub fn volume_type(mut self, input: crate::types::VolumeType) -> Self {
self.inner = self.inner.volume_type(input);
self
}
/// <p>The target EBS volume type of the volume. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html">Amazon EBS volume types</a> in the <i>Amazon EBS User Guide</i>.</p>
/// <p>Default: The existing type is retained.</p>
pub fn set_volume_type(mut self, input: ::std::option::Option<crate::types::VolumeType>) -> Self {
self.inner = self.inner.set_volume_type(input);
self
}
/// <p>The target EBS volume type of the volume. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html">Amazon EBS volume types</a> in the <i>Amazon EBS User Guide</i>.</p>
/// <p>Default: The existing type is retained.</p>
pub fn get_volume_type(&self) -> &::std::option::Option<crate::types::VolumeType> {
self.inner.get_volume_type()
}
/// <p>The target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes.</p>
/// <p>The following are the supported values for each volume type:</p>
/// <ul>
/// <li>
/// <p><code>gp3</code>: 3,000 - 80,000 IOPS</p></li>
/// <li>
/// <p><code>io1</code>: 100 - 64,000 IOPS</p></li>
/// <li>
/// <p><code>io2</code>: 100 - 256,000 IOPS</p></li>
/// </ul><note>
/// <p><a href="https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html"> Instances built on the Nitro System</a> can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.</p>
/// </note>
/// <p>Default: The existing value is retained if you keep the same volume type. If you change the volume type to <code>io1</code>, <code>io2</code>, or <code>gp3</code>, the default is 3,000.</p>
pub fn iops(mut self, input: i32) -> Self {
self.inner = self.inner.iops(input);
self
}
/// <p>The target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes.</p>
/// <p>The following are the supported values for each volume type:</p>
/// <ul>
/// <li>
/// <p><code>gp3</code>: 3,000 - 80,000 IOPS</p></li>
/// <li>
/// <p><code>io1</code>: 100 - 64,000 IOPS</p></li>
/// <li>
/// <p><code>io2</code>: 100 - 256,000 IOPS</p></li>
/// </ul><note>
/// <p><a href="https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html"> Instances built on the Nitro System</a> can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.</p>
/// </note>
/// <p>Default: The existing value is retained if you keep the same volume type. If you change the volume type to <code>io1</code>, <code>io2</code>, or <code>gp3</code>, the default is 3,000.</p>
pub fn set_iops(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_iops(input);
self
}
/// <p>The target IOPS rate of the volume. This parameter is valid only for <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes.</p>
/// <p>The following are the supported values for each volume type:</p>
/// <ul>
/// <li>
/// <p><code>gp3</code>: 3,000 - 80,000 IOPS</p></li>
/// <li>
/// <p><code>io1</code>: 100 - 64,000 IOPS</p></li>
/// <li>
/// <p><code>io2</code>: 100 - 256,000 IOPS</p></li>
/// </ul><note>
/// <p><a href="https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html"> Instances built on the Nitro System</a> can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.</p>
/// </note>
/// <p>Default: The existing value is retained if you keep the same volume type. If you change the volume type to <code>io1</code>, <code>io2</code>, or <code>gp3</code>, the default is 3,000.</p>
pub fn get_iops(&self) -> &::std::option::Option<i32> {
self.inner.get_iops()
}
/// <p>The target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. The maximum value is 2,000.</p>
/// <p>Default: The existing value is retained if the source and target volume type is <code>gp3</code>. Otherwise, the default value is 125.</p>
/// <p>Valid Range: Minimum value of 125. Maximum value of 2,000.</p>
pub fn throughput(mut self, input: i32) -> Self {
self.inner = self.inner.throughput(input);
self
}
/// <p>The target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. The maximum value is 2,000.</p>
/// <p>Default: The existing value is retained if the source and target volume type is <code>gp3</code>. Otherwise, the default value is 125.</p>
/// <p>Valid Range: Minimum value of 125. Maximum value of 2,000.</p>
pub fn set_throughput(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_throughput(input);
self
}
/// <p>The target throughput of the volume, in MiB/s. This parameter is valid only for <code>gp3</code> volumes. The maximum value is 2,000.</p>
/// <p>Default: The existing value is retained if the source and target volume type is <code>gp3</code>. Otherwise, the default value is 125.</p>
/// <p>Valid Range: Minimum value of 125. Maximum value of 2,000.</p>
pub fn get_throughput(&self) -> &::std::option::Option<i32> {
self.inner.get_throughput()
}
/// <p>Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 <a href="https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html"> Nitro-based instances</a> in the same Availability Zone. This parameter is supported with <code>io1</code> and <code>io2</code> volumes only. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html"> Amazon EBS Multi-Attach</a> in the <i>Amazon EBS User Guide</i>.</p>
pub fn multi_attach_enabled(mut self, input: bool) -> Self {
self.inner = self.inner.multi_attach_enabled(input);
self
}
/// <p>Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 <a href="https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html"> Nitro-based instances</a> in the same Availability Zone. This parameter is supported with <code>io1</code> and <code>io2</code> volumes only. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html"> Amazon EBS Multi-Attach</a> in the <i>Amazon EBS User Guide</i>.</p>
pub fn set_multi_attach_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_multi_attach_enabled(input);
self
}
/// <p>Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 <a href="https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html"> Nitro-based instances</a> in the same Availability Zone. This parameter is supported with <code>io1</code> and <code>io2</code> volumes only. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html"> Amazon EBS Multi-Attach</a> in the <i>Amazon EBS User Guide</i>.</p>
pub fn get_multi_attach_enabled(&self) -> &::std::option::Option<bool> {
self.inner.get_multi_attach_enabled()
}
}