AWS::AutoScaling::LaunchConfiguration BlockDevice - Amazon CloudFormation
SyntaxPropertiesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::AutoScaling::LaunchConfiguration BlockDevice

BlockDevice is a property of the EBS property of the AWS::AutoScaling::LaunchConfiguration BlockDeviceMapping property type that describes an Amazon EBS volume.

Syntax

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

JSON

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

YAML

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

Properties

DeleteOnTermination

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Required: No

Type: Boolean

Update requires: Replacement

Encrypted

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Requirements for Amazon EBS encryption in the Amazon EBS User Guide. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

Note

If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.

If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.

For more information, see Use Amazon KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.

Required: No

Type: Boolean

Update requires: Replacement

Iops

The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and 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.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

Required: Conditional

Type: Integer

Update requires: Replacement

SnapshotId

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Required: Conditional

Type: String

Update requires: Replacement

Throughput

The throughput (MiBps) to provision for a gp3 volume.

Required: No

Type: Integer

Minimum: 125

Maximum: 1000

Update requires: Replacement

VolumeSize

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

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

Required: Conditional

Type: Integer

Minimum: 1

Maximum: 16384

Update requires: Replacement

VolumeType

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

Required: No

Type: String

Update requires: Replacement

See also