@Generated(value="software.amazon.awssdk:codegen") public final class Volume extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Volume.Builder,Volume>
Describes an instance's Amazon EBS volume.
Modifier and Type | Class and Description |
---|---|
static interface |
Volume.Builder |
Modifier and Type | Method and Description |
---|---|
String |
availabilityZone()
The volume Availability Zone.
|
static Volume.Builder |
builder() |
String |
device()
The device name.
|
String |
ec2VolumeId()
The Amazon EC2 volume ID.
|
Boolean |
encrypted()
Specifies whether an Amazon EBS volume is encrypted.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
instanceId()
The instance ID.
|
Integer |
iops()
For PIOPS volumes, the IOPS per disk.
|
String |
mountPoint()
The volume mount point.
|
String |
name()
The volume name.
|
String |
raidArrayId()
The RAID array ID.
|
String |
region()
The AWS region.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Volume.Builder> |
serializableBuilderClass() |
Integer |
size()
The volume size.
|
String |
status()
The value returned by DescribeVolumes.
|
Volume.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
volumeId()
The volume ID.
|
String |
volumeType()
The volume type.
|
copy
public final String volumeId()
The volume ID.
public final String ec2VolumeId()
The Amazon EC2 volume ID.
public final String name()
The volume name.
public final String raidArrayId()
The RAID array ID.
public final String instanceId()
The instance ID.
public final String status()
The value returned by DescribeVolumes.
public final Integer size()
The volume size.
public final String device()
The device name.
public final String mountPoint()
The volume mount point. For example, "/mnt/disk1".
public final String region()
The AWS region. For more information about AWS regions, see Regions and Endpoints.
public final String availabilityZone()
The volume Availability Zone. For more information, see Regions and Endpoints.
public final String volumeType()
The volume type. For more information, see Amazon EBS Volume Types.
standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024
GiB.
io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of
16384 GiB.
gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum
size of 16384 GiB.
st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a
minimum size of 500 GiB and a maximum size of 16384 GiB.
sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384
GiB.
standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size
of 1024 GiB.
io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum
size of 16384 GiB.
gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a
maximum size of 16384 GiB.
st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have
a minimum size of 500 GiB and a maximum size of 16384 GiB.
sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of
16384 GiB.
public final Integer iops()
For PIOPS volumes, the IOPS per disk.
public final Boolean encrypted()
Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
public Volume.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Volume.Builder,Volume>
public static Volume.Builder builder()
public static Class<? extends Volume.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.