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 is encrypted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(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.
String	kmsKeyId() The Amazon Resource Name (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()
String	toString() Returns a string representation of this object.
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

clone, finalize, 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 is encrypted.

Returns:

Indicates whether the volume is encrypted.

kmsKeyId

public String kmsKeyId()

The Amazon Resource Name (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 Amazon Resource Name (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, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes, in most Regions. The maximum IOPS for io1 of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS.

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, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes, in most Regions. The maximum IOPS for io1 of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS.

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

Specified by:

toBuilder in interface ToCopyableBuilder<CreateVolumeResponse.Builder,CreateVolumeResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateVolumeResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo