Class EbsInstanceBlockDeviceSpecification

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

Amazon EBS-specific block device mapping specifications.

See Also:

  • Method Details

    • encrypted

      public final Boolean encrypted()

      Specifies whether to encrypt the device.

      Returns:
      Specifies whether to encrypt the device.

    • deleteOnTermination

      public final Boolean deleteOnTermination()

      Specifies whether to delete the associated device on termination.

      Returns:
      Specifies whether to delete the associated device on termination.

    • iops

      public final Integer iops()

      The IOPS value for the device. Required only when volumeType is io1 or io2.

      Returns:
      The IOPS value for the device. Required only when volumeType is io1 or io2.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

    • snapshotId

      public final String snapshotId()

      The snapshot that defines the device contents.

      Returns:
      The snapshot that defines the device contents.

    • volumeSize

      public final Integer volumeSize()

      Overrides the volume size for the device.

      Returns:
      Overrides the volume size for the device.

    • volumeType

      public final EbsVolumeType volumeType()

      Overrides the volume type for the device.

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

      Returns:
      Overrides the volume type for the device.
      See Also:

    • volumeTypeAsString

      public final String volumeTypeAsString()

      Overrides the volume type for the device.

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

      Returns:
      Overrides the volume type for the device.
      See Also:

    • throughput

      public final Integer throughput()

      For GP3 volumes only – The throughput in MiB/s that the volume supports.

      Returns:
      For GP3 volumes only – The throughput in MiB/s that the volume supports.

    • toBuilder

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

    • builder

      public static EbsInstanceBlockDeviceSpecification.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.