EbsBlockDevice
Describes a block device for an EBS volume.
Contents
- DeleteOnTermination (request), deleteOnTermination (response)
-
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.
Type: Boolean
Required: No
- Encrypted (request), encrypted (response)
-
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 EBS 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.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
-
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either
true
for an encrypted volume, orfalse
for an unencrypted volume. If you omit this parameter, it defaults tofalse
(unencrypted). -
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
-
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify
false
. If you specifytrue
, the request will fail. In this case, we recommend that you omit the parameter. -
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either
true
orfalse
. However, if you specifyfalse
, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Type: Boolean
Required: No
-
- Iops (request), iops (response)
-
The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
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
andio2
volumes. The default forgp3
volumes is 3,000 IOPS.Type: Integer
Required: No
-
- KmsKeyId (request), kmsKeyId (response)
-
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
This parameter is only supported on
BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.Type: String
Required: No
- OutpostArn (request), outpostArn (response)
-
The ARN of the Outpost on which the snapshot is stored.
This parameter is not supported when using CreateImage.
Type: String
Required: No
- SnapshotId (request), snapshotId (response)
-
The ID of the snapshot.
Type: String
Required: No
- Throughput (request), throughput (response)
-
The throughput that the volume supports, in MiB/s.
This parameter is valid only for
gp3
volumes.Valid Range: Minimum value of 125. Maximum value of 1000.
Type: Integer
Required: No
- VolumeSize (request), volumeSize (response)
-
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
andgp3
: 1 - 16,384 GiB -
io1
: 4 - 16,384 GiB -
io2
: 4 - 65,536 GiB -
st1
andsc1
: 125 - 16,384 GiB -
standard
: 1 - 1024 GiB
Type: Integer
Required: No
-
- VolumeType (request), volumeType (response)
-
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
Type: String
Valid Values:
standard | io1 | io2 | gp2 | sc1 | st1 | gp3
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: