software.amazon.awssdk.services.opsworks.model

Class EbsBlockDevice

java.lang.Object

software.amazon.awssdk.services.opsworks.model.EbsBlockDevice

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class EbsBlockDevice
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EbsBlockDevice.Builder,EbsBlockDevice>

Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EbsBlockDevice.Builder

Method Summary

Modifier and Type	Method and Description
static EbsBlockDevice.Builder	builder()
Boolean	deleteOnTermination() Whether the volume is deleted on instance termination.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends EbsBlockDevice.Builder>	serializableBuilderClass()
String	snapshotId() The snapshot ID.
EbsBlockDevice.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	volumeSize() The volume size, in GiB.
VolumeType	volumeType() The volume type.
String	volumeTypeAsString() 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

snapshotId

public String snapshotId()

The snapshot ID.

Returns:

The snapshot ID.

iops

public Integer iops()

The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

Returns:

The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

volumeSize

public Integer volumeSize()

The volume size, in GiB. For more information, see EbsBlockDevice.

Returns:

The volume size, in GiB. For more information, see EbsBlockDevice.

volumeType

public VolumeType volumeType()

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

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 volumeTypeAsString().

Returns:

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

See Also:

VolumeType

volumeTypeAsString

public String volumeTypeAsString()

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

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 volumeTypeAsString().

Returns:

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

See Also:

VolumeType

deleteOnTermination

public Boolean deleteOnTermination()

Whether the volume is deleted on instance termination.

Returns:

Whether the volume is deleted on instance termination.

toBuilder

public EbsBlockDevice.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<EbsBlockDevice.Builder,EbsBlockDevice>

Returns:

a builder for type T

builder

public static EbsBlockDevice.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

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