Volume (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Volume
extends Object
implements Serializable, Cloneable

Describes a 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)`
`List<VolumeAttachment>`	`getAttachments()` Information about the volume attachments.
`String`	`getAvailabilityZone()` The Availability Zone for the volume.
`Date`	`getCreateTime()` The time stamp when volume creation was initiated.
`Boolean`	`getEncrypted()` Indicates whether the volume is encrypted.
`Boolean`	`getFastRestored()` Indicates whether the volume was created using fast snapshot restore.
`Integer`	`getIops()` The number of I/O operations per second (IOPS).
`String`	`getKmsKeyId()` The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
`Boolean`	`getMultiAttachEnabled()` Indicates whether Amazon EBS Multi-Attach is enabled.
`String`	`getOutpostArn()` The Amazon Resource Name (ARN) of the Outpost.
`Integer`	`getSize()` The size of the volume, in GiBs.
`String`	`getSnapshotId()` The snapshot from which the volume was created, if applicable.
`String`	`getState()` The volume state.
`List<Tag>`	`getTags()` Any tags assigned to the volume.
`Integer`	`getThroughput()` The throughput that the volume supports, in MiB/s.
`String`	`getVolumeId()` The ID of the volume.
`String`	`getVolumeType()` The volume type.
`int`	`hashCode()`
`Boolean`	`isEncrypted()` Indicates whether the volume is encrypted.
`Boolean`	`isFastRestored()` Indicates whether the volume was created using fast snapshot restore.
`Boolean`	`isMultiAttachEnabled()` Indicates whether Amazon EBS Multi-Attach is enabled.
`void`	`setAttachments(Collection<VolumeAttachment> attachments)` Information about the volume attachments.
`void`	`setAvailabilityZone(String availabilityZone)` The Availability Zone for the volume.
`void`	`setCreateTime(Date createTime)` The time stamp when volume creation was initiated.
`void`	`setEncrypted(Boolean encrypted)` Indicates whether the volume is encrypted.
`void`	`setFastRestored(Boolean fastRestored)` Indicates whether the volume was created using fast snapshot restore.
`void`	`setIops(Integer iops)` The number of I/O operations per second (IOPS).
`void`	`setKmsKeyId(String kmsKeyId)` The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
`void`	`setMultiAttachEnabled(Boolean multiAttachEnabled)` Indicates whether Amazon EBS Multi-Attach is enabled.
`void`	`setOutpostArn(String outpostArn)` The Amazon Resource Name (ARN) of the Outpost.
`void`	`setSize(Integer size)` The size of the volume, in GiBs.
`void`	`setSnapshotId(String snapshotId)` The snapshot from which the volume was created, if applicable.
`void`	`setState(String state)` The volume state.
`void`	`setState(VolumeState state)` The volume state.
`void`	`setTags(Collection<Tag> tags)` Any tags assigned to the volume.
`void`	`setThroughput(Integer throughput)` The throughput that the volume supports, in MiB/s.
`void`	`setVolumeId(String volumeId)` The ID of the volume.
`void`	`setVolumeType(String volumeType)` The volume type.
`void`	`setVolumeType(VolumeType volumeType)` The volume type.
`String`	`toString()` Returns a string representation of this object.
`Volume`	`withAttachments(Collection<VolumeAttachment> attachments)` Information about the volume attachments.
`Volume`	`withAttachments(VolumeAttachment... attachments)` Information about the volume attachments.
`Volume`	`withAvailabilityZone(String availabilityZone)` The Availability Zone for the volume.
`Volume`	`withCreateTime(Date createTime)` The time stamp when volume creation was initiated.
`Volume`	`withEncrypted(Boolean encrypted)` Indicates whether the volume is encrypted.
`Volume`	`withFastRestored(Boolean fastRestored)` Indicates whether the volume was created using fast snapshot restore.
`Volume`	`withIops(Integer iops)` The number of I/O operations per second (IOPS).
`Volume`	`withKmsKeyId(String kmsKeyId)` The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
`Volume`	`withMultiAttachEnabled(Boolean multiAttachEnabled)` Indicates whether Amazon EBS Multi-Attach is enabled.
`Volume`	`withOutpostArn(String outpostArn)` The Amazon Resource Name (ARN) of the Outpost.
`Volume`	`withSize(Integer size)` The size of the volume, in GiBs.
`Volume`	`withSnapshotId(String snapshotId)` The snapshot from which the volume was created, if applicable.
`Volume`	`withState(String state)` The volume state.
`Volume`	`withState(VolumeState state)` The volume state.
`Volume`	`withTags(Collection<Tag> tags)` Any tags assigned to the volume.
`Volume`	`withTags(Tag... tags)` Any tags assigned to the volume.
`Volume`	`withThroughput(Integer throughput)` The throughput that the volume supports, in MiB/s.
`Volume`	`withVolumeId(String volumeId)` The ID of the volume.
`Volume`	`withVolumeType(String volumeType)` The volume type.
`Volume`	`withVolumeType(VolumeType volumeType)` The volume type.

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

- Constructor Detail
  - Volume
```
public Volume()
```
- Method Detail
  - getAttachments
```
public List<VolumeAttachment> getAttachments()
```
    Information about the volume attachments.
    
    Returns:
    
    Information about the volume attachments.
  - setAttachments
```
public void setAttachments(Collection<VolumeAttachment> attachments)
```
    Information about the volume attachments.
    
    Parameters:
    
    attachments - Information about the volume attachments.
  - withAttachments
```
public Volume withAttachments(VolumeAttachment... attachments)
```
    Information about the volume attachments.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttachments(java.util.Collection) or withAttachments(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attachments - Information about the volume attachments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttachments
```
public Volume withAttachments(Collection<VolumeAttachment> attachments)
```
    Information about the volume attachments.
    
    Parameters:
    
    attachments - Information about the volume attachments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    The Availability Zone for the volume.
    
    Parameters:
    
    availabilityZone - The Availability Zone for the volume.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    The Availability Zone for the volume.
    
    Returns:
    
    The Availability Zone for the volume.
  - withAvailabilityZone
```
public Volume withAvailabilityZone(String availabilityZone)
```
    The Availability Zone for the volume.
    
    Parameters:
    
    availabilityZone - The Availability Zone for the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    The time stamp when volume creation was initiated.
    
    Parameters:
    
    createTime - The time stamp when volume creation was initiated.
  - getCreateTime
```
public Date getCreateTime()
```
    The time stamp when volume creation was initiated.
    
    Returns:
    
    The time stamp when volume creation was initiated.
  - withCreateTime
```
public Volume withCreateTime(Date createTime)
```
    The time stamp when volume creation was initiated.
    
    Parameters:
    
    createTime - The time stamp when volume creation was initiated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncrypted
```
public void setEncrypted(Boolean encrypted)
```
    Indicates whether the volume is encrypted.
    
    Parameters:
    
    encrypted - Indicates whether the volume is encrypted.
  - getEncrypted
```
public Boolean getEncrypted()
```
    Indicates whether the volume is encrypted.
    
    Returns:
    
    Indicates whether the volume is encrypted.
  - withEncrypted
```
public Volume withEncrypted(Boolean encrypted)
```
    Indicates whether the volume is encrypted.
    
    Parameters:
    
    encrypted - Indicates whether the volume is encrypted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEncrypted
```
public Boolean isEncrypted()
```
    Indicates whether the volume is encrypted.
    
    Returns:
    
    Indicates whether the volume is encrypted.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
    
    Parameters:
    
    kmsKeyId - The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
  - withKmsKeyId
```
public Volume withKmsKeyId(String kmsKeyId)
```
    The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
    
    Parameters:
    
    kmsKeyId - The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutpostArn
```
public void setOutpostArn(String outpostArn)
```
    The Amazon Resource Name (ARN) of the Outpost.
    
    Parameters:
    
    outpostArn - The Amazon Resource Name (ARN) of the Outpost.
  - getOutpostArn
```
public String getOutpostArn()
```
    The Amazon Resource Name (ARN) of the Outpost.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Outpost.
  - withOutpostArn
```
public Volume withOutpostArn(String outpostArn)
```
    The Amazon Resource Name (ARN) of the Outpost.
    
    Parameters:
    
    outpostArn - The Amazon Resource Name (ARN) of the Outpost.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSize
```
public void setSize(Integer size)
```
    The size of the volume, in GiBs.
    
    Parameters:
    
    size - The size of the volume, in GiBs.
  - getSize
```
public Integer getSize()
```
    The size of the volume, in GiBs.
    
    Returns:
    
    The size of the volume, in GiBs.
  - withSize
```
public Volume withSize(Integer size)
```
    The size of the volume, in GiBs.
    
    Parameters:
    
    size - The size of the volume, in GiBs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnapshotId
```
public void setSnapshotId(String snapshotId)
```
    The snapshot from which the volume was created, if applicable.
    
    Parameters:
    
    snapshotId - The snapshot from which the volume was created, if applicable.
  - getSnapshotId
```
public String getSnapshotId()
```
    The snapshot from which the volume was created, if applicable.
    
    Returns:
    
    The snapshot from which the volume was created, if applicable.
  - withSnapshotId
```
public Volume withSnapshotId(String snapshotId)
```
    The snapshot from which the volume was created, if applicable.
    
    Parameters:
    
    snapshotId - The snapshot from which the volume was created, if applicable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The volume state.
    
    Parameters:
    
    state - The volume state.
    
    See Also:
    
    VolumeState
  - getState
```
public String getState()
```
    The volume state.
    
    Returns:
    
    The volume state.
    
    See Also:
    
    VolumeState
  - withState
```
public Volume withState(String state)
```
    The volume state.
    
    Parameters:
    
    state - The volume state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeState
  - setState
```
public void setState(VolumeState state)
```
    The volume state.
    
    Parameters:
    
    state - The volume state.
    
    See Also:
    
    VolumeState
  - withState
```
public Volume withState(VolumeState state)
```
    The volume state.
    
    Parameters:
    
    state - The volume state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeState
  - setVolumeId
```
public void setVolumeId(String volumeId)
```
    The ID of the volume.
    
    Parameters:
    
    volumeId - The ID of the volume.
  - getVolumeId
```
public String getVolumeId()
```
    The ID of the volume.
    
    Returns:
    
    The ID of the volume.
  - withVolumeId
```
public Volume withVolumeId(String volumeId)
```
    The ID of the volume.
    
    Parameters:
    
    volumeId - The ID of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIops
```
public void setIops(Integer iops)
```
    The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
    
    Parameters:
    
    iops - The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
  - getIops
```
public Integer getIops()
```
    The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
    
    Returns:
    
    The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
  - withIops
```
public Volume withIops(Integer iops)
```
    The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
    
    Parameters:
    
    iops - The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Any tags assigned to the volume.
    
    Returns:
    
    Any tags assigned to the volume.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Any tags assigned to the volume.
    
    Parameters:
    
    tags - Any tags assigned to the volume.
  - withTags
```
public Volume withTags(Tag... tags)
```
    Any tags assigned to the volume.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Any tags assigned to the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public Volume withTags(Collection<Tag> tags)
```
    Any tags assigned to the volume.
    
    Parameters:
    
    tags - Any tags assigned to the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeType
