software.amazon.awscdk.services.autoscaling

Interface BlockDevice

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BlockDevice.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:01.215Z")
 @Stability(value=Experimental)
public interface BlockDevice
extends software.amazon.jsii.JsiiSerializable

(experimental) Block device.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 BlockDeviceVolume blockDeviceVolume;
 BlockDevice blockDevice = BlockDevice.builder()
         .deviceName("deviceName")
         .volume(blockDeviceVolume)
         // the properties below are optional
         .mappingEnabled(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BlockDevice.Builder A builder for BlockDevice
static class	BlockDevice.Jsii$Proxy An implementation for BlockDevice

Method Summary

Modifier and Type	Method and Description
static BlockDevice.Builder	builder()
String	getDeviceName() (experimental) The device name exposed to the EC2 instance.
default Boolean	getMappingEnabled() Deprecated. use `BlockDeviceVolume.noDevice()` as the volume to supress a mapping.
BlockDeviceVolume	getVolume() (experimental) Defines the block device volume, to be either an Amazon EBS volume or an ephemeral instance store volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeviceName

@Stability(value=Experimental)
 @NotNull
String getDeviceName()

(experimental) The device name exposed to the EC2 instance.

Supply a value like /dev/sdh, xvdh.

See Also:

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html

getVolume

@Stability(value=Experimental)
 @NotNull
BlockDeviceVolume getVolume()

(experimental) Defines the block device volume, to be either an Amazon EBS volume or an ephemeral instance store volume.

Supply a value like BlockDeviceVolume.ebs(15), BlockDeviceVolume.ephemeral(0).

getMappingEnabled

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Boolean getMappingEnabled()

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

(deprecated) 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.

Default: true - device mapping is left untouched

builder

@Stability(value=Experimental)
static BlockDevice.Builder builder()

Returns:

a BlockDevice.Builder of BlockDevice