software.amazon.awscdk.services.ec2

Interface BlockDevice

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BlockDevice.Jsii$Proxy

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-21T11:01:44.792Z")
 @Stability(value=Stable)
public interface BlockDevice
extends software.amazon.jsii.JsiiSerializable

Block device.

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() The device name exposed to the EC2 instance.
default Boolean	getMappingEnabled() If false, the device mapping will be suppressed.
BlockDeviceVolume	getVolume() 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=Stable)
 @NotNull
String getDeviceName()

The device name exposed to the EC2 instance.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 "/dev/sdh" , "xvdh";

See Also:

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

getVolume

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

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

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 BlockDeviceVolume.ebs(15) , BlockDeviceVolume.ephemeral(0);

getMappingEnabled

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

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=Stable)
static BlockDevice.Builder builder()

Returns:

a BlockDevice.Builder of BlockDevice