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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BlockDeviceMapping.Builder

Method Summary

Modifier and Type	Method	Description
static BlockDeviceMapping.Builder	builder()
final String	deviceName()	The device name.
final EbsBlockDevice	ebs()	Parameters used to automatically set up EBS volumes when the instance is launched.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	noDevice()	To omit the device from the block device mapping, specify an empty string.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends BlockDeviceMapping.Builder>	serializableBuilderClass()
BlockDeviceMapping.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final String	virtualName()	The virtual device name (ephemeralN).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

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.

deviceName

public final String deviceName()

The device name. For available device names, see Device names for volumes.

Returns:

The device name. For available device names, see Device names for volumes.

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.

toBuilder

public BlockDeviceMapping.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BlockDeviceMapping.Builder,BlockDeviceMapping>

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)

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