software.amazon.awssdk.services.ec2.model

Class CreateVolumeResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ec2.model.Ec2Response

software.amazon.awssdk.services.ec2.model.CreateVolumeResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateVolumeResponse.Builder,CreateVolumeResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateVolumeResponse
extends Ec2Response
implements ToCopyableBuilder<CreateVolumeResponse.Builder,CreateVolumeResponse>

Describes a volume.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateVolumeResponse.Builder

Method Summary

Modifier and Type	Method and Description
List<VolumeAttachment>	attachments() Information about the volume attachments.
String	availabilityZone() The Availability Zone for the volume.
static CreateVolumeResponse.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) Used to retrieve the value of a field from any class that extends SdkResponse.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateVolumeResponse.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	stateAsString() The volume state.
List<Tag>	tags() Any tags assigned to the volume.
CreateVolumeResponse.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	volumeTypeAsString() The volume type.

Methods inherited from class software.amazon.awssdk.services.ec2.model.Ec2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

attachments

public List<VolumeAttachment> attachments()

Information about the volume attachments.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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 Instant 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 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 stateAsString().

Returns:

The volume state.

See Also:

VolumeState

stateAsString

public String stateAsString()

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

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 about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-10,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most regions. Maximum io1IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

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 about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-10,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most regions. Maximum io1IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Any tags assigned to the volume.

volumeType

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

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

volumeTypeAsString

public String volumeTypeAsString()

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

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 CreateVolumeResponse.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<CreateVolumeResponse.Builder,CreateVolumeResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static CreateVolumeResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CreateVolumeResponse.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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.