```
public void setVolumeType(String volumeType)
```
    The volume type.
    
    Parameters:
    
    volumeType - The volume type.
    
    See Also:
    
    VolumeType
  - getVolumeType
```
public String getVolumeType()
```
    The volume type.
    
    Returns:
    
    The volume type.
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public Volume withVolumeType(String volumeType)
```
    The volume type.
    
    Parameters:
    
    volumeType - The volume type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - setVolumeType
```
public void setVolumeType(VolumeType volumeType)
```
    The volume type.
    
    Parameters:
    
    volumeType - The volume type.
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public Volume withVolumeType(VolumeType volumeType)
```
    The volume type.
    
    Parameters:
    
    volumeType - The volume type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - setFastRestored
```
public void setFastRestored(Boolean fastRestored)
```
    Indicates whether the volume was created using fast snapshot restore.
    
    Parameters:
    
    fastRestored - Indicates whether the volume was created using fast snapshot restore.
  - getFastRestored
```
public Boolean getFastRestored()
```
    Indicates whether the volume was created using fast snapshot restore.
    
    Returns:
    
    Indicates whether the volume was created using fast snapshot restore.
  - withFastRestored
```
public Volume withFastRestored(Boolean fastRestored)
```
    Indicates whether the volume was created using fast snapshot restore.
    
    Parameters:
    
    fastRestored - Indicates whether the volume was created using fast snapshot restore.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isFastRestored
