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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::Volume

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Describes a volume.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #attachments ⇒ Array<Types::VolumeAttachment>

  Information about the volume attachments.

• #availability_zone ⇒ String

  The Availability Zone for the volume.

• #create_time ⇒ Time

  The time stamp when volume creation was initiated.

• #encrypted ⇒ Boolean

  Indicates whether the volume will be encrypted.

• #iops ⇒ Integer

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

• #kms_key_id ⇒ 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.

• #size ⇒ Integer

  The size of the volume, in GiBs.

• #snapshot_id ⇒ String

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

• #state ⇒ String

  The volume state.

• #tags ⇒ Array<Types::Tag>

  Any tags assigned to the volume.

• #volume_id ⇒ String

  The ID of the volume.

• #volume_type ⇒ String

  The volume type.

Instance Attribute Details

#attachments ⇒ Array<Types::VolumeAttachment>

Information about the volume attachments.

Returns:

• (Array<Types::VolumeAttachment>)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#availability_zone ⇒ String

The Availability Zone for the volume.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#create_time ⇒ Time

The time stamp when volume creation was initiated.

Returns:

• (Time)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#encrypted ⇒ Boolean

Indicates whether the volume will be encrypted.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#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 about General Purpose SSD baseline performance, I/O credits, and bursting, 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,000IOPS for `io1` volumes in most regions. Maximum `io1`IOPS of 64,000 is guaranteed only on [Nitro-based instances](AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). Other instance families guarantee performance up to 32,000 IOPS. For more information, see [Amazon EBS Volume Types] in the *Amazon Elastic Compute Cloud User Guide*.

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#kms_key_id ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#size ⇒ Integer

The size of the volume, in GiBs.

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#snapshot_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#state ⇒ String

The volume state.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the volume.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#volume_id ⇒ String

The ID of the volume.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end

#volume_type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 36761

class Volume < Struct.new(
  :attachments,
  :availability_zone,
  :create_time,
  :encrypted,
  :kms_key_id,
  :size,
  :snapshot_id,
  :state,
  :volume_id,
  :iops,
  :tags,
  :volume_type)
  include Aws::Structure
end