public class Volume
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Describes a volume.
Modifier and Type | Field and Description |
---|---|
private SdkInternalList<VolumeAttachment> |
attachments
Information about the volume attachments.
|
private java.lang.String |
availabilityZone
The Availability Zone for the volume.
|
private java.util.Date |
createTime
The time stamp when volume creation was initiated.
|
private java.lang.Boolean |
encrypted
Indicates whether the volume will be encrypted.
|
private java.lang.Integer |
iops
The number of I/O operations per second (IOPS) that the volume supports.
|
private java.lang.String |
kmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) customer master
key (CMK) that was used to protect the volume encryption key for the
volume.
|
private java.lang.Integer |
size
The size of the volume, in GiBs.
|
private java.lang.String |
snapshotId
The snapshot from which the volume was created, if applicable.
|
private java.lang.String |
state
The volume state.
|
private SdkInternalList<Tag> |
tags
Any tags assigned to the volume.
|
private java.lang.String |
volumeId
The ID of the volume.
|
private java.lang.String |
volumeType
The volume type.
|
Constructor and Description |
---|
Volume() |
Modifier and Type | Method and Description |
---|---|
Volume |
clone() |
boolean |
equals(java.lang.Object obj) |
java.util.List<VolumeAttachment> |
getAttachments()
Information about the volume attachments.
|
java.lang.String |
getAvailabilityZone()
The Availability Zone for the volume.
|
java.util.Date |
getCreateTime()
The time stamp when volume creation was initiated.
|
java.lang.Boolean |
getEncrypted()
Indicates whether the volume will be encrypted.
|
java.lang.Integer |
getIops()
The number of I/O operations per second (IOPS) that the volume supports.
|
java.lang.String |
getKmsKeyId()
The full ARN of the AWS Key Management Service (AWS KMS) customer master
key (CMK) that was used to protect the volume encryption key for the
volume.
|
java.lang.Integer |
getSize()
The size of the volume, in GiBs.
|
java.lang.String |
getSnapshotId()
The snapshot from which the volume was created, if applicable.
|
java.lang.String |
getState()
The volume state.
|
java.util.List<Tag> |
getTags()
Any tags assigned to the volume.
|
java.lang.String |
getVolumeId()
The ID of the volume.
|
java.lang.String |
getVolumeType()
The volume type.
|
int |
hashCode() |
java.lang.Boolean |
isEncrypted()
Indicates whether the volume will be encrypted.
|
void |
setAttachments(java.util.Collection<VolumeAttachment> attachments)
Information about the volume attachments.
|
void |
setAvailabilityZone(java.lang.String availabilityZone)
The Availability Zone for the volume.
|
void |
setCreateTime(java.util.Date createTime)
The time stamp when volume creation was initiated.
|
void |
setEncrypted(java.lang.Boolean encrypted)
Indicates whether the volume will be encrypted.
|
void |
setIops(java.lang.Integer iops)
The number of I/O operations per second (IOPS) that the volume supports.
|
void |
setKmsKeyId(java.lang.String kmsKeyId)
The full ARN of the AWS Key Management Service (AWS KMS) customer master
key (CMK) that was used to protect the volume encryption key for the
volume.
|
void |
setSize(java.lang.Integer size)
The size of the volume, in GiBs.
|
void |
setSnapshotId(java.lang.String snapshotId)
The snapshot from which the volume was created, if applicable.
|
void |
setState(java.lang.String state)
The volume state.
|
void |
setState(VolumeState state)
The volume state.
|
void |
setTags(java.util.Collection<Tag> tags)
Any tags assigned to the volume.
|
void |
setVolumeId(java.lang.String volumeId)
The ID of the volume.
|
void |
setVolumeType(java.lang.String volumeType)
The volume type.
|
void |
setVolumeType(VolumeType volumeType)
The volume type.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
Volume |
withAttachments(java.util.Collection<VolumeAttachment> attachments)
Information about the volume attachments.
|
Volume |
withAttachments(VolumeAttachment... attachments)
Information about the volume attachments.
|
Volume |
withAvailabilityZone(java.lang.String availabilityZone)
The Availability Zone for the volume.
|
Volume |
withCreateTime(java.util.Date createTime)
The time stamp when volume creation was initiated.
|
Volume |
withEncrypted(java.lang.Boolean encrypted)
Indicates whether the volume will be encrypted.
|
Volume |
withIops(java.lang.Integer iops)
The number of I/O operations per second (IOPS) that the volume supports.
|
Volume |
withKmsKeyId(java.lang.String kmsKeyId)
The full ARN of the AWS Key Management Service (AWS KMS) customer master
key (CMK) that was used to protect the volume encryption key for the
volume.
|
Volume |
withSize(java.lang.Integer size)
The size of the volume, in GiBs.
|
Volume |
withSnapshotId(java.lang.String snapshotId)
The snapshot from which the volume was created, if applicable.
|
Volume |
withState(java.lang.String state)
The volume state.
|
Volume |
withState(VolumeState state)
The volume state.
|
Volume |
withTags(java.util.Collection<Tag> tags)
Any tags assigned to the volume.
|
Volume |
withTags(Tag... tags)
Any tags assigned to the volume.
|
Volume |
withVolumeId(java.lang.String volumeId)
The ID of the volume.
|
Volume |
withVolumeType(java.lang.String volumeType)
The volume type.
|
Volume |
withVolumeType(VolumeType volumeType)
The volume type.
|
private java.lang.String volumeId
The ID of the volume.
private java.lang.Integer size
The size of the volume, in GiBs.
private java.lang.String snapshotId
The snapshot from which the volume was created, if applicable.
private java.lang.String availabilityZone
The Availability Zone for the volume.
private java.lang.String state
The volume state.
private java.util.Date createTime
The time stamp when volume creation was initiated.
private SdkInternalList<VolumeAttachment> attachments
Information about the volume attachments.
private SdkInternalList<Tag> tags
Any tags assigned to the volume.
private java.lang.String volumeType
The volume type. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for
Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.
private java.lang.Integer iops
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS
for gp2
volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
gp2
, st1
, sc1
, or
standard
volumes.
private java.lang.Boolean encrypted
Indicates whether the volume will be encrypted.
private java.lang.String kmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
public void setVolumeId(java.lang.String volumeId)
The ID of the volume.
volumeId
- The ID of the volume.public java.lang.String getVolumeId()
The ID of the volume.
public Volume withVolumeId(java.lang.String volumeId)
The ID of the volume.
volumeId
- The ID of the volume.public void setSize(java.lang.Integer size)
The size of the volume, in GiBs.
size
- The size of the volume, in GiBs.public java.lang.Integer getSize()
The size of the volume, in GiBs.
public Volume withSize(java.lang.Integer size)
The size of the volume, in GiBs.
size
- The size of the volume, in GiBs.public void setSnapshotId(java.lang.String snapshotId)
The snapshot from which the volume was created, if applicable.
snapshotId
- The snapshot from which the volume was created, if applicable.public java.lang.String getSnapshotId()
The snapshot from which the volume was created, if applicable.
public Volume withSnapshotId(java.lang.String snapshotId)
The snapshot from which the volume was created, if applicable.
snapshotId
- The snapshot from which the volume was created, if applicable.public void setAvailabilityZone(java.lang.String availabilityZone)
The Availability Zone for the volume.
availabilityZone
- The Availability Zone for the volume.public java.lang.String getAvailabilityZone()
The Availability Zone for the volume.
public Volume withAvailabilityZone(java.lang.String availabilityZone)
The Availability Zone for the volume.
availabilityZone
- The Availability Zone for the volume.public void setState(java.lang.String state)
The volume state.
state
- The volume state.VolumeState
public java.lang.String getState()
The volume state.
VolumeState
public Volume withState(java.lang.String state)
The volume state.
state
- The volume state.VolumeState
public void setState(VolumeState state)
The volume state.
state
- The volume state.VolumeState
public Volume withState(VolumeState state)
The volume state.
state
- The volume state.VolumeState
public void setCreateTime(java.util.Date createTime)
The time stamp when volume creation was initiated.
createTime
- The time stamp when volume creation was initiated.public java.util.Date getCreateTime()
The time stamp when volume creation was initiated.
public Volume withCreateTime(java.util.Date createTime)
The time stamp when volume creation was initiated.
createTime
- The time stamp when volume creation was initiated.public java.util.List<VolumeAttachment> getAttachments()
Information about the volume attachments.
public void setAttachments(java.util.Collection<VolumeAttachment> attachments)
Information about the volume attachments.
attachments
- Information about the volume attachments.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.
attachments
- Information about the volume attachments.public Volume withAttachments(java.util.Collection<VolumeAttachment> attachments)
Information about the volume attachments.
attachments
- Information about the volume attachments.public java.util.List<Tag> getTags()
Any tags assigned to the volume.
public void setTags(java.util.Collection<Tag> tags)
Any tags assigned to the volume.
tags
- Any tags assigned to the volume.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.
tags
- Any tags assigned to the volume.public Volume withTags(java.util.Collection<Tag> tags)
Any tags assigned to the volume.
tags
- Any tags assigned to the volume.public void setVolumeType(java.lang.String volumeType)
The volume type. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for
Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.
volumeType
- The volume type. This can be gp2
for General Purpose
SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.VolumeType
public java.lang.String getVolumeType()
The volume type. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for
Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.
gp2
for General Purpose
SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.VolumeType
public Volume withVolumeType(java.lang.String volumeType)
The volume type. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for
Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.
volumeType
- The volume type. This can be gp2
for General Purpose
SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.VolumeType
public void setVolumeType(VolumeType volumeType)
The volume type. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for
Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.
volumeType
- The volume type. This can be gp2
for General Purpose
SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.VolumeType
public Volume withVolumeType(VolumeType volumeType)
The volume type. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for
Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.
volumeType
- The volume type. This can be gp2
for General Purpose
SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.VolumeType
public void setIops(java.lang.Integer iops)
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS
for gp2
volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
gp2
, st1
, sc1
, or
standard
volumes.
iops
- The number of I/O operations per second (IOPS) that the volume
supports. For Provisioned IOPS SSD volumes, this represents the
number of IOPS that are provisioned for the volume. For General
Purpose SSD volumes, this represents the baseline performance of
the volume and the rate at which the volume accumulates I/O
credits for bursting. For more information on General Purpose SSD
baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute
Cloud User Guide.
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000
IOPS for gp2
volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
gp2
, st1
, sc1
, or
standard
volumes.
public java.lang.Integer getIops()
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS
for gp2
volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
gp2
, st1
, sc1
, or
standard
volumes.
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000
IOPS for gp2
volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
gp2
, st1
, sc1
, or
standard
volumes.
public Volume withIops(java.lang.Integer iops)
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS
for gp2
volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
gp2
, st1
, sc1
, or
standard
volumes.
iops
- The number of I/O operations per second (IOPS) that the volume
supports. For Provisioned IOPS SSD volumes, this represents the
number of IOPS that are provisioned for the volume. For General
Purpose SSD volumes, this represents the baseline performance of
the volume and the rate at which the volume accumulates I/O
credits for bursting. For more information on General Purpose SSD
baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute
Cloud User Guide.
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000
IOPS for gp2
volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
gp2
, st1
, sc1
, or
standard
volumes.
public void setEncrypted(java.lang.Boolean encrypted)
Indicates whether the volume will be encrypted.
encrypted
- Indicates whether the volume will be encrypted.public java.lang.Boolean getEncrypted()
Indicates whether the volume will be encrypted.
public Volume withEncrypted(java.lang.Boolean encrypted)
Indicates whether the volume will be encrypted.
encrypted
- Indicates whether the volume will be encrypted.public java.lang.Boolean isEncrypted()
Indicates whether the volume will be encrypted.
public void setKmsKeyId(java.lang.String kmsKeyId)
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
kmsKeyId
- The full ARN of the AWS Key Management Service (AWS KMS) customer
master key (CMK) that was used to protect the volume encryption
key for the volume.public java.lang.String getKmsKeyId()
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
public Volume withKmsKeyId(java.lang.String kmsKeyId)
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
kmsKeyId
- The full ARN of the AWS Key Management Service (AWS KMS) customer
master key (CMK) that was used to protect the volume encryption
key for the volume.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public Volume clone()
clone
in class java.lang.Object