Class Volume

java.lang.Object
software.amazon.awssdk.services.ec2.model.Volume
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Volume.Builder,Volume>
@Generated("software.amazon.awssdk:codegen") public final class Volume extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Volume.Builder,Volume>

Describes a volume.

See Also:

  • Method Details

    • outpostArn

      public final String outpostArn()

      The Amazon Resource Name (ARN) of the Outpost.

      Returns:
      The Amazon Resource Name (ARN) of the Outpost.

    • iops

      public final 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 final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Any tags assigned to the volume.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Any tags assigned to the volume.

    • volumeType

      public final 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:

    • volumeTypeAsString

      public final 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:

    • fastRestored

      public final Boolean fastRestored()

      This parameter is not returned by CreateVolume.

      Indicates whether the volume was created using fast snapshot restore.

      Returns:

      This parameter is not returned by CreateVolume.

      Indicates whether the volume was created using fast snapshot restore.

    • multiAttachEnabled

      public final Boolean multiAttachEnabled()

      Indicates whether Amazon EBS Multi-Attach is enabled.

      Returns:
      Indicates whether Amazon EBS Multi-Attach is enabled.

    • throughput

      public final Integer throughput()

      The throughput that the volume supports, in MiB/s.

      Returns:
      The throughput that the volume supports, in MiB/s.

    • sseType

      public final SSEType sseType()

      This parameter is not returned by CreateVolume.

      Reserved for future use.

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

      Returns:

      This parameter is not returned by CreateVolume.

      Reserved for future use.

      See Also:

    • sseTypeAsString

      public final String sseTypeAsString()

      This parameter is not returned by CreateVolume.

      Reserved for future use.

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

      Returns:

      This parameter is not returned by CreateVolume.

      Reserved for future use.

      See Also:

    • volumeId

      public final String volumeId()

      The ID of the volume.

      Returns:
      The ID of the volume.

    • size

      public final Integer size()

      The size of the volume, in GiBs.

      Returns:
      The size of the volume, in GiBs.

    • snapshotId

      public final String snapshotId()

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

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

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone for the volume.

      Returns:
      The Availability Zone for the volume.

    • state

      public final 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:

    • stateAsString

      public final 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:

    • createTime

      public final Instant createTime()

      The time stamp when volume creation was initiated.

      Returns:
      The time stamp when volume creation was initiated.

    • hasAttachments

      public final boolean hasAttachments()
      For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attachments

      public final List<VolumeAttachment> attachments()

      This parameter is not returned by CreateVolume.

      Information about the volume attachments.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttachments() method.

      Returns:

      This parameter is not returned by CreateVolume.

      Information about the volume attachments.

    • encrypted

      public final Boolean encrypted()

      Indicates whether the volume is encrypted.

      Returns:
      Indicates whether the volume is encrypted.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.