/AWS1/CL_EC2VOLUME¶
Describes a volume.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_availabilityzoneid TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The ID of the Availability Zone for the volume.
iv_outpostarn TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The Amazon Resource Name (ARN) of the Outpost.
iv_sourcevolumeid TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The ID of the source volume from which the volume copy was created. Only for volume copies.
iv_iops TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
The number of I/O operations per second (IOPS). For
gp3,io1, andio2volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
it_tags TYPE /AWS1/CL_EC2TAG=>TT_TAGLIST TT_TAGLIST¶
Any tags assigned to the volume.
iv_volumetype TYPE /AWS1/EC2VOLUMETYPE /AWS1/EC2VOLUMETYPE¶
The volume type.
iv_fastrestored TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.
iv_multiattachenabled TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
Indicates whether Amazon EBS Multi-Attach is enabled.
iv_throughput TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
The throughput that the volume supports, in MiB/s.
iv_ssetype TYPE /AWS1/EC2SSETYPE /AWS1/EC2SSETYPE¶
This parameter is not returned by CreateVolume.
Reserved for future use.
io_operator TYPE REF TO /AWS1/CL_EC2OPERATORRESPONSE /AWS1/CL_EC2OPERATORRESPONSE¶
The service provider that manages the volume.
iv_volumeinitializationrate TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is
null.
iv_volumeid TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The ID of the volume.
iv_size TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
The size of the volume, in GiBs.
iv_snapshotid TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The snapshot from which the volume was created, if applicable.
iv_availabilityzone TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The Availability Zone for the volume.
iv_state TYPE /AWS1/EC2VOLUMESTATE /AWS1/EC2VOLUMESTATE¶
The volume state.
iv_createtime TYPE /AWS1/EC2DATETIME /AWS1/EC2DATETIME¶
The time stamp when volume creation was initiated.
it_attachments TYPE /AWS1/CL_EC2VOLUMEATTACHMENT=>TT_VOLUMEATTACHMENTLIST TT_VOLUMEATTACHMENTLIST¶
This parameter is not returned by CreateVolume.
Information about the volume attachments.
iv_encrypted TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
Indicates whether the volume is encrypted.
iv_kmskeyid TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
Queryable Attributes¶
AvailabilityZoneId¶
The ID of the Availability Zone for the volume.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AVAILABILITYZONEID() |
Getter for AVAILABILITYZONEID, with configurable default |
ASK_AVAILABILITYZONEID() |
Getter for AVAILABILITYZONEID w/ exceptions if field has no |
HAS_AVAILABILITYZONEID() |
Determine if AVAILABILITYZONEID has a value |
OutpostArn¶
The Amazon Resource Name (ARN) of the Outpost.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OUTPOSTARN() |
Getter for OUTPOSTARN, with configurable default |
ASK_OUTPOSTARN() |
Getter for OUTPOSTARN w/ exceptions if field has no value |
HAS_OUTPOSTARN() |
Determine if OUTPOSTARN has a value |
SourceVolumeId¶
The ID of the source volume from which the volume copy was created. Only for volume copies.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCEVOLUMEID() |
Getter for SOURCEVOLUMEID, with configurable default |
ASK_SOURCEVOLUMEID() |
Getter for SOURCEVOLUMEID w/ exceptions if field has no valu |
HAS_SOURCEVOLUMEID() |
Determine if SOURCEVOLUMEID has a value |
Iops¶
The number of I/O operations per second (IOPS). For
gp3,io1, andio2volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
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 |
Tags¶
Any tags assigned to the volume.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
VolumeType¶
The volume type.
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 |
FastRestored¶
This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FASTRESTORED() |
Getter for FASTRESTORED, with configurable default |
ASK_FASTRESTORED() |
Getter for FASTRESTORED w/ exceptions if field has no value |
HAS_FASTRESTORED() |
Determine if FASTRESTORED has a value |
MultiAttachEnabled¶
Indicates whether Amazon EBS Multi-Attach is enabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MULTIATTACHENABLED() |
Getter for MULTIATTACHENABLED, with configurable default |
ASK_MULTIATTACHENABLED() |
Getter for MULTIATTACHENABLED w/ exceptions if field has no |
HAS_MULTIATTACHENABLED() |
Determine if MULTIATTACHENABLED has a value |
Throughput¶
The throughput that the volume supports, in 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 |
SseType¶
This parameter is not returned by CreateVolume.
Reserved for future use.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SSETYPE() |
Getter for SSETYPE, with configurable default |
ASK_SSETYPE() |
Getter for SSETYPE w/ exceptions if field has no value |
HAS_SSETYPE() |
Determine if SSETYPE has a value |
Operator¶
The service provider that manages the volume.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OPERATOR() |
Getter for OPERATOR |
VolumeInitializationRate¶
The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is
null.
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 |
VolumeId¶
The ID of the volume.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VOLUMEID() |
Getter for VOLUMEID, with configurable default |
ASK_VOLUMEID() |
Getter for VOLUMEID w/ exceptions if field has no value |
HAS_VOLUMEID() |
Determine if VOLUMEID has a value |
Size¶
The size of the volume, in GiBs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SIZE() |
Getter for SIZE, with configurable default |
ASK_SIZE() |
Getter for SIZE w/ exceptions if field has no value |
HAS_SIZE() |
Determine if SIZE has a value |
SnapshotId¶
The snapshot from which the volume was created, if applicable.
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 |
AvailabilityZone¶
The Availability Zone for the volume.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE, with configurable default |
ASK_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE w/ exceptions if field has no va |
HAS_AVAILABILITYZONE() |
Determine if AVAILABILITYZONE has a value |
State¶
The volume state.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
CreateTime¶
The time stamp when volume creation was initiated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATETIME() |
Getter for CREATETIME, with configurable default |
ASK_CREATETIME() |
Getter for CREATETIME w/ exceptions if field has no value |
HAS_CREATETIME() |
Determine if CREATETIME has a value |
Attachments¶
This parameter is not returned by CreateVolume.
Information about the volume attachments.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ATTACHMENTS() |
Getter for ATTACHMENTS, with configurable default |
ASK_ATTACHMENTS() |
Getter for ATTACHMENTS w/ exceptions if field has no value |
HAS_ATTACHMENTS() |
Determine if ATTACHMENTS has a value |
Encrypted¶
Indicates whether the volume is encrypted.
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 Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
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 |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_VOLUMELIST¶
TYPES TT_VOLUMELIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_EC2VOLUME WITH DEFAULT KEY
.