AWS Documentation » AWS CloudFormation » User Guide » Template Reference » Resource Property Types Reference » AWS CloudFormation EC2 Block Device Mapping Property Type	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

AWS CloudFormation EC2 Block Device Mapping Property Type

The EC2 Block Device Mapping type is an embedded property of the AWS::EC2::Instance type.

Syntax

{
   "DeviceName" : String,
   "Ebs" : EC2 EBS Block Device,
   "NoDevice" : {},
   "VirtualName" : String
}

Properties

DeviceName

The name of the device within Amazon EC2.

Required: Yes.

Type: String.

Ebs

Required: Conditional. You can specify either VirtualName or Ebs, but not both.

Type: EC2 EBS Block Device.

NoDevice

This property can be used to unmap a defined device.

Required: No.

Type: an empty map: {}.

VirtualName

The name of the virtual device. The name must be in the form ephemeralX where X is a number starting from zero (0); for example, ephemeral0.

Required: Conditional. You can specify either VirtualName or Ebs, but not both.

Type: String.

Examples

Block Device Mapping with two EBS Volumes

This example sets the EBS-backed root device (/dev/sda1) size to 50 GiB, and another EBS-backed device mapped to /dev/sdm that is 100 GiB in size.

"BlockDeviceMappings" : [
   {
      "DeviceName" : "/dev/sda1",
      "Ebs" : { "VolumeSize" : "50" }
   },
   {
      "DeviceName" : "/dev/sdm",
      "Ebs" : { "VolumeSize" : "100" }
   }
]

Block Device Mapping with an Ephemeral Drive

This example maps an ephemeral drive to device /dev/sdc.

"BlockDeviceMappings" : [
   {
      "DeviceName"  : "/dev/sdc",
      "VirtualName" : "ephemeral0"
   }
]

Unmapping an AMI-defined Device

To unmap a device defined in the AMI, set the NoDevice property to an empty map, as shown here:

{
   "DeviceName":"/dev/sde",
   "NoDevice": {}
}

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...