AWS::EC2::LaunchTemplate Ebs - AWS CloudFormation
SyntaxPropertiesSee also

AWS::EC2::LaunchTemplate Ebs

Parameters for a block device for an EBS volume in an Amazon EC2 launch template.

Ebs is a property of AWS::EC2::LaunchTemplate BlockDeviceMapping.

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,
  "Throughput" : Integer,
  "VolumeSize" : Integer,
  "VolumeType" : String
}

YAML

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

Properties

DeleteOnTermination

Indicates whether the EBS volume is deleted on instance termination.

Required: No

Type: Boolean

Update requires: No interruption

Encrypted

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Required: No

Type: Boolean

Update requires: No interruption

Iops

The number of I/O operations per second (IOPS). For gp3, io1, and io2 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

  • io2: 100 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

This parameter is supported for io1, io2, and gp3 volumes only.

Required: No

Type: Integer

Update requires: No interruption

KmsKeyId

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.

Required: No

Type: String

Update requires: No interruption

SnapshotId

The ID of the snapshot.

Required: No

Type: String

Update requires: No interruption

Throughput

The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

Valid Range: Minimum value of 125. Maximum value of 1000.

Required: No

Type: Integer

Update requires: No interruption

VolumeSize

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1 - 16,384 GiB

  • io1: 4 - 16,384 GiB

  • io2: 4 - 65,536 GiB

  • st1 and sc1: 125 - 16,384 GiB

  • standard: 1 - 1024 GiB

Required: No

Type: Integer

Update requires: No interruption

VolumeType

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

Required: No

Type: String

Allowed values: standard | io1 | io2 | gp2 | sc1 | st1 | gp3

Update requires: No interruption

See also