Package software.amazon.awssdk.services.ec2.model

Class BlockDeviceMapping

java.lang.Object
software.amazon.awssdk.services.ec2.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, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

See Also:

  • Method Details

    • deviceName

      public final String deviceName()

      The device name (for example, /dev/sdh or xvdh).

      Returns:
      The device name (for example, /dev/sdh or xvdh).

    • virtualName

      public final String virtualName()

      The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

      NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

      Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

      Returns:
      The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

      NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

      Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

    • ebs

      public final EbsBlockDevice ebs()

      Parameters used to automatically set up EBS volumes when the instance is launched.

      Returns:
      Parameters used to automatically set up EBS volumes when the instance is launched.

    • noDevice

      public final String noDevice()

      To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.

      Returns:
      To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.

    • 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.