Interface BlockDevice

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
BlockDevice.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-24T02:42:36.630Z") @Stability(Stable) public interface BlockDevice extends software.amazon.jsii.JsiiSerializable
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.ec2.*;
 BlockDeviceVolume blockDeviceVolume;
 BlockDevice blockDevice = BlockDevice.builder()
         .deviceName("deviceName")
         .volume(blockDeviceVolume)
         // the properties below are optional
         .mappingEnabled(false)
         .build();
 
  • Method Details

    • getDeviceName

      @Stability(Stable) @NotNull String getDeviceName()
      The device name exposed to the EC2 instance.

      For example, a value like /dev/sdh, xvdh.

      See Also:
    • getVolume

      @Stability(Stable) @NotNull BlockDeviceVolume getVolume()
      Defines the block device volume, to be either an Amazon EBS volume or an ephemeral instance store volume.

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

    • getMappingEnabled

      @Stability(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(Stable) static BlockDevice.Builder builder()
      Returns:
      a BlockDevice.Builder of BlockDevice