You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::Volume

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a volume.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attachments ⇒ Array<Types::VolumeAttachment>

Information about the volume attachments.

Returns:

#availability_zone ⇒ String

The Availability Zone for the volume.

Returns:

  • (String) —

    The Availability Zone for the volume.

#create_time ⇒ Time

The time stamp when volume creation was initiated.

Returns:

  • (Time) —

    The time stamp when volume creation was initiated.

#encrypted ⇒ Boolean

Indicates whether the volume is encrypted.

Returns:

  • (Boolean) —

    Indicates whether the volume is encrypted.

#fast_restored ⇒ Boolean

Indicates whether the volume was created using fast snapshot restore.

Returns:

  • (Boolean) —

    Indicates whether the volume was created using fast snapshot restore.

#iops ⇒ Integer

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000 IOPS for io1 and io2 volumes, in most Regions. The maximum IOPS for io1 and io2 of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS.

Condition: This parameter is required for requests to create io1 and io2 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

Returns:

  • (Integer) —

    The number of I/O operations per second (IOPS) that the volume supports.

#kms_key_id ⇒ String

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

#multi_attach_enabled ⇒ Boolean

Indicates whether Amazon EBS Multi-Attach is enabled.

Returns:

  • (Boolean) —

    Indicates whether Amazon EBS Multi-Attach is enabled.

#outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the Outpost.

#size ⇒ Integer

The size of the volume, in GiBs.

Returns:

  • (Integer) —

    The size of the volume, in GiBs.

#snapshot_id ⇒ String

The snapshot from which the volume was created, if applicable.

Returns:

  • (String) —

    The snapshot from which the volume was created, if applicable.

#state ⇒ String

The volume state.

Possible values:

  • creating
  • available
  • in-use
  • deleting
  • deleted
  • error

Returns:

  • (String) —

    The volume state.

#tags ⇒ Array<Types::Tag>

Any tags assigned to the volume.

Returns:

  • (Array<Types::Tag>) —

    Any tags assigned to the volume.

#volume_id ⇒ String

The ID of the volume.

Returns:

  • (String) —

    The ID of the volume.

#volume_type ⇒ String

The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Possible values:

  • standard
  • io1
  • io2
  • gp2
  • sc1
  • st1

Returns:

  • (String) —

    The volume type.