Interface IBlockDevice
Block device.
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public interface IBlockDevice
Syntax (vb)
Public Interface IBlockDevice
Remarks
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;
BlockDeviceVolume blockDeviceVolume;
var blockDevice = new BlockDevice {
DeviceName = "deviceName",
Volume = blockDeviceVolume,
// the properties below are optional
MappingEnabled = false
};
Synopsis
Properties
DeviceName | The device name exposed to the EC2 instance. |
MappingEnabled | If false, the device mapping will be suppressed. |
Volume | Defines the block device volume, to be either an Amazon EBS volume or an ephemeral instance store volume. |
Properties
DeviceName
The device name exposed to the EC2 instance.
string DeviceName { get; }
Property Value
System.String
Remarks
For example, a value like /dev/sdh
, xvdh
.
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html
MappingEnabled
If false, the device mapping will be suppressed.
virtual Nullable<bool> MappingEnabled { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
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
Volume
Defines the block device volume, to be either an Amazon EBS volume or an ephemeral instance store volume.
BlockDeviceVolume Volume { get; }
Property Value
Remarks
For example, a value like BlockDeviceVolume.ebs(15)
, BlockDeviceVolume.ephemeral(0)
.