Show / Hide Table of Contents

Class BlockDevice

Block device.

Inheritance
System.Object
BlockDevice
Implements
IBlockDevice
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.AWS.AutoScaling.dll
Syntax (csharp)
public class BlockDevice : Object, IBlockDevice
Syntax (vb)
Public Class BlockDevice
    Inherits Object
    Implements 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.AutoScaling;

BlockDeviceVolume blockDeviceVolume;

var blockDevice = new BlockDevice {
    DeviceName = "deviceName",
    Volume = blockDeviceVolume,

    // the properties below are optional
    MappingEnabled = false
};

Synopsis

Constructors

BlockDevice()

Properties

DeviceName

The device name exposed to the EC2 instance.

MappingEnabled

(deprecated) 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.

Constructors

BlockDevice()

public BlockDevice()

Properties

DeviceName

The device name exposed to the EC2 instance.

public string DeviceName { get; set; }
Property Value

System.String

Remarks

Supply a value like /dev/sdh, xvdh.

See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html

MappingEnabled

(deprecated) If false, the device mapping will be suppressed.

public Nullable<bool> MappingEnabled { get; set; }
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

Stability: Deprecated

Volume

Defines the block device volume, to be either an Amazon EBS volume or an ephemeral instance store volume.

public BlockDeviceVolume Volume { get; set; }
Property Value

BlockDeviceVolume

Remarks

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

Implements

IBlockDevice
Back to top Generated by DocFX