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:

Instance Attribute Summary collapse

Instance Attribute Details

#attachmentsArray<Types::VolumeAttachment>

Information about the volume attachments.

Returns:

#availability_zoneString

The Availability Zone for the volume.

Returns:

  • (String)

    The Availability Zone for the volume.

#create_timeTime

The time stamp when volume creation was initiated.

Returns:

  • (Time)

    The time stamp when volume creation was initiated.

#encryptedBoolean

Indicates whether the volume will be encrypted.

Returns:

  • (Boolean)

    Indicates whether the volume will be encrypted.

#iopsInteger

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 on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 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_idString

The full 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 full 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.

#sizeInteger

The size of the volume, in GiBs.

Returns:

  • (Integer)

    The size of the volume, in GiBs.

#snapshot_idString

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

Returns:

  • (String)

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

#stateString

The volume state.

Possible values:

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

Returns:

  • (String)

    The volume state.

#tagsArray<Types::Tag>

Any tags assigned to the volume.

Returns:

  • (Array<Types::Tag>)

    Any tags assigned to the volume.

#volume_idString

The ID of the volume.

Returns:

  • (String)

    The ID of the volume.

#volume_typeString

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

Possible values:

  • standard
  • io1
  • gp2
  • sc1
  • st1

Returns:

  • (String)

    The volume type.