```
public Boolean isFastRestored()
```
    Indicates whether the volume was created using fast snapshot restore.
    
    Returns:
    
    Indicates whether the volume was created using fast snapshot restore.
  - setMultiAttachEnabled
```
public void setMultiAttachEnabled(Boolean multiAttachEnabled)
```
    Indicates whether Amazon EBS Multi-Attach is enabled.
    
    Parameters:
    
    multiAttachEnabled - Indicates whether Amazon EBS Multi-Attach is enabled.
  - getMultiAttachEnabled
```
public Boolean getMultiAttachEnabled()
```
    Indicates whether Amazon EBS Multi-Attach is enabled.
    
    Returns:
    
    Indicates whether Amazon EBS Multi-Attach is enabled.
  - withMultiAttachEnabled
```
public Volume withMultiAttachEnabled(Boolean multiAttachEnabled)
```
    Indicates whether Amazon EBS Multi-Attach is enabled.
    
    Parameters:
    
    multiAttachEnabled - Indicates whether Amazon EBS Multi-Attach is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isMultiAttachEnabled
```
public Boolean isMultiAttachEnabled()
```
    Indicates whether Amazon EBS Multi-Attach is enabled.
    
    Returns:
    
    Indicates whether Amazon EBS Multi-Attach is enabled.
  - setThroughput
