Class CfnLaunchConfiguration.BlockDeviceMappingProperty
BlockDeviceMapping
specifies a block device mapping for the BlockDeviceMappings
property of the AWS::AutoScaling::LaunchConfiguration resource.
Inheritance
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class BlockDeviceMappingProperty : Object, CfnLaunchConfiguration.IBlockDeviceMappingProperty
Syntax (vb)
Public Class BlockDeviceMappingProperty
Inherits Object
Implements CfnLaunchConfiguration.IBlockDeviceMappingProperty
Remarks
Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
For more information, see Example block device mapping in the Amazon EC2 User Guide for Linux Instances .
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;
var blockDeviceMappingProperty = new BlockDeviceMappingProperty {
DeviceName = "deviceName",
// the properties below are optional
Ebs = new BlockDeviceProperty {
DeleteOnTermination = false,
Encrypted = false,
Iops = 123,
SnapshotId = "snapshotId",
Throughput = 123,
VolumeSize = 123,
VolumeType = "volumeType"
},
NoDevice = false,
VirtualName = "virtualName"
};
Synopsis
Constructors
BlockDeviceMappingProperty() |
Properties
DeviceName | The device name assigned to the volume (for example, |
Ebs | Information to attach an EBS volume to an instance at launch. |
NoDevice | Setting this value to |
VirtualName | The name of the instance store volume (virtual device) to attach to an instance at launch. |
Constructors
BlockDeviceMappingProperty()
public BlockDeviceMappingProperty()
Properties
DeviceName
The device name assigned to the volume (for example, /dev/sdh
or xvdh
).
public string DeviceName { get; set; }
Property Value
System.String
Remarks
For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances .
To define a block device mapping, set the device name and exactly one of the following properties: Ebs
, NoDevice
, or VirtualName
.
Ebs
Information to attach an EBS volume to an instance at launch.
public object Ebs { get; set; }
Property Value
System.Object
Remarks
NoDevice
Setting this value to true
prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.
public object NoDevice { get; set; }
Property Value
System.Object
Remarks
If NoDevice
is true
for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.
VirtualName
The name of the instance store volume (virtual device) to attach to an instance at launch.
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, ephemeral0
.