@Generated(value="software.amazon.awssdk:codegen") public class Volume extends Object implements ToCopyableBuilder<Volume.Builder,Volume>
Describes a volume.
Modifier and Type | Class and Description |
---|---|
static interface |
Volume.Builder |
Modifier and Type | Method and Description |
---|---|
List<VolumeAttachment> |
attachments()
Information about the volume attachments.
|
String |
availabilityZone()
The Availability Zone for the volume.
|
static Volume.Builder |
builder() |
Instant |
createTime()
The time stamp when volume creation was initiated.
|
Boolean |
encrypted()
Indicates whether the volume will be encrypted.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
iops()
The number of I/O operations per second (IOPS) that the volume supports.
|
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.
|
static Class<? extends Volume.Builder> |
serializableBuilderClass() |
Integer |
size()
The size of the volume, in GiBs.
|
String |
snapshotId()
The snapshot from which the volume was created, if applicable.
|
VolumeState |
state()
The volume state.
|
String |
stateString()
The volume state.
|
List<Tag> |
tags()
Any tags assigned to the volume.
|
Volume.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
volumeId()
The ID of the volume.
|
VolumeType |
volumeType()
The volume type.
|
String |
volumeTypeString()
The volume type.
|
copy
public List<VolumeAttachment> attachments()
Information about the volume attachments.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String availabilityZone()
The Availability Zone for the volume.
public Instant createTime()
The time stamp when volume creation was initiated.
public Boolean encrypted()
Indicates whether the volume will be encrypted.
public 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 Integer size()
The size of the volume, in GiBs.
public String snapshotId()
The snapshot from which the volume was created, if applicable.
public VolumeState state()
The volume state.
If the service returns an enum value that is not available in the current SDK version, state
will return
VolumeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateString()
.
VolumeState
public String stateString()
The volume state.
If the service returns an enum value that is not available in the current SDK version, state
will return
VolumeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateString()
.
VolumeState
public String volumeId()
The ID of the volume.
public 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.
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 List<Tag> tags()
Any tags assigned to the volume.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
If the service returns an enum value that is not available in the current SDK version, volumeType
will
return VolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
volumeTypeString()
.
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 volumeTypeString()
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.
If the service returns an enum value that is not available in the current SDK version, volumeType
will
return VolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
volumeTypeString()
.
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.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Volume.Builder,Volume>
public static Volume.Builder builder()
public static Class<? extends Volume.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.