aws_sdk_ec2/operation/copy_volumes/

_copy_volumes_input.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CopyVolumesInput {
    /// <p>The ID of the source EBS volume to copy.</p>
    pub source_volume_id: ::std::option::Option<::std::string::String>,
    /// <p>The number of I/O operations per second (IOPS) to provision for the volume copy. Required for <code>io1</code> and <code>io2</code> volumes. Optional for <code>gp3</code> volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid ranges:</p>
    /// <ul>
    /// <li>
    /// <p>gp3: <code>3,000 </code>(<i>default</i>)<code> - 80,000</code> IOPS</p></li>
    /// <li>
    /// <p>io1: <code>100 - 64,000</code> IOPS</p></li>
    /// <li>
    /// <p>io2: <code>100 - 256,000</code> 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>
    pub iops: ::std::option::Option<i32>,
    /// <p>The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume.</p>
    /// <p>Maximum supported sizes:</p>
    /// <ul>
    /// <li>
    /// <p>gp2: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>gp3: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>io1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>io2: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>st1 and sc1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>standard: <code>1024</code> GiB</p></li>
    /// </ul>
    pub size: ::std::option::Option<i32>,
    /// <p>The volume type for the volume copy. If not specified, the volume type defaults to <code>gp2</code>.</p>
    pub volume_type: ::std::option::Option<crate::types::VolumeType>,
    /// <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 dry_run: ::std::option::Option<bool>,
    /// <p>The tags to apply to the volume copy during creation.</p>
    pub tag_specifications: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>,
    /// <p>Indicates whether to enable Amazon EBS Multi-Attach for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. 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>.</p>
    pub multi_attach_enabled: ::std::option::Option<bool>,
    /// <p>The throughput to provision for the volume copy, in MiB/s. Supported for <code>gp3</code> volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid Range: <code>125 - 2000</code> MiB/s</p>
    /// <p></p>
    pub throughput: ::std::option::Option<i32>,
    /// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html"> Ensure Idempotency</a>.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
}
impl CopyVolumesInput {
    /// <p>The ID of the source EBS volume to copy.</p>
    pub fn source_volume_id(&self) -> ::std::option::Option<&str> {
        self.source_volume_id.as_deref()
    }
    /// <p>The number of I/O operations per second (IOPS) to provision for the volume copy. Required for <code>io1</code> and <code>io2</code> volumes. Optional for <code>gp3</code> volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid ranges:</p>
    /// <ul>
    /// <li>
    /// <p>gp3: <code>3,000 </code>(<i>default</i>)<code> - 80,000</code> IOPS</p></li>
    /// <li>
    /// <p>io1: <code>100 - 64,000</code> IOPS</p></li>
    /// <li>
    /// <p>io2: <code>100 - 256,000</code> 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>
    pub fn iops(&self) -> ::std::option::Option<i32> {
        self.iops
    }
    /// <p>The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume.</p>
    /// <p>Maximum supported sizes:</p>
    /// <ul>
    /// <li>
    /// <p>gp2: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>gp3: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>io1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>io2: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>st1 and sc1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>standard: <code>1024</code> GiB</p></li>
    /// </ul>
    pub fn size(&self) -> ::std::option::Option<i32> {
        self.size
    }
    /// <p>The volume type for the volume copy. If not specified, the volume type defaults to <code>gp2</code>.</p>
    pub fn volume_type(&self) -> ::std::option::Option<&crate::types::VolumeType> {
        self.volume_type.as_ref()
    }
    /// <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(&self) -> ::std::option::Option<bool> {
        self.dry_run
    }
    /// <p>The tags to apply to the volume copy during creation.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tag_specifications.is_none()`.
    pub fn tag_specifications(&self) -> &[crate::types::TagSpecification] {
        self.tag_specifications.as_deref().unwrap_or_default()
    }
    /// <p>Indicates whether to enable Amazon EBS Multi-Attach for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. 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>.</p>
    pub fn multi_attach_enabled(&self) -> ::std::option::Option<bool> {
        self.multi_attach_enabled
    }
    /// <p>The throughput to provision for the volume copy, in MiB/s. Supported for <code>gp3</code> volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid Range: <code>125 - 2000</code> MiB/s</p>
    /// <p></p>
    pub fn throughput(&self) -> ::std::option::Option<i32> {
        self.throughput
    }
    /// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html"> Ensure Idempotency</a>.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
}
impl CopyVolumesInput {
    /// Creates a new builder-style object to manufacture [`CopyVolumesInput`](crate::operation::copy_volumes::CopyVolumesInput).
    pub fn builder() -> crate::operation::copy_volumes::builders::CopyVolumesInputBuilder {
        crate::operation::copy_volumes::builders::CopyVolumesInputBuilder::default()
    }
}

/// A builder for [`CopyVolumesInput`](crate::operation::copy_volumes::CopyVolumesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CopyVolumesInputBuilder {
    pub(crate) source_volume_id: ::std::option::Option<::std::string::String>,
    pub(crate) iops: ::std::option::Option<i32>,
    pub(crate) size: ::std::option::Option<i32>,
    pub(crate) volume_type: ::std::option::Option<crate::types::VolumeType>,
    pub(crate) dry_run: ::std::option::Option<bool>,
    pub(crate) tag_specifications: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>,
    pub(crate) multi_attach_enabled: ::std::option::Option<bool>,
    pub(crate) throughput: ::std::option::Option<i32>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl CopyVolumesInputBuilder {
    /// <p>The ID of the source EBS volume to copy.</p>
    /// This field is required.
    pub fn source_volume_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.source_volume_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the source EBS volume to copy.</p>
    pub fn set_source_volume_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.source_volume_id = input;
        self
    }
    /// <p>The ID of the source EBS volume to copy.</p>
    pub fn get_source_volume_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.source_volume_id
    }
    /// <p>The number of I/O operations per second (IOPS) to provision for the volume copy. Required for <code>io1</code> and <code>io2</code> volumes. Optional for <code>gp3</code> volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid ranges:</p>
    /// <ul>
    /// <li>
    /// <p>gp3: <code>3,000 </code>(<i>default</i>)<code> - 80,000</code> IOPS</p></li>
    /// <li>
    /// <p>io1: <code>100 - 64,000</code> IOPS</p></li>
    /// <li>
    /// <p>io2: <code>100 - 256,000</code> 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>
    pub fn iops(mut self, input: i32) -> Self {
        self.iops = ::std::option::Option::Some(input);
        self
    }
    /// <p>The number of I/O operations per second (IOPS) to provision for the volume copy. Required for <code>io1</code> and <code>io2</code> volumes. Optional for <code>gp3</code> volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid ranges:</p>
    /// <ul>
    /// <li>
    /// <p>gp3: <code>3,000 </code>(<i>default</i>)<code> - 80,000</code> IOPS</p></li>
    /// <li>
    /// <p>io1: <code>100 - 64,000</code> IOPS</p></li>
    /// <li>
    /// <p>io2: <code>100 - 256,000</code> 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>
    pub fn set_iops(mut self, input: ::std::option::Option<i32>) -> Self {
        self.iops = input;
        self
    }
    /// <p>The number of I/O operations per second (IOPS) to provision for the volume copy. Required for <code>io1</code> and <code>io2</code> volumes. Optional for <code>gp3</code> volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid ranges:</p>
    /// <ul>
    /// <li>
    /// <p>gp3: <code>3,000 </code>(<i>default</i>)<code> - 80,000</code> IOPS</p></li>
    /// <li>
    /// <p>io1: <code>100 - 64,000</code> IOPS</p></li>
    /// <li>
    /// <p>io2: <code>100 - 256,000</code> 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>
    pub fn get_iops(&self) -> &::std::option::Option<i32> {
        &self.iops
    }
    /// <p>The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume.</p>
    /// <p>Maximum supported sizes:</p>
    /// <ul>
    /// <li>
    /// <p>gp2: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>gp3: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>io1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>io2: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>st1 and sc1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>standard: <code>1024</code> GiB</p></li>
    /// </ul>
    pub fn size(mut self, input: i32) -> Self {
        self.size = ::std::option::Option::Some(input);
        self
    }
    /// <p>The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume.</p>
    /// <p>Maximum supported sizes:</p>
    /// <ul>
    /// <li>
    /// <p>gp2: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>gp3: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>io1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>io2: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>st1 and sc1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>standard: <code>1024</code> GiB</p></li>
    /// </ul>
    pub fn set_size(mut self, input: ::std::option::Option<i32>) -> Self {
        self.size = input;
        self
    }
    /// <p>The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume.</p>
    /// <p>Maximum supported sizes:</p>
    /// <ul>
    /// <li>
    /// <p>gp2: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>gp3: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>io1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>io2: <code>65,536</code> GiB</p></li>
    /// <li>
    /// <p>st1 and sc1: <code>16,384</code> GiB</p></li>
    /// <li>
    /// <p>standard: <code>1024</code> GiB</p></li>
    /// </ul>
    pub fn get_size(&self) -> &::std::option::Option<i32> {
        &self.size
    }
    /// <p>The volume type for the volume copy. If not specified, the volume type defaults to <code>gp2</code>.</p>
    pub fn volume_type(mut self, input: crate::types::VolumeType) -> Self {
        self.volume_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The volume type for the volume copy. If not specified, the volume type defaults to <code>gp2</code>.</p>
    pub fn set_volume_type(mut self, input: ::std::option::Option<crate::types::VolumeType>) -> Self {
        self.volume_type = input;
        self
    }
    /// <p>The volume type for the volume copy. If not specified, the volume type defaults to <code>gp2</code>.</p>
    pub fn get_volume_type(&self) -> &::std::option::Option<crate::types::VolumeType> {
        &self.volume_type
    }
    /// <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.dry_run = ::std::option::Option::Some(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.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.dry_run
    }
    /// Appends an item to `tag_specifications`.
    ///
    /// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
    ///
    /// <p>The tags to apply to the volume copy during creation.</p>
    pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
        let mut v = self.tag_specifications.unwrap_or_default();
        v.push(input);
        self.tag_specifications = ::std::option::Option::Some(v);
        self
    }
    /// <p>The tags to apply to the volume copy during creation.</p>
    pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
        self.tag_specifications = input;
        self
    }
    /// <p>The tags to apply to the volume copy during creation.</p>
    pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
        &self.tag_specifications
    }
    /// <p>Indicates whether to enable Amazon EBS Multi-Attach for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. 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>.</p>
    pub fn multi_attach_enabled(mut self, input: bool) -> Self {
        self.multi_attach_enabled = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether to enable Amazon EBS Multi-Attach for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. 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>.</p>
    pub fn set_multi_attach_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.multi_attach_enabled = input;
        self
    }
    /// <p>Indicates whether to enable Amazon EBS Multi-Attach for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. 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>.</p>
    pub fn get_multi_attach_enabled(&self) -> &::std::option::Option<bool> {
        &self.multi_attach_enabled
    }
    /// <p>The throughput to provision for the volume copy, in MiB/s. Supported for <code>gp3</code> volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid Range: <code>125 - 2000</code> MiB/s</p>
    /// <p></p>
    pub fn throughput(mut self, input: i32) -> Self {
        self.throughput = ::std::option::Option::Some(input);
        self
    }
    /// <p>The throughput to provision for the volume copy, in MiB/s. Supported for <code>gp3</code> volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid Range: <code>125 - 2000</code> MiB/s</p>
    /// <p></p>
    pub fn set_throughput(mut self, input: ::std::option::Option<i32>) -> Self {
        self.throughput = input;
        self
    }
    /// <p>The throughput to provision for the volume copy, in MiB/s. Supported for <code>gp3</code> volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.</p>
    /// <p>Valid Range: <code>125 - 2000</code> MiB/s</p>
    /// <p></p>
    pub fn get_throughput(&self) -> &::std::option::Option<i32> {
        &self.throughput
    }
    /// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html"> Ensure Idempotency</a>.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html"> Ensure Idempotency</a>.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html"> Ensure Idempotency</a>.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// Consumes the builder and constructs a [`CopyVolumesInput`](crate::operation::copy_volumes::CopyVolumesInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::copy_volumes::CopyVolumesInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::copy_volumes::CopyVolumesInput {
            source_volume_id: self.source_volume_id,
            iops: self.iops,
            size: self.size,
            volume_type: self.volume_type,
            dry_run: self.dry_run,
            tag_specifications: self.tag_specifications,
            multi_attach_enabled: self.multi_attach_enabled,
            throughput: self.throughput,
            client_token: self.client_token,
        })
    }
}