Skip to content

/AWS1/CL_EC2FLEETEBSBLKDEVREQ

Describes a block device for an EBS volume.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_encrypted TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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, or false for an unencrypted volume. If you omit this parameter, it defaults to false (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 specify true, 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 or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.

iv_deleteontermination TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserve data when an instance is terminated in the Amazon EC2 User Guide.

iv_iops TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

iv_throughput TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

iv_kmskeyid TYPE /AWS1/EC2KMSKEYID /AWS1/EC2KMSKEYID

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 CreateFleet, RequestSpotInstances, and RunInstances.

iv_snapshotid TYPE /AWS1/EC2SNAPSHOTID /AWS1/EC2SNAPSHOTID

The ID of the snapshot.

iv_volumesize TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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

iv_volumetype TYPE /AWS1/EC2VOLUMETYPE /AWS1/EC2VOLUMETYPE

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

Queryable Attributes

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 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, or false for an unencrypted volume. If you omit this parameter, it defaults to false (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 specify true, 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 or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.

Accessible with the following methods

Method Description
GET_ENCRYPTED() Getter for ENCRYPTED, with configurable default
ASK_ENCRYPTED() Getter for ENCRYPTED w/ exceptions if field has no value
HAS_ENCRYPTED() Determine if ENCRYPTED has a value

DeleteOnTermination

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserve data when an instance is terminated in the Amazon EC2 User Guide.

Accessible with the following methods

Method Description
GET_DELETEONTERMINATION() Getter for DELETEONTERMINATION, with configurable default
ASK_DELETEONTERMINATION() Getter for DELETEONTERMINATION w/ exceptions if field has no
HAS_DELETEONTERMINATION() Determine if DELETEONTERMINATION has a value

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.

Accessible with the following methods

Method Description
GET_IOPS() Getter for IOPS, with configurable default
ASK_IOPS() Getter for IOPS w/ exceptions if field has no value
HAS_IOPS() Determine if IOPS has a value

Throughput

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.

Accessible with the following methods

Method Description
GET_THROUGHPUT() Getter for THROUGHPUT, with configurable default
ASK_THROUGHPUT() Getter for THROUGHPUT w/ exceptions if field has no value
HAS_THROUGHPUT() Determine if THROUGHPUT has a value

KmsKeyId

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 CreateFleet, RequestSpotInstances, and RunInstances.

Accessible with the following methods

Method Description
GET_KMSKEYID() Getter for KMSKEYID, with configurable default
ASK_KMSKEYID() Getter for KMSKEYID w/ exceptions if field has no value
HAS_KMSKEYID() Determine if KMSKEYID has a value

SnapshotId

The ID of the snapshot.

Accessible with the following methods

Method Description
GET_SNAPSHOTID() Getter for SNAPSHOTID, with configurable default
ASK_SNAPSHOTID() Getter for SNAPSHOTID w/ exceptions if field has no value
HAS_SNAPSHOTID() Determine if SNAPSHOTID has a value

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

Accessible with the following methods

Method Description
GET_VOLUMESIZE() Getter for VOLUMESIZE, with configurable default
ASK_VOLUMESIZE() Getter for VOLUMESIZE w/ exceptions if field has no value
HAS_VOLUMESIZE() Determine if VOLUMESIZE has a value

VolumeType

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

Accessible with the following methods

Method Description
GET_VOLUMETYPE() Getter for VOLUMETYPE, with configurable default
ASK_VOLUMETYPE() Getter for VOLUMETYPE w/ exceptions if field has no value
HAS_VOLUMETYPE() Determine if VOLUMETYPE has a value