Volume (AWS Java SDK :: Services :: Amazon EC2 2.15.37 API)

java.lang.Object
- software.amazon.awssdk.services.ec2.model.Volume

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Volume.Builder,Volume>

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

Describes a volume.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Volume.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Volume.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<VolumeAttachment>`	`attachments()` Information about the volume attachments.
`String`	`availabilityZone()` The Availability Zone for the volume.
`static Volume.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)`
`Boolean`	`fastRestored()` Indicates whether the volume was created using fast snapshot restore.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttachments()` Returns true if the Attachments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`iops()` The number of I/O operations per second (IOPS).
`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.
`Boolean`	`multiAttachEnabled()` Indicates whether Amazon EBS Multi-Attach is enabled.
`String`	`outpostArn()` The Amazon Resource Name (ARN) of the Outpost.
`List<SdkField<?>>`	`sdkFields()`
`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.
`VolumeState`	`state()` The volume state.
`String`	`stateAsString()` The volume state.
`List<Tag>`	`tags()` Any tags assigned to the volume.
`Integer`	`throughput()` The throughput that the volume supports, in MiB/s.
`Volume.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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasAttachments
```
public boolean hasAttachments()
```
    Returns true if the Attachments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - attachments
```
public List<VolumeAttachment> attachments()
```
    Information about the volume attachments.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAttachments() to see if a value was sent in this field.
    
    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.
  - outpostArn
```
public String outpostArn()
```
    The Amazon Resource Name (ARN) of the Outpost.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Outpost.
  - 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). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
    
    Returns:
    
    The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Any tags assigned to the volume.
  - volumeType
```
public VolumeType volumeType()
```
    The volume type.
    
    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.
    
    See Also:
    
    VolumeType
  - volumeTypeAsString
```
public String volumeTypeAsString()
```
    The volume type.
    
    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.
    
    See Also:
    
    VolumeType
  - fastRestored
```
public Boolean fastRestored()
```
    Indicates whether the volume was created using fast snapshot restore.
    
    Returns:
    
    Indicates whether the volume was created using fast snapshot restore.
  - multiAttachEnabled
```
public Boolean multiAttachEnabled()
```
    Indicates whether Amazon EBS Multi-Attach is enabled.
    
    Returns:
    
    Indicates whether Amazon EBS Multi-Attach is enabled.
  - throughput
```
public Integer throughput()
```
    The throughput that the volume supports, in MiB/s.
    
    Returns:
    
    The throughput that the volume supports, in MiB/s.
  - toBuilder
```
public Volume.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Volume.Builder,Volume>
  - 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
  - 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)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Volume

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAttachments

attachments

availabilityZone

createTime

encrypted

kmsKeyId

outpostArn

size

snapshotId

state

stateAsString

volumeId

iops

hasTags

tags

volumeType

volumeTypeAsString

fastRestored

multiAttachEnabled

throughput

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields