AWS CloudFormation
User Guide (Version )

AWS::EC2::Instance Ebs

Specifies a block device for an EBS volume.

Ebs is a property of the Amazon EC2 BlockDeviceMapping property.

Syntax

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

JSON

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

YAML

DeleteOnTermination: Boolean Encrypted: Boolean Iops: Integer KmsKeyId: String SnapshotId: String VolumeSize: Integer VolumeType: String

Properties

DeleteOnTermination

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.

Required: No

Type: Boolean

Update requires: No interruption

Encrypted

Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Required: No

Type: Boolean

Update requires: No interruption

Iops

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

Required: Conditional

Type: Integer

Update requires: No interruption

KmsKeyId

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

Required: No

Type: String

Update requires: Replacement

SnapshotId

The ID of the snapshot.

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

Required: Conditional

Type: String

Update requires: No interruption

VolumeSize

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Required: Conditional

Type: Integer

Update requires: No interruption

VolumeType

The volume type. If you set the type to io1, you must also specify the IOPS that the volume supports.

Default: gp2

Required: No

Type: String

Allowed Values: gp2 | io1 | sc1 | st1 | standard

Update requires: No interruption

Examples

Creating an EBS volume from a snapshot

This example creates a 50GB io1 EBS volume from a snapshot, and configures it to support 1000 IOPS and to persist after terminating the instance to which it is attached.

JSON

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

YAML

BlockDeviceMappings: - DeviceName: /dev/sdc Ebs: SnapshotId: snap-xxxxxxxx VolumeSize: 50 VolumeType: io1 Iops: 1000 DeleteOnTermination: false

See Also