Class CfnInstance.BlockDeviceMappingProperty
Specifies a block device mapping for an instance.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class BlockDeviceMappingProperty : Object, CfnInstance.IBlockDeviceMappingPropertySyntax (vb)
Public Class BlockDeviceMappingProperty
Inherits Object
Implements CfnInstance.IBlockDeviceMappingPropertyRemarks
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 <code>DeleteOnTermination</code> parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var blockDeviceMappingProperty = new BlockDeviceMappingProperty {
DeviceName = "deviceName",
// the properties below are optional
Ebs = new EbsProperty {
DeleteOnTermination = false,
Encrypted = false,
Iops = 123,
KmsKeyId = "kmsKeyId",
SnapshotId = "snapshotId",
VolumeSize = 123,
VolumeType = "volumeType"
},
NoDevice = new NoDeviceProperty { },
VirtualName = "virtualName"
};Synopsis
Constructors
| BlockDeviceMappingProperty() |
Properties
| DeviceName | The device name (for example, |
| Ebs | Parameters used to automatically set up EBS volumes when the instance is launched. |
| NoDevice | To omit the device from the block device mapping, specify an empty string. |
| VirtualName | The virtual device name ( |
Constructors
BlockDeviceMappingProperty()
public BlockDeviceMappingProperty()Properties
DeviceName
The device name (for example, /dev/sdh or xvdh ).
public string DeviceName { get; set; }Property Value
System.String
Remarks
After the instance is running, this parameter is used to specify the device name of the block device mapping to update.
Ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
public object Ebs { get; set; }Property Value
System.Object
Remarks
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 .
NoDevice
To omit the device from the block device mapping, specify an empty string.
public object NoDevice { get; set; }Property Value
System.Object
Remarks
After the instance is running, modifying this parameter results in instance replacement .
VirtualName
The virtual device name ( ephemeral N).
public string VirtualName { get; set; }Property Value
System.String
Remarks
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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">replacement</a> .