View a markdown version of this page

AWS::ImageBuilder::ImageRecipe EbsInstanceBlockDeviceSpecification - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ImageBuilder::ImageRecipe EbsInstanceBlockDeviceSpecification

Amazon EBS-specific block device mapping specifications.

Syntax

To declare this entity in your 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

Specifies whether to delete the associated device on termination.

Required: No

Type: Boolean

Update requires: Replacement

Encrypted

Specifies whether to encrypt the device.

Required: No

Type: Boolean

Update requires: Replacement

Iops

The IOPS value for the device. Required only when volumeType is io1 or io2.

Required: No

Type: Integer

Minimum: 100

Maximum: 64000

Update requires: Replacement

KmsKeyId

The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

SnapshotId

The snapshot that defines the device contents.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Throughput

For GP3 volumes only – The throughput in MiB/s that the volume supports.

Required: No

Type: Integer

Minimum: 125

Maximum: 1000

Update requires: Replacement

VolumeSize

Overrides the volume size for the device.

Required: No

Type: Integer

Minimum: 1

Maximum: 16000

Update requires: Replacement

VolumeType

Overrides the volume type for the device.

Required: No

Type: String

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

Update requires: Replacement