@Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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 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) that the volume supports.
|
String |
getKmsKeyId()
The Amazon Resource Name (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.
|
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.
|
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) that the volume supports.
|
void |
setKmsKeyId(String kmsKeyId)
The Amazon Resource Name (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 |
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 |
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) that the volume supports.
|
Volume |
withKmsKeyId(String kmsKeyId)
The Amazon Resource Name (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 |
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 |
withVolumeId(String volumeId)
The ID of the volume.
|
Volume |
withVolumeType(String volumeType)
The volume type.
|
Volume |
withVolumeType(VolumeType volumeType)
The volume type.
|
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 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 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 void setEncrypted(Boolean encrypted)
Indicates whether the volume is encrypted.
encrypted
- Indicates whether the volume is encrypted.public Boolean getEncrypted()
Indicates whether the volume is encrypted.
public Volume withEncrypted(Boolean encrypted)
Indicates whether the volume is encrypted.
encrypted
- Indicates whether the volume is encrypted.public Boolean isEncrypted()
Indicates whether the volume is encrypted.
public void setKmsKeyId(String kmsKeyId)
The Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (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 setOutpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost.
outpostArn
- The Amazon Resource Name (ARN) of the Outpost.public String getOutpostArn()
The Amazon Resource Name (ARN) of the Outpost.
public Volume withOutpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost.
outpostArn
- The Amazon Resource Name (ARN) of the Outpost.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 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 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 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, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2
volumes and 100 to 64,000IOPS for io1
volumes, in most Regions. The maximum IOPS for io1
of 64,000 is guaranteed only on Nitro-based
instances. Other instance families guarantee performance up to 32,000 IOPS.
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, see Amazon EBS Volume Types
in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2
volumes and 100 to 64,000IOPS for
io1
volumes, in most Regions. The maximum IOPS for io1
of 64,000 is guaranteed
only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS.
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 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, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2
volumes and 100 to 64,000IOPS for io1
volumes, in most Regions. The maximum IOPS for io1
of 64,000 is guaranteed only on Nitro-based
instances. Other instance families guarantee performance up to 32,000 IOPS.
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.
Constraints: Range is 100-16,000 IOPS for gp2
volumes and 100 to 64,000IOPS for
io1
volumes, in most Regions. The maximum IOPS for io1
of 64,000 is guaranteed
only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS.
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(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, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2
volumes and 100 to 64,000IOPS for io1
volumes, in most Regions. The maximum IOPS for io1
of 64,000 is guaranteed only on Nitro-based
instances. Other instance families guarantee performance up to 32,000 IOPS.
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, see Amazon EBS Volume Types
in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2
volumes and 100 to 64,000IOPS for
io1
volumes, in most Regions. The maximum IOPS for io1
of 64,000 is guaranteed
only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS.
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 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, 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 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(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 setFastRestored(Boolean fastRestored)
Indicates whether the volume was created using fast snapshot restore.
fastRestored
- Indicates whether the volume was created using fast snapshot restore.public Boolean getFastRestored()
Indicates whether the volume was created using fast snapshot restore.
public Volume withFastRestored(Boolean fastRestored)
Indicates whether the volume was created using fast snapshot restore.
fastRestored
- Indicates whether the volume was created using fast snapshot restore.public Boolean isFastRestored()
Indicates whether the volume was created using fast snapshot restore.
public void setMultiAttachEnabled(Boolean multiAttachEnabled)
Indicates whether Amazon EBS Multi-Attach is enabled.
multiAttachEnabled
- Indicates whether Amazon EBS Multi-Attach is enabled.public Boolean getMultiAttachEnabled()
Indicates whether Amazon EBS Multi-Attach is enabled.
public Volume withMultiAttachEnabled(Boolean multiAttachEnabled)
Indicates whether Amazon EBS Multi-Attach is enabled.
multiAttachEnabled
- Indicates whether Amazon EBS Multi-Attach is enabled.public Boolean isMultiAttachEnabled()
Indicates whether Amazon EBS Multi-Attach is enabled.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.