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

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorks::Types::Volume

Includes:

Structure

Defined in:

lib/aws-sdk-opsworks/types.rb

Overview

Describes an instance’s Amazon EBS volume.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #availability_zone ⇒ String

  The volume Availability Zone.

• #device ⇒ String

  The device name.

• #ec2_volume_id ⇒ String

  The Amazon EC2 volume ID.

• #encrypted ⇒ Boolean

  Specifies whether an Amazon EBS volume is encrypted.

• #instance_id ⇒ String

  The instance ID.

• #iops ⇒ Integer

  For PIOPS volumes, the IOPS per disk.

• #mount_point ⇒ String

  The volume mount point.

• #name ⇒ String

  The volume name.

• #raid_array_id ⇒ String

  The RAID array ID.

• #region ⇒ String

  The Amazon Web Services Region.

• #size ⇒ Integer

  The volume size.

• #status ⇒ String

  The value returned by [DescribeVolumes].

• #volume_id ⇒ String

  The volume ID.

• #volume_type ⇒ String

  The volume type.

Instance Attribute Details

#availability_zone ⇒ String

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

[1]: docs.aws.amazon.com/general/latest/gr/rande.html

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#device ⇒ String

The device name.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_volume_id ⇒ String

The Amazon EC2 volume ID.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

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

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The instance ID.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ Integer

For PIOPS volumes, the IOPS per disk.

Returns:

• (Integer)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#mount_point ⇒ String

The volume mount point. For example, “/mnt/disk1”.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The volume name. Volume names are a maximum of 128 characters.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#raid_array_id ⇒ String

The RAID array ID.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

The Amazon Web Services Region. For more information about Amazon Web Services Regions, see [Regions and Endpoints].

[1]: docs.aws.amazon.com/general/latest/gr/rande.html

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#size ⇒ Integer

The volume size.

Returns:

• (Integer)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The value returned by [DescribeVolumes].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVolumes.html

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#volume_id ⇒ String

The volume ID.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end

#volume_type ⇒ String

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 125 GiB and a maximum size of 16384 GiB.

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

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

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 6218

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)
  SENSITIVE = []
  include Aws::Structure
end