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

Class: Aws::OpsWorks::Types::Volume

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

Overview

Describes an instance's Amazon EBS volume.

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

The volume Availability Zone. For more information, see Regions and Endpoints.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#deviceString

The device name.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#ec2_volume_idString

The Amazon EC2 volume ID.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#encryptedBoolean

Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.

Returns:

  • (Boolean)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#instance_idString

The instance ID.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#iopsInteger

For PIOPS volumes, the IOPS per disk.

Returns:

  • (Integer)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#mount_pointString

The volume mount point. For example, "/mnt/disk1".

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#nameString

The volume name.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#raid_array_idString

The RAID array ID.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#regionString

The AWS region. For more information about AWS regions, see Regions and Endpoints.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#sizeInteger

The volume size.

Returns:

  • (Integer)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#statusString

The value returned by DescribeVolumes.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#volume_idString

The volume ID.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end

#volume_typeString

The volume type. For more information, see Amazon EBS Volume Types.

  • standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

  • io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

  • gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

  • st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

  • sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

Returns:

  • (String)


7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 7144

class Volume < Struct.new(
  :volume_id,
  :ec2_volume_id,
  :name,
  :raid_array_id,
  :instance_id,
  :status,
  :size,
  :device,
  :mount_point,
  :region,
  :availability_zone,
  :volume_type,
  :iops,
  :encrypted)
  include Aws::Structure
end