AWS OpsWorks
API Reference (API Version 2013-02-18)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Volume

Describes an instance's Amazon EBS volume.

Contents

AvailabilityZone

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

Type: String

Required: No

Device

The device name.

Type: String

Required: No

Ec2VolumeId

The Amazon EC2 volume ID.

Type: String

Required: No

Encrypted

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

Type: Boolean

Required: No

InstanceId

The instance ID.

Type: String

Required: No

Iops

For PIOPS volumes, the IOPS per disk.

Type: Integer

Required: No

MountPoint

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

Type: String

Required: No

Name

The volume name.

Type: String

Required: No

RaidArrayId

The RAID array ID.

Type: String

Required: No

Region

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

Type: String

Required: No

Size

The volume size.

Type: Integer

Required: No

Status

The value returned by DescribeVolumes.

Type: String

Required: No

VolumeId

The volume ID.

Type: String

Required: No

VolumeType

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.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: