software.amazon.awscdk.services.ec2

Class BlockDeviceVolume

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.BlockDeviceVolume

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.108Z")
 @Stability(value=Stable)
public class BlockDeviceVolume
extends software.amazon.jsii.JsiiObject

Describes a block device mapping for an EC2 instance or Auto Scaling group.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 Vpc vpc;
 InstanceType instanceType;
 IMachineImage machineImage;
 Instance.Builder.create(this, "Instance")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         // ...
         .blockDevices(List.of(BlockDevice.builder()
                 .deviceName("/dev/sda1")
                 .volume(BlockDeviceVolume.ebs(50))
                 .build(), BlockDevice.builder()
                 .deviceName("/dev/sdm")
                 .volume(BlockDeviceVolume.ebs(100))
                 .build()))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockDeviceVolume()
protected	BlockDeviceVolume(EbsDeviceProps ebsDevice)
protected	BlockDeviceVolume(EbsDeviceProps ebsDevice, String virtualName)
protected	BlockDeviceVolume(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BlockDeviceVolume(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static BlockDeviceVolume	ebs(Number volumeSize) Creates a new Elastic Block Storage device.
static BlockDeviceVolume	ebs(Number volumeSize, EbsDeviceOptions options) Creates a new Elastic Block Storage device.
static BlockDeviceVolume	ebsFromSnapshot(String snapshotId) Creates a new Elastic Block Storage device from an existing snapshot.
static BlockDeviceVolume	ebsFromSnapshot(String snapshotId, EbsDeviceSnapshotOptions options) Creates a new Elastic Block Storage device from an existing snapshot.
static BlockDeviceVolume	ephemeral(Number volumeIndex) Creates a virtual, ephemeral device.
EbsDeviceProps	getEbsDevice() EBS device info.
String	getVirtualName() Virtual device name.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

BlockDeviceVolume

protected BlockDeviceVolume(software.amazon.jsii.JsiiObjectRef objRef)

BlockDeviceVolume

protected BlockDeviceVolume(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BlockDeviceVolume

@Stability(value=Stable)
protected BlockDeviceVolume(@Nullable
                                                     EbsDeviceProps ebsDevice,
                                                     @Nullable
                                                     String virtualName)

Parameters:

ebsDevice - EBS device info.

virtualName - Virtual device name.

BlockDeviceVolume

@Stability(value=Stable)
protected BlockDeviceVolume(@Nullable
                                                     EbsDeviceProps ebsDevice)

Parameters:

ebsDevice - EBS device info.

BlockDeviceVolume

@Stability(value=Stable)
protected BlockDeviceVolume()

Method Detail

ebs

@Stability(value=Stable)
 @NotNull
public static BlockDeviceVolume ebs(@NotNull
                                                                       Number volumeSize,
                                                                       @Nullable
                                                                       EbsDeviceOptions options)

Creates a new Elastic Block Storage device.

Parameters:

volumeSize - The volume size, in Gibibytes (GiB). This parameter is required.

options - additional device options.

ebs

@Stability(value=Stable)
 @NotNull
public static BlockDeviceVolume ebs(@NotNull
                                                                       Number volumeSize)

Creates a new Elastic Block Storage device.

Parameters:

volumeSize - The volume size, in Gibibytes (GiB). This parameter is required.

ebsFromSnapshot

@Stability(value=Stable)
 @NotNull
public static BlockDeviceVolume ebsFromSnapshot(@NotNull
                                                                                   String snapshotId,
                                                                                   @Nullable
                                                                                   EbsDeviceSnapshotOptions options)

Creates a new Elastic Block Storage device from an existing snapshot.

Parameters:

snapshotId - The snapshot ID of the volume to use. This parameter is required.

options - additional device options.

ebsFromSnapshot

@Stability(value=Stable)
 @NotNull
public static BlockDeviceVolume ebsFromSnapshot(@NotNull
                                                                                   String snapshotId)

Creates a new Elastic Block Storage device from an existing snapshot.

Parameters:

snapshotId - The snapshot ID of the volume to use. This parameter is required.

ephemeral

@Stability(value=Stable)
 @NotNull
public static BlockDeviceVolume ephemeral(@NotNull
                                                                             Number volumeIndex)

Creates a virtual, ephemeral device.

The name will be in the form ephemeral{volumeIndex}.

Parameters:

volumeIndex - the volume index. This parameter is required.

getEbsDevice

@Stability(value=Stable)
 @Nullable
public EbsDeviceProps getEbsDevice()

EBS device info.

getVirtualName

@Stability(value=Stable)
 @Nullable
public String getVirtualName()

Virtual device name.