software.amazon.awssdk.services.opsworks.model

Class Volume

java.lang.Object

software.amazon.awssdk.services.opsworks.model.Volume

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Volume.Builder,Volume>

@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Volume.Builder

Method Summary

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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

volumeId

public final String volumeId()

The volume ID.

Returns:

The volume ID.

ec2VolumeId

public final String ec2VolumeId()

The Amazon EC2 volume ID.

Returns:

The Amazon EC2 volume ID.

name

public final String name()

The volume name.

Returns:

The volume name.

raidArrayId

public final String raidArrayId()

The RAID array ID.

Returns:

The RAID array ID.

instanceId

public final String instanceId()

The instance ID.

Returns:

The instance ID.

status

public final String status()

The value returned by DescribeVolumes.

Returns:

The value returned by DescribeVolumes.

size

public final Integer size()

The volume size.

Returns:

The volume size.

device

public final String device()

The device name.

Returns:

The device name.

mountPoint

public final String mountPoint()

The volume mount point. For example, "/mnt/disk1".

Returns:

The volume mount point. For example, "/mnt/disk1".

region

public final String region()

The AWS region. For more information about AWS regions, see Regions and Endpoints.

Returns:

The AWS region. For more information about AWS regions, see Regions and Endpoints.

availabilityZone

public final String availabilityZone()

The volume Availability Zone. For more information, see Regions and Endpoints.

Returns:

The volume Availability Zone. For more information, see Regions and Endpoints.

volumeType

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.

Returns:

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.

iops

public final Integer iops()

For PIOPS volumes, the IOPS per disk.

Returns:

For PIOPS volumes, the IOPS per disk.

encrypted

public final Boolean encrypted()

Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.

Returns:

Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.

toBuilder

public Volume.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Volume.Builder,Volume>

Returns:

a builder for type T

builder

public static Volume.Builder builder()

serializableBuilderClass

public static Class<? extends Volume.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.