LaunchTemplateEbsBlockDeviceRequest
The parameters for a block device for an EBS volume.
Contents
- DeleteOnTermination
-
Indicates whether the EBS volume is deleted on instance termination.
Type: Boolean
Required: No
- 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.
Type: Boolean
Required: No
- Iops
-
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 supported for
io1
,io2
, andgp3
volumes only.Type: Integer
Required: No
-
- KmsKeyId
-
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
Type: String
Required: No
- SnapshotId
-
The ID of the snapshot.
Type: String
Required: No
- 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.
Type: Integer
Required: No
- 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
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
-
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: