Package software.amazon.awssdk.services.opsworks.model

Class EbsBlockDevice

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

Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.

See Also:

  • Method Details

    • snapshotId

      public final String snapshotId()

      The snapshot ID.

      Returns:
      The snapshot ID.

    • iops

      public final Integer iops()

      The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

      Returns:
      The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

    • volumeSize

      public final Integer volumeSize()

      The volume size, in GiB. For more information, see EbsBlockDevice.

      Returns:
      The volume size, in GiB. For more information, see EbsBlockDevice.

    • volumeType

      public final VolumeType volumeType()

      The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

      If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

      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. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

      If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

      See Also:

    • volumeTypeAsString

      public final String volumeTypeAsString()

      The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

      If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

      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. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

      If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

      See Also:

    • deleteOnTermination

      public final Boolean deleteOnTermination()

      Whether the volume is deleted on instance termination.

      Returns:
      Whether the volume is deleted on instance termination.

    • toBuilder

      public EbsBlockDevice.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<EbsBlockDevice.Builder,EbsBlockDevice>
      Returns:
      a builder for type T

    • builder

      public static EbsBlockDevice.Builder builder()

    • serializableBuilderClass

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