Package software.amazon.awscdk.services.autoscaling

Class BlockDevice.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.BlockDevice.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BlockDevice>

Enclosing interface:

BlockDevice

@Stability(Stable)
public static final class BlockDevice.Builder
extends Object
implements software.amazon.jsii.Builder<BlockDevice>

A builder for BlockDevice

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BlockDevice	build()	Builds the configured instance.
BlockDevice.Builder	deviceName(String deviceName)	Sets the value of BlockDevice.getDeviceName()
BlockDevice.Builder	mappingEnabled(Boolean mappingEnabled)	Deprecated. use `BlockDeviceVolume.noDevice()` as the volume to supress a mapping.
BlockDevice.Builder	volume(BlockDeviceVolume volume)	Sets the value of BlockDevice.getVolume()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

deviceName

@Stability(Stable)
public BlockDevice.Builder deviceName(String deviceName)

Sets the value of BlockDevice.getDeviceName()

Parameters:

deviceName - The device name exposed to the EC2 instance. This parameter is required. Supply a value like /dev/sdh, xvdh.

Returns:

this

volume

@Stability(Stable)
public BlockDevice.Builder volume(BlockDeviceVolume volume)

Sets the value of BlockDevice.getVolume()

Parameters:

volume - Defines the block device volume, to be either an Amazon EBS volume or an ephemeral instance store volume. This parameter is required. Supply a value like BlockDeviceVolume.ebs(15), BlockDeviceVolume.ephemeral(0).

Returns:

this

mappingEnabled

@Stability(Deprecated)
@Deprecated
public BlockDevice.Builder mappingEnabled(Boolean mappingEnabled)

Deprecated.

use `BlockDeviceVolume.noDevice()` as the volume to supress a mapping.

Sets the value of BlockDevice.getMappingEnabled()

Parameters:

mappingEnabled - If false, the device mapping will be suppressed. If set to false for the root device, the instance might fail the Amazon EC2 health check. Amazon EC2 Auto Scaling launches a replacement instance if the instance fails the health check.

Returns:

this

build

@Stability(Stable)
public BlockDevice build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BlockDevice>

Returns:

a new instance of BlockDevice

Throws:

NullPointerException - if any required attribute was not provided