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

Class FleetBlockDeviceMappingRequest

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

Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

To override a block device mapping specified in the launch template:

  • Specify the exact same DeviceName here as specified in the launch template.

  • Only specify the parameters you want to change.

  • Any parameters you don't specify here will keep their original launch template values.

To add a new block device mapping:

  • Specify a DeviceName that doesn't exist in the launch template.

  • Specify all desired parameters here.

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 FleetEbsBlockDeviceRequest 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 FleetBlockDeviceMappingRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<FleetBlockDeviceMappingRequest.Builder,FleetBlockDeviceMappingRequest>

    • builder

      public static FleetBlockDeviceMappingRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FleetBlockDeviceMappingRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo