Package software.amazon.awssdk.services.ec2.model

Class Volume

java.lang.Object

software.amazon.awssdk.services.ec2.model.Volume

All Implemented Interfaces:

ToCopyableBuilder<Volume.Builder,Volume>

@Generated("software.amazon.awssdk:codegen")
public class Volume
extends Object
implements ToCopyableBuilder<Volume.Builder,Volume>

Describes a volume.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Volume.Builder

Method Summary

Modifier and Type	Method	Description
List<VolumeAttachment>	attachments()	Information about the volume attachments.
String	availabilityZone()	The Availability Zone for the volume.
static Volume.Builder	builder()
Date	createTime()	The time stamp when volume creation was initiated.
Boolean	encrypted()	Indicates whether the volume will be encrypted.
boolean	equals(Object obj)
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.
String	state()	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.
String	volumeType()	The volume type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

attachments

public List<VolumeAttachment> attachments()

Information about the volume attachments.

Returns:

Information about the volume attachments.

availabilityZone

public String availabilityZone()

The Availability Zone for the volume.

Returns:

The Availability Zone for the volume.

createTime

public Date createTime()

The time stamp when volume creation was initiated.

Returns:

The time stamp when volume creation was initiated.

encrypted

public Boolean encrypted()

Indicates whether the volume will be encrypted.

Returns:

Indicates whether the volume will be encrypted.

kmsKeyId

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.

Returns:

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.

size

public Integer size()

The size of the volume, in GiBs.

Returns:

The size of the volume, in GiBs.

snapshotId

public String snapshotId()

The snapshot from which the volume was created, if applicable.

Returns:

The snapshot from which the volume was created, if applicable.

state

public String state()

The volume state.

Returns:

The volume state.

See Also:

VolumeState

volumeId

public String volumeId()

The ID of the volume.

Returns:

The ID of the volume.

iops

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.

Returns:

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.

tags

public List<Tag> tags()

Any tags assigned to the volume.

Returns:

Any tags assigned to the volume.

volumeType

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

Returns:

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.

See Also:

VolumeType

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