```
public void setThroughput(Integer throughput)
```
    The throughput that the volume supports, in MiB/s.
    
    Parameters:
    
    throughput - The throughput that the volume supports, in MiB/s.
  - getThroughput
```
public Integer getThroughput()
```
    The throughput that the volume supports, in MiB/s.
    
    Returns:
    
    The throughput that the volume supports, in MiB/s.
  - withThroughput
```
public Volume withThroughput(Integer throughput)
```
    The throughput that the volume supports, in MiB/s.
    
    Parameters:
    
    throughput - The throughput that the volume supports, in MiB/s.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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

Did this page help you?

Class Volume

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Volume

Method Detail

getAttachments

setAttachments

withAttachments

withAttachments

setAvailabilityZone

getAvailabilityZone

withAvailabilityZone

setCreateTime

getCreateTime

withCreateTime

setEncrypted

getEncrypted

withEncrypted

isEncrypted

setKmsKeyId

getKmsKeyId

withKmsKeyId

setOutpostArn

getOutpostArn

withOutpostArn

setSize

getSize

withSize

setSnapshotId

getSnapshotId

withSnapshotId

setState

getState

withState

setState

withState

setVolumeId

getVolumeId

withVolumeId

setIops

getIops

withIops

getTags

setTags

withTags

withTags

setVolumeType

getVolumeType

withVolumeType

setVolumeType

withVolumeType

setFastRestored

getFastRestored

withFastRestored

isFastRestored

setMultiAttachEnabled

getMultiAttachEnabled

withMultiAttachEnabled

isMultiAttachEnabled

setThroughput

getThroughput

withThroughput

toString

equals

hashCode

clone