Package software.amazon.awssdk.services.autoscaling.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 assigned to the volume (for example, /dev/sdh or xvdh).
default BlockDeviceMapping.Builder	ebs(Consumer<Ebs.Builder> ebs)	Information to attach an EBS volume to an instance at launch.
BlockDeviceMapping.Builder	ebs(Ebs ebs)	Information to attach an EBS volume to an instance at launch.
BlockDeviceMapping.Builder	noDevice(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.
BlockDeviceMapping.Builder	virtualName(String virtualName)	The name of the instance store volume (virtual device) to attach to an instance at launch.

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

virtualName

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

Parameters:

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:

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

deviceName

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

Parameters:

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:

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

ebs

BlockDeviceMapping.Builder ebs(Ebs ebs)

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

Parameters:

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

Returns:

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

ebs

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

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

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

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

Parameters:

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

Returns:

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

See Also:

ebs(Ebs)

noDevice

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

Parameters:

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:

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