Class BlockDeviceMapping

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

Describes a block device mapping.

See Also:

  • Method Details

    • virtualName

      public final String virtualName()

      The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeralX where X is a number starting from zero (0), for example, ephemeral0.

      Returns:
      The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeralX where X is a number starting from zero (0), for example, ephemeral0.

    • deviceName

      public final String deviceName()

      The device name assigned to the volume (for example, /dev/sdh or xvdh). For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.

      To define a block device mapping, set the device name and exactly one of the following properties: Ebs, NoDevice, or VirtualName.

      Returns:
      The device name assigned to the volume (for example, /dev/sdh or xvdh). For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.

      To define a block device mapping, set the device name and exactly one of the following properties: Ebs, NoDevice, or VirtualName.

    • ebs

      public final Ebs ebs()

      Information to attach an EBS volume to an instance at launch.

      Returns:
      Information to attach an EBS volume to an instance at launch.

    • noDevice

      public final Boolean noDevice()

      Setting this value to true prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.

      If NoDevice is true for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

      Returns:
      Setting this value to true prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.

      If NoDevice is true for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

    • toBuilder

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

    • builder

      public static BlockDeviceMapping.Builder builder()

    • serializableBuilderClass

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