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

Interface BlockDeviceMapping.Builder

All Superinterfaces:

Buildable, CopyableBuilder<BlockDeviceMapping.Builder,BlockDeviceMapping>, SdkBuilder<BlockDeviceMapping.Builder,BlockDeviceMapping>, SdkPojo

Enclosing class:

BlockDeviceMapping

public static interface BlockDeviceMapping.Builder
extends SdkPojo, CopyableBuilder<BlockDeviceMapping.Builder,BlockDeviceMapping>

Method Summary

Modifier and Type	Method	Description
BlockDeviceMapping.Builder	deviceName(String deviceName)	The device name (for example, /dev/sdh or xvdh).
default BlockDeviceMapping.Builder	ebs(Consumer<EbsBlockDevice.Builder> ebs)	Parameters used to automatically set up EBS volumes when the instance is launched.
BlockDeviceMapping.Builder	ebs(EbsBlockDevice ebs)	Parameters used to automatically set up EBS volumes when the instance is launched.
BlockDeviceMapping.Builder	noDevice(String noDevice)	To omit the device from the block device mapping, specify an empty string.
BlockDeviceMapping.Builder	virtualName(String virtualName)	The virtual device name (ephemeralN).

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

deviceName

BlockDeviceMapping.Builder deviceName(String deviceName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

virtualName

BlockDeviceMapping.Builder virtualName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

ebs

BlockDeviceMapping.Builder ebs(EbsBlockDevice ebs)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

ebs

default BlockDeviceMapping.Builder ebs(Consumer<EbsBlockDevice.Builder> ebs)

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

This is a convenience method that creates an instance of the EbsBlockDevice.Builder avoiding the need to create one manually via EbsBlockDevice.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ebs(EbsBlockDevice).

Parameters:

ebs - a consumer that will call methods on EbsBlockDevice.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ebs(EbsBlockDevice)

noDevice

BlockDeviceMapping.Builder noDevice(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.