public class Volume extends Object implements Serializable, Cloneable
Describes a volume.
Constructor and Description |
---|
Volume() |
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 will be encrypted.
|
Integer |
getIops()
The number of I/O operations per second (IOPS) that the volume supports.
|
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.
|
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.
|
String |
getVolumeId()
The ID of the volume.
|
String |
getVolumeType()
The volume type.
|
int |
hashCode() |
Boolean |
isEncrypted()
Indicates whether the volume will be encrypted.
|
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 will be encrypted.
|
void |
setIops(Integer iops)
The number of I/O operations per second (IOPS) that the volume supports.
|
void |
setKmsKeyId(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(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 |
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; useful for testing and
debugging.
|
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 will be encrypted.
|
Volume |
withIops(Integer iops)
The number of I/O operations per second (IOPS) that the volume supports.
|
Volume |
withKmsKeyId(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(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 |
withVolumeId(String volumeId)
The ID of the volume.
|
Volume |
withVolumeType(String volumeType)
The volume type.
|
Volume |
withVolumeType(VolumeType volumeType)
The volume type.
|
public void setVolumeId(String volumeId)
The ID of the volume.
volumeId
- The ID of the volume.public String getVolumeId()
The ID of the volume.
public Volume withVolumeId(String volumeId)
The ID of the volume.
volumeId
- The ID of the volume.public void setSize(Integer size)
The size of the volume, in GiBs.
size
- The size of the volume, in GiBs.public Integer getSize()
The size of the volume, in GiBs.
public Volume withSize(Integer size)
The size of the volume, in GiBs.
size
- The size of the volume, in GiBs.public void setSnapshotId(String snapshotId)
The snapshot from which the volume was created, if applicable.
snapshotId
- The snapshot from which the volume was created, if applicable.public String getSnapshotId()
The snapshot from which the volume was created, if applicable.
public Volume withSnapshotId(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(String availabilityZone)
The Availability Zone for the volume.
availabilityZone
- The Availability Zone for the volume.public String getAvailabilityZone()
The Availability Zone for the volume.
public Volume withAvailabilityZone(String availabilityZone)
The Availability Zone for the volume.
availabilityZone
- The Availability Zone for the volume.public void setState(String state)
The volume state.
state
- The volume state.VolumeState
public String getState()
The volume state.
VolumeState
public Volume withState(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(Date createTime)
The time stamp when volume creation was initiated.
createTime
- The time stamp when volume creation was initiated.public Date getCreateTime()
The time stamp when volume creation was initiated.
public Volume withCreateTime(Date createTime)
The time stamp when volume creation was initiated.
createTime
- The time stamp when volume creation was initiated.public List<VolumeAttachment> getAttachments()
Information about the volume attachments.
public void setAttachments(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(Collection<VolumeAttachment> attachments)
Information about the volume attachments.
attachments
- Information about the volume attachments.public List<Tag> getTags()
Any tags assigned to the volume.
public void setTags(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(Collection<Tag> tags)
Any tags assigned to the volume.
tags
- Any tags assigned to the volume.public void setVolumeType(String volumeType)
The volume type. This can be gp2
for General Purpose (SSD)
volumes, io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes.
volumeType
- The volume type. This can be gp2
for General Purpose
(SSD) volumes, io1
for Provisioned IOPS (SSD)
volumes, or standard
for Magnetic volumes.VolumeType
public String getVolumeType()
The volume type. This can be gp2
for General Purpose (SSD)
volumes, io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes.
gp2
for General Purpose
(SSD) volumes, io1
for Provisioned IOPS (SSD)
volumes, or standard
for Magnetic volumes.VolumeType
public Volume withVolumeType(String volumeType)
The volume type. This can be gp2
for General Purpose (SSD)
volumes, io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes.
volumeType
- The volume type. This can be gp2
for General Purpose
(SSD) volumes, io1
for Provisioned IOPS (SSD)
volumes, or standard
for Magnetic volumes.VolumeType
public void setVolumeType(VolumeType volumeType)
The volume type. This can be gp2
for General Purpose (SSD)
volumes, io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes.
volumeType
- The volume type. This can be gp2
for General Purpose
(SSD) volumes, io1
for Provisioned IOPS (SSD)
volumes, or standard
for Magnetic volumes.VolumeType
public Volume withVolumeType(VolumeType volumeType)
The volume type. This can be gp2
for General Purpose (SSD)
volumes, io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes.
volumeType
- The volume type. This can be gp2
for General Purpose
(SSD) volumes, io1
for Provisioned IOPS (SSD)
volumes, or standard
for Magnetic volumes.VolumeType
public void setIops(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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
standard
or gp2
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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
standard
or gp2
volumes.
public 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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
standard
or gp2
volumes.
Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
standard
or gp2
volumes.
public Volume withIops(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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
standard
or gp2
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 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
standard
or gp2
volumes.
public void setEncrypted(Boolean encrypted)
Indicates whether the volume will be encrypted.
encrypted
- Indicates whether the volume will be encrypted.public Boolean getEncrypted()
Indicates whether the volume will be encrypted.
public Volume withEncrypted(Boolean encrypted)
Indicates whether the volume will be encrypted.
encrypted
- Indicates whether the volume will be encrypted.public Boolean isEncrypted()
Indicates whether the volume will be encrypted.
public void setKmsKeyId(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 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(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 String toString()
toString
in class Object
Object.toString()
Copyright © 2016. All rights reserved.