Volume (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opsworks.model.Volume

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Volume
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes an instance's Amazon EBS volume.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Volume()

Constructors
Constructor and Description
`Volume()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Volume`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAvailabilityZone()` The volume Availability Zone.
`String`	`getDevice()` The device name.
`String`	`getEc2VolumeId()` The Amazon EC2 volume ID.
`Boolean`	`getEncrypted()` Specifies whether an Amazon EBS volume is encrypted.
`String`	`getInstanceId()` The instance ID.
`Integer`	`getIops()` For PIOPS volumes, the IOPS per disk.
`String`	`getMountPoint()` The volume mount point.
`String`	`getName()` The volume name.
`String`	`getRaidArrayId()` The RAID array ID.
`String`	`getRegion()` The AWS region.
`Integer`	`getSize()` The volume size.
`String`	`getStatus()` The value returned by DescribeVolumes.
`String`	`getVolumeId()` The volume ID.
`String`	`getVolumeType()` The volume type.
`int`	`hashCode()`
`Boolean`	`isEncrypted()` Specifies whether an Amazon EBS volume is encrypted.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAvailabilityZone(String availabilityZone)` The volume Availability Zone.
`void`	`setDevice(String device)` The device name.
`void`	`setEc2VolumeId(String ec2VolumeId)` The Amazon EC2 volume ID.
`void`	`setEncrypted(Boolean encrypted)` Specifies whether an Amazon EBS volume is encrypted.
`void`	`setInstanceId(String instanceId)` The instance ID.
`void`	`setIops(Integer iops)` For PIOPS volumes, the IOPS per disk.
`void`	`setMountPoint(String mountPoint)` The volume mount point.
`void`	`setName(String name)` The volume name.
`void`	`setRaidArrayId(String raidArrayId)` The RAID array ID.
`void`	`setRegion(String region)` The AWS region.
`void`	`setSize(Integer size)` The volume size.
`void`	`setStatus(String status)` The value returned by DescribeVolumes.
`void`	`setVolumeId(String volumeId)` The volume ID.
`void`	`setVolumeType(String volumeType)` The volume type.
`String`	`toString()` Returns a string representation of this object.
`Volume`	`withAvailabilityZone(String availabilityZone)` The volume Availability Zone.
`Volume`	`withDevice(String device)` The device name.
`Volume`	`withEc2VolumeId(String ec2VolumeId)` The Amazon EC2 volume ID.
`Volume`	`withEncrypted(Boolean encrypted)` Specifies whether an Amazon EBS volume is encrypted.
`Volume`	`withInstanceId(String instanceId)` The instance ID.
`Volume`	`withIops(Integer iops)` For PIOPS volumes, the IOPS per disk.
`Volume`	`withMountPoint(String mountPoint)` The volume mount point.
`Volume`	`withName(String name)` The volume name.
`Volume`	`withRaidArrayId(String raidArrayId)` The RAID array ID.
`Volume`	`withRegion(String region)` The AWS region.
`Volume`	`withSize(Integer size)` The volume size.
`Volume`	`withStatus(String status)` The value returned by DescribeVolumes.
`Volume`	`withVolumeId(String volumeId)` The volume ID.
`Volume`	`withVolumeType(String volumeType)` The volume type.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Volume
```
public Volume()
```
- Method Detail
  - setVolumeId
```
public void setVolumeId(String volumeId)
```
    The volume ID.
    
    Parameters:
    
    volumeId - The volume ID.
  - getVolumeId
```
public String getVolumeId()
```
    The volume ID.
    
    Returns:
    
    The volume ID.
  - withVolumeId
```
public Volume withVolumeId(String volumeId)
```
    The volume ID.
    
    Parameters:
    
    volumeId - The volume ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEc2VolumeId
```
public void setEc2VolumeId(String ec2VolumeId)
```
    The Amazon EC2 volume ID.
    
    Parameters:
    
    ec2VolumeId - The Amazon EC2 volume ID.
  - getEc2VolumeId
```
public String getEc2VolumeId()
```
    The Amazon EC2 volume ID.
    
    Returns:
    
    The Amazon EC2 volume ID.
  - withEc2VolumeId
```
public Volume withEc2VolumeId(String ec2VolumeId)
```
    The Amazon EC2 volume ID.
    
    Parameters:
    
    ec2VolumeId - The Amazon EC2 volume ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The volume name.
    
    Parameters:
    
    name - The volume name.
  - getName
```
public String getName()
```
    The volume name.
    
    Returns:
    
    The volume name.
  - withName
```
public Volume withName(String name)
```
    The volume name.
    
    Parameters:
    
    name - The volume name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRaidArrayId
```
public void setRaidArrayId(String raidArrayId)
```
    The RAID array ID.
    
    Parameters:
    
    raidArrayId - The RAID array ID.
  - getRaidArrayId
```
public String getRaidArrayId()
```
    The RAID array ID.
    
    Returns:
    
    The RAID array ID.
  - withRaidArrayId
```
public Volume withRaidArrayId(String raidArrayId)
```
    The RAID array ID.
    
    Parameters:
    
    raidArrayId - The RAID array ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    The instance ID.
    
    Parameters:
    
    instanceId - The instance ID.
  - getInstanceId
```
public String getInstanceId()
```
    The instance ID.
    
    Returns:
    
    The instance ID.
  - withInstanceId
```
public Volume withInstanceId(String instanceId)
```
    The instance ID.
    
    Parameters:
    
    instanceId - The instance ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The value returned by DescribeVolumes.
    
    Parameters:
    
    status - The value returned by DescribeVolumes.
  - getStatus
```
public String getStatus()
```
    The value returned by DescribeVolumes.
    
    Returns:
    
    The value returned by DescribeVolumes.
  - withStatus
```
public Volume withStatus(String status)
```
    The value returned by DescribeVolumes.
    
    Parameters:
    
    status - The value returned by DescribeVolumes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSize
```
public void setSize(Integer size)
```
    The volume size.
    
    Parameters:
    
    size - The volume size.
  - getSize
```
public Integer getSize()
```
    The volume size.
    
    Returns:
    
    The volume size.
  - withSize
```
public Volume withSize(Integer size)
```
    The volume size.
    
    Parameters:
    
    size - The volume size.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDevice
```
public void setDevice(String device)
```
    The device name.
    
    Parameters:
    
    device - The device name.
  - getDevice
```
public String getDevice()
```
    The device name.
    
    Returns:
    
    The device name.
  - withDevice
```
public Volume withDevice(String device)
```
    The device name.
    
    Parameters:
    
    device - The device name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMountPoint
```
public void setMountPoint(String mountPoint)
```
    The volume mount point. For example, "/mnt/disk1".
    
    Parameters:
    
    mountPoint - The volume mount point. For example, "/mnt/disk1".
  - getMountPoint
```
public String getMountPoint()
```
    The volume mount point. For example, "/mnt/disk1".
    
    Returns:
    
    The volume mount point. For example, "/mnt/disk1".
  - withMountPoint
```
public Volume withMountPoint(String mountPoint)
```
    The volume mount point. For example, "/mnt/disk1".
    
    Parameters:
    
    mountPoint - The volume mount point. For example, "/mnt/disk1".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegion
```
public void setRegion(String region)
```
    The AWS region. For more information about AWS regions, see Regions and Endpoints.
    
    Parameters:
    
    region - The AWS region. For more information about AWS regions, see Regions and Endpoints.
  - getRegion
```
public String getRegion()
```
    The AWS region. For more information about AWS regions, see Regions and Endpoints.
    
    Returns:
    
    The AWS region. For more information about AWS regions, see Regions and Endpoints.
  - withRegion
```
public Volume withRegion(String region)
```
    The AWS region. For more information about AWS regions, see Regions and Endpoints.
    
    Parameters:
    
    region - The AWS region. For more information about AWS regions, see Regions and Endpoints.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    The volume Availability Zone. For more information, see Regions and Endpoints.
    
    Parameters:
    
    availabilityZone - The volume Availability Zone. For more information, see Regions and Endpoints.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    The volume Availability Zone. For more information, see Regions and Endpoints.
    
    Returns:
    
    The volume Availability Zone. For more information, see Regions and Endpoints.
  - withAvailabilityZone
```
public Volume withAvailabilityZone(String availabilityZone)
```
    The volume Availability Zone. For more information, see Regions and Endpoints.
    
    Parameters:
    
    availabilityZone - The volume Availability Zone. For more information, see Regions and Endpoints.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeType
```
public void setVolumeType(String 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.
    Parameters:
    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.
  - getVolumeType
```
public String getVolumeType()
```
    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:
    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.
  - withVolumeType
```
public Volume withVolumeType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIops
```
public void setIops(Integer iops)
```
    For PIOPS volumes, the IOPS per disk.
    
    Parameters:
    
    iops - For PIOPS volumes, the IOPS per disk.
  - getIops
```
public Integer getIops()
```
    For PIOPS volumes, the IOPS per disk.
    
    Returns:
    
    For PIOPS volumes, the IOPS per disk.
  - withIops
```
public Volume withIops(Integer iops)
```
    For PIOPS volumes, the IOPS per disk.
    
    Parameters:
    
    iops - For PIOPS volumes, the IOPS per disk.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncrypted
```
public void setEncrypted(Boolean encrypted)
```
    Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
    
    Parameters:
    
    encrypted - Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
  - getEncrypted
```
public Boolean getEncrypted()
```
    Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
    
    Returns:
    
    Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
  - withEncrypted
```
public Volume withEncrypted(Boolean encrypted)
```
    Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
    
    Parameters:
    
    encrypted - Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEncrypted
```
public Boolean isEncrypted()
```
    Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
    
    Returns:
    
    Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Volume clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Volume

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Volume

Method Detail

setVolumeId

getVolumeId

withVolumeId

setEc2VolumeId

getEc2VolumeId

withEc2VolumeId

setName

getName

withName

setRaidArrayId

getRaidArrayId

withRaidArrayId

setInstanceId

getInstanceId

withInstanceId

setStatus

getStatus

withStatus

setSize

getSize

withSize

setDevice

getDevice

withDevice

setMountPoint

getMountPoint

withMountPoint

setRegion

getRegion

withRegion

setAvailabilityZone

getAvailabilityZone

withAvailabilityZone

setVolumeType

getVolumeType

withVolumeType

setIops

getIops

withIops

setEncrypted

getEncrypted

withEncrypted

isEncrypted

toString

equals

hashCode

clone

marshall