/AWS1/CL_BDOEPHREBSVOLUMECONF

The shared Amazon EBS performance and encryption properties for a volume. These properties are common across the different volume configurations for a capacity provider.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_volumetype TYPE /AWS1/BDOEBSVOLUMETYPE /AWS1/BDOEBSVOLUMETYPE

The Amazon EBS volume type. If you do not specify a type, the default is gp3.

iv_iops TYPE /AWS1/BDOVOLUMEIOPS /AWS1/BDOVOLUMEIOPS

The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.

iv_throughput TYPE /AWS1/BDOVOLUMETHROUGHPUT /AWS1/BDOVOLUMETHROUGHPUT

The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.

iv_encrypted TYPE /AWS1/BDOBOOLEAN /AWS1/BDOBOOLEAN

Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.

iv_kmskeyid TYPE /AWS1/BDOKMSKEYID /AWS1/BDOKMSKEYID

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

iv_snapshotid TYPE /AWS1/BDOEBSSNAPSHOTID /AWS1/BDOEBSSNAPSHOTID

The ID of the snapshot.

iv_volumesize TYPE /AWS1/BDOVOLUMESIZEGIB /AWS1/BDOVOLUMESIZEGIB

The size of the volume, in GiB. You must specify either a snapshot ID or a volume size. Supported sizes: gp2, 1–16,384; gp3, 1–65,536; io1, 4–16,384; io2, 4–65,536.

iv_volumeinitializationrate TYPE /AWS1/BDOEBSVOLUMEINITRATE /AWS1/BDOEBSVOLUMEINITRATE

The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. Valid range: 100–300 MiB/s.

iv_ebscardindex TYPE /AWS1/BDOEBSCARDINDEX /AWS1/BDOEBSCARDINDEX

The index of the Amazon EBS card. Applies to instances with multiple Amazon EBS cards.

---

Queryable Attributes

volumeType

The Amazon EBS volume type. If you do not specify a type, the default is gp3.

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

iops

The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.

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 to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.

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

encrypted

Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot 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

kmsKeyId

The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon 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 GiB. You must specify either a snapshot ID or a volume size. Supported sizes: gp2, 1–16,384; gp3, 1–65,536; io1, 4–16,384; io2, 4–65,536.

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

volumeInitializationRate

The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. Valid range: 100–300 MiB/s.

Accessible with the following methods

Method	Description
GET_VOLUMEINITIALIZATIONRATE()	Getter for VOLUMEINITIALIZATIONRATE, with configurable defau
ASK_VOLUMEINITIALIZATIONRATE()	Getter for VOLUMEINITIALIZATIONRATE w/ exceptions if field h
HAS_VOLUMEINITIALIZATIONRATE()	Determine if VOLUMEINITIALIZATIONRATE has a value

ebsCardIndex

The index of the Amazon EBS card. Applies to instances with multiple Amazon EBS cards.

Accessible with the following methods

Method	Description
GET_EBSCARDINDEX()	Getter for EBSCARDINDEX, with configurable default
ASK_EBSCARDINDEX()	Getter for EBSCARDINDEX w/ exceptions if field has no value
HAS_EBSCARDINDEX()	Determine if EBSCARDINDEX has a value