/AWS1/CL_BDOEBSVOLUMECONF

The configuration for an Amazon EBS-backed persistent volume. The service creates persistent volumes when a session first launches, and the volumes survive instance termination. The volumes persist until you delete the session.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/BDOVOLUMENAME /AWS1/BDOVOLUMENAME

The logical name of the volume. Use this name to reference the volume when you mount it into an agent runtime.

iv_sizegib TYPE /AWS1/BDOVOLUMESIZEGIB /AWS1/BDOVOLUMESIZEGIB

The size of the volume, in GiB.

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

iv_throughput TYPE /AWS1/BDOVOLUMETHROUGHPUT /AWS1/BDOVOLUMETHROUGHPUT

The throughput, in MiB/s. Valid only for gp3 volumes.

iv_encrypted TYPE /AWS1/BDOBOOLEAN /AWS1/BDOBOOLEAN

Specifies whether to encrypt the volume. If true, the service encrypts the volume with the KMS key that you specify in kmsKeyId, or the default KMS key for Amazon EBS if you do not specify one. The default is true.

iv_kmskeyid TYPE /AWS1/BDOKMSKEYID /AWS1/BDOKMSKEYID

The identifier of the KMS key to use for encryption.

iv_snapshotid TYPE /AWS1/BDOEBSSNAPSHOTID /AWS1/BDOEBSSNAPSHOTID

An optional Amazon EBS snapshot ID. If provided, the volume is initialized from this snapshot the first time it is created. On subsequent restarts, the existing volume is used and the snapshot is ignored.

---

Queryable Attributes

name

The logical name of the volume. Use this name to reference the volume when you mount it into an agent runtime.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

sizeGiB

The size of the volume, in GiB.

Accessible with the following methods

Method	Description
GET_SIZEGIB()	Getter for SIZEGIB, with configurable default
ASK_SIZEGIB()	Getter for SIZEGIB w/ exceptions if field has no value
HAS_SIZEGIB()	Determine if SIZEGIB has a value

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

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, in MiB/s. Valid only for gp3 volumes.

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. If true, the service encrypts the volume with the KMS key that you specify in kmsKeyId, or the default KMS key for Amazon EBS if you do not specify one. The default is true.

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 of the KMS key to use for 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

An optional Amazon EBS snapshot ID. If provided, the volume is initialized from this snapshot the first time it is created. On subsequent restarts, the existing volume is used and the snapshot is ignored.

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