Package software.amazon.awscdk.services.ec2

Interface CfnInstance.BlockDeviceMappingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInstance.BlockDeviceMappingProperty.Jsii$Proxy

Enclosing class:

CfnInstance

@Stability(Stable)
public static interface CfnInstance.BlockDeviceMappingProperty
extends software.amazon.jsii.JsiiSerializable

Specifies a block device mapping for an instance.

You must specify exactly one of the following properties: VirtualName , Ebs , or NoDevice .

BlockDeviceMapping is a property of the AWS::EC2::Instance resource.

After the instance is running, you can modify only the DeleteOnTermination parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance replacement .

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.*;
 BlockDeviceMappingProperty blockDeviceMappingProperty = BlockDeviceMappingProperty.builder()
         .deviceName("deviceName")
         // the properties below are optional
         .ebs(EbsProperty.builder()
                 .deleteOnTermination(false)
                 .encrypted(false)
                 .iops(123)
                 .kmsKeyId("kmsKeyId")
                 .snapshotId("snapshotId")
                 .volumeSize(123)
                 .volumeType("volumeType")
                 .build())
         .noDevice(NoDeviceProperty.builder().build())
         .virtualName("virtualName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnInstance.BlockDeviceMappingProperty.Builder	builder()
String	getDeviceName()	The device name (for example, /dev/sdh or xvdh ).
default Object	getEbs()	Parameters used to automatically set up EBS volumes when the instance is launched.
default Object	getNoDevice()	To omit the device from the block device mapping, specify an empty string.
default String	getVirtualName()	The virtual device name ( ephemeral N).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeviceName

@Stability(Stable)
@NotNull
String getDeviceName()

The device name (for example, /dev/sdh or xvdh ).

After the instance is running, this parameter is used to specify the device name of the block device mapping to update.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-devicename

getEbs

@Stability(Stable)
@Nullable
default Object getEbs()

Parameters used to automatically set up EBS volumes when the instance is launched.

After the instance is running, you can modify only the DeleteOnTermination parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance replacement .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-ebs

getNoDevice

@Stability(Stable)
@Nullable
default Object getNoDevice()

To omit the device from the block device mapping, specify an empty string.

After the instance is running, modifying this parameter results in instance replacement .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-nodevice

getVirtualName

@Stability(Stable)
@Nullable
default String getVirtualName()

The virtual device name ( ephemeral N).

The name must be in the form ephemeral X where X is a number starting from zero (0). For example, an instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

Constraints : For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

After the instance is running, modifying this parameter results in instance replacement .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-virtualname

builder

@Stability(Stable)
static CfnInstance.BlockDeviceMappingProperty.Builder builder()

Returns:

a CfnInstance.BlockDeviceMappingProperty.Builder of CfnInstance.BlockDeviceMappingProperty