AWS::EC2::SpotFleet EbsBlockDevice - AWS CloudFormation
SyntaxProperties

AWS::EC2::SpotFleet EbsBlockDevice

Describes a block device for an EBS volume.

Syntax

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

JSON

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

YAML

  DeleteOnTermination: Boolean
  Encrypted: Boolean
  Iops: Integer
  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 EC2 User Guide.

Required: No

Type: Boolean

Update requires: Replacement

Encrypted

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS Encryption in the Amazon EC2 User Guide.

In no case can you remove encryption from an encrypted volume.

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

This parameter is not returned by DescribeImageAttribute.

Required: No

Type: Boolean

Update requires: Replacement

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 required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.

Required: Conditional

Type: Integer

Update requires: Replacement

SnapshotId

The ID of the snapshot.

Required: Conditional

Type: String

Update requires: Replacement

VolumeSize

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

The following are the supported 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: Conditional

Type: Integer

Update requires: Replacement

VolumeType

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

Required: No

Type: String

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

Update requires: Replacement