AWS CloudFormation
User Guide (API Version 2010-05-15)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

Amazon Elastic Block Store Block Device Property

The Amazon Elastic Block Store block device type is an embedded property of the Amazon EC2 Block Device Mapping Property property.

Syntax

{
   "DeleteOnTermination" : Boolean,
   "Encrypted" : Boolean,
   "Iops" : Number,
   "SnapshotId" : String,
   "VolumeSize" : String,
   "VolumeType" : String
}     

Properties

DeleteOnTermination

Determines whether to delete the volume on instance termination. The default value is true.

Required: No

Type: Boolean

Encrypted

Indicates whether the volume is encrypted. Encrypted Amazon EBS volumes can only be attached to instance types that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. You cannot create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch the AMI on supported instance types. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

Required: No

Type: Boolean

Iops

The number of I/O operations per second (IOPS) that the volume supports. This can be an integer from 100 – 2000.

Required: Conditional Required when the volume type is io1; not used with other volume types.

Type: Number

SnapshotId

The snapshot ID of the volume to use to create a block device.

Required: Conditional If you specify both SnapshotId and VolumeSize, VolumeSize must be equal or greater than the size of the snapshot.

Type: String

VolumeSize

The volume size, in gibibytes (GiB). This can be a number from 1 – 1024. If the volume type is io1, the minimum value is 10.

Required: Conditional If you specify both SnapshotId and VolumeSize, VolumeSize must be equal or greater than the size of the snapshot.

Type: String

Update requires: Some interruptions

VolumeType

The volume type. You can specify standard, io1, or gp2. If you set the type to io1, you must also set the Iops property. For more information about these values and the default value, see CreateVolume in the Amazon Elastic Compute Cloud API Reference.

Required: No

Type: String

Example

{
   "DeviceName":"/dev/sdc",
   "Ebs":{
      "SnapshotId":"snap-xxxxxx",
      "VolumeSize":"50",
      "VolumeType":"io1",
      "Iops":"1000",
      "DeleteOnTermination":"false"
   }
}     

See Also

  • CreateVolume in the Amazon Elastic Compute Cloud API Reference