AWS::AutoScaling::LaunchConfiguration BlockDeviceMapping - AWS CloudFormation
SyntaxPropertiesSee also

AWS::AutoScaling::LaunchConfiguration BlockDeviceMapping

BlockDeviceMapping specifies a block device mapping for the BlockDeviceMappings property of the AWS::AutoScaling::LaunchConfiguration resource.

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DeviceName" : String,
  "Ebs" : BlockDevice,
  "NoDevice" : Boolean,
  "VirtualName" : String
}

YAML

  DeviceName: String
  Ebs: 
    BlockDevice
  NoDevice: Boolean
  VirtualName: String

Properties

DeviceName

The device name assigned to the volume (for example, /dev/sdh or xvdh). For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.

Note

To define a block device mapping, set the device name and exactly one of the following properties: Ebs, NoDevice, or VirtualName.

Required: Yes

Type: String

Update requires: Replacement

Ebs

Information to attach an EBS volume to an instance at launch.

Required: No

Type: BlockDevice

Update requires: Replacement

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.

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.

Required: No

Type: Boolean

Update requires: Replacement

VirtualName

The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeralX where X is a number starting from zero (0), for example, ephemeral0.

Required: No

Type: String

Update requires: Replacement

See also