Skip to content

/AWS1/CL_EC2LAUNCHTMPLEBSBLK00

The parameters for a block device for an EBS volume.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_ENCRYPTED TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

IV_DELETEONTERMINATION TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Indicates whether the EBS volume is deleted on instance termination.

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 supported for io1, io2, and gp3 volumes only.

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.

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. The following are the supported volumes 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.

IV_THROUGHPUT TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

Queryable Attributes

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.

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.

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 supported for io1, io2, and gp3 volumes only.

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

KmsKeyId

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.

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. The following are the supported volumes 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

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.

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