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

Class VolumeAttachment

java.lang.Object

software.amazon.awssdk.services.ec2.model.VolumeAttachment

All Implemented Interfaces:

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

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

Describes volume attachment details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VolumeAttachment.Builder

Method Summary

Modifier and Type	Method	Description
String	associatedResource()	The ARN of the Amazon ECS or Fargate task to which the volume is attached.
Instant	attachTime()	The time stamp when the attachment initiated.
static VolumeAttachment.Builder	builder()
Boolean	deleteOnTermination()	Indicates whether the EBS volume is deleted on instance termination.
String	device()	The device name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId()	The ID of the instance.
String	instanceOwningService()	The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.
List<SdkField<?>>	sdkFields()
static Class<? extends VolumeAttachment.Builder>	serializableBuilderClass()
VolumeAttachmentState	state()	The attachment state of the volume.
String	stateAsString()	The attachment state of the volume.
VolumeAttachment.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	volumeId()	The ID of the volume.

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

attachTime

public final Instant attachTime()

The time stamp when the attachment initiated.

Returns:

The time stamp when the attachment initiated.

device

public final String device()

The device name.

If the volume is attached to a Fargate task, this parameter returns null.

Returns:

The device name.

If the volume is attached to a Fargate task, this parameter returns null.

instanceId

public final String instanceId()

The ID of the instance.

If the volume is attached to a Fargate task, this parameter returns null.

Returns:

The ID of the instance.

If the volume is attached to a Fargate task, this parameter returns null.

state

public final VolumeAttachmentState state()

The attachment state of the volume.

If the service returns an enum value that is not available in the current SDK version, state will return VolumeAttachmentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The attachment state of the volume.

See Also:

VolumeAttachmentState

stateAsString

public final String stateAsString()

The attachment state of the volume.

If the service returns an enum value that is not available in the current SDK version, state will return VolumeAttachmentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The attachment state of the volume.

See Also:

VolumeAttachmentState

volumeId

public final String volumeId()

The ID of the volume.

Returns:

The ID of the volume.

deleteOnTermination

public final Boolean deleteOnTermination()

Indicates whether the EBS volume is deleted on instance termination.

Returns:

Indicates whether the EBS volume is deleted on instance termination.

associatedResource

public final String associatedResource()

The ARN of the Amazon ECS or Fargate task to which the volume is attached.

Returns:

The ARN of the Amazon ECS or Fargate task to which the volume is attached.

instanceOwningService

public final String instanceOwningService()

The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.

This parameter is returned only for volumes that are attached to Fargate tasks.

Returns:

The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.

This parameter is returned only for volumes that are attached to Fargate tasks.

toBuilder

public VolumeAttachment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VolumeAttachment.Builder,VolumeAttachment>

builder

public static VolumeAttachment.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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