Class: Aws::EC2::Types::CopyVolumesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

Indicates whether to encrypt the volume copy. If the source volume is encrypted, the service always encrypts the copy regardless of this value. Set to true to encrypt a copy of an unencrypted source volume during the copy operation. If you set Encrypted to true but do not specify KmsKeyId, the service uses the default KMS key for EBS encryption in your account.

Returns:

  • (Boolean) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ Integer

The number of I/O operations per second (IOPS) to provision for the volume copy. Required for io1 and io2 volumes. Optional for gp3 volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.

Valid ranges:

  • gp3: 3,000(default)- 80,000 IOPS

  • io1: 100 - 64,000 IOPS

  • io2: 100 - 256,000 IOPS

Instances built on the Nitro System can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.

Returns:

  • (Integer) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The identifier of the KMS key to use for encryption of the volume copy. Specify a symmetric encryption KMS key. You can specify a KMS key using the key ID, key ARN, alias name, or alias ARN. If you set Encrypted to true but do not specify this parameter, the service uses the default KMS key for EBS encryption in your account. For cross-account volume copies, this must be a KMS key in the calling account.

Returns:

  • (String) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#multi_attach_enabled ⇒ Boolean

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 io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach.

Returns:

  • (Boolean) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#size ⇒ Integer

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.

Maximum supported sizes:

  • gp2: 16,384 GiB

  • gp3: 65,536 GiB

  • io1: 16,384 GiB

  • io2: 65,536 GiB

  • st1 and sc1: 16,384 GiB

  • standard: 1024 GiB

Returns:

  • (Integer) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#source_volume_id ⇒ String

The ID of the source EBS volume to copy.

Returns:

  • (String) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the volume copy during creation.

Returns:



9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#throughput ⇒ Integer

The throughput to provision for the volume copy, in MiB/s. Supported for gp3 volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.

Valid Range: 125 - 2000 MiB/s

Returns:

  • (Integer) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#volume_type ⇒ String

The volume type for the volume copy. If not specified, the volume type defaults to gp2.

Returns:

  • (String) 


9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9716

class CopyVolumesRequest < Struct.new(
  :source_volume_id,
  :iops,
  :size,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token,
  :encrypted,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end