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

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

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

Overview

Describes a volume.

Instance Attribute Summary collapse

Instance Attribute Details

#attachmentsArray<Types::VolumeAttachment>

Information about the volume attachments.

Returns:



37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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_zoneString

The Availability Zone for the volume.

Returns:

  • (String)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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_timeTime

The time stamp when volume creation was initiated.

Returns:

  • (Time)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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

#encryptedBoolean

Indicates whether the volume will be encrypted.

Returns:

  • (Boolean)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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

#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, 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. The maximum IOPS for io1 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 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

Returns:

  • (Integer)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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_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)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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

#sizeInteger

The size of the volume, in GiBs.

Returns:

  • (Integer)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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_idString

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

Returns:

  • (String)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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

#stateString

The volume state.

Returns:

  • (String)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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

#tagsArray<Types::Tag>

Any tags assigned to the volume.

Returns:



37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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_idString

The ID of the volume.

Returns:

  • (String)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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_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.

Returns:

  • (String)


37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
37069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37055

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