Skip to content

AdditionalStorageVolumeOutput

Source code in docs_src/capo_rds/types/additional_storage_volume_output.py
class AdditionalStorageVolumeOutput(TypedDict, closed=True):
    volume_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the additional storage volume.</p>"""
    storage_volume_status: NotRequired["capo_rds.types.string.String"]
    """<p>The status of the additional storage volume.</p> <p>Valid Values: <code>ACTIVE | CREATING | DELETING | MODIFYING | NOT-IN-USE | STORAGE-OPTIMIZATION | VOLUME-FULL</code> </p>"""
    storage_operation_status: NotRequired["capo_rds.types.string.String"]
    """<p>The status of an in-progress storage operation on the additional storage volume. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active. Possible values:</p> <ul> <li> <p> <code>Initializing</code> - The volume is initializing from a snapshot, such as during a snapshot restore, point-in-time restore, read replica creation, or blue/green deployment. Performance can be lower than provisioned until initialization completes.</p> </li> <li> <p> <code>Optimizing</code> - The volume is optimizing following a storage scaling or modification operation.</p> </li> </ul>"""
    storage_operation_percent_progress: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>The percentage of the in-progress storage operation on the additional storage volume that has completed, from <code>0</code> to <code>100</code>. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active.</p>"""
    allocated_storage: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).</p>"""
    iops: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The number of I/O operations per second (IOPS) provisioned for the additional storage volume.</p>"""
    max_allocated_storage: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.</p>"""
    storage_throughput: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).</p>"""
    storage_type: NotRequired["capo_rds.types.string.String"]
    """<p>The storage type for the additional storage volume.</p> <p>Valid Values: <code>GP3 | IO2</code> </p>"""

allocated_storage instance-attribute

allocated_storage: NotRequired[Integer]

The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).

iops instance-attribute

iops: NotRequired[IntegerOptional]

The number of I/O operations per second (IOPS) provisioned for the additional storage volume.

max_allocated_storage instance-attribute

max_allocated_storage: NotRequired[IntegerOptional]

The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.

storage_operation_percent_progress instance-attribute

storage_operation_percent_progress: NotRequired[IntegerOptional]

The percentage of the in-progress storage operation on the additional storage volume that has completed, from 0 to 100. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active.

storage_operation_status instance-attribute

storage_operation_status: NotRequired[String]

The status of an in-progress storage operation on the additional storage volume. This field appears only while a storage operation is in progress. It isn't present when no storage operation is active. Possible values:

  • Initializing - The volume is initializing from a snapshot, such as during a snapshot restore, point-in-time restore, read replica creation, or blue/green deployment. Performance can be lower than provisioned until initialization completes.

  • Optimizing - The volume is optimizing following a storage scaling or modification operation.

storage_throughput instance-attribute

storage_throughput: NotRequired[IntegerOptional]

The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).

storage_type instance-attribute

storage_type: NotRequired[String]

The storage type for the additional storage volume.

Valid Values: GP3 | IO2

storage_volume_status instance-attribute

storage_volume_status: NotRequired[String]

The status of the additional storage volume.

Valid Values: ACTIVE | CREATING | DELETING | MODIFYING | NOT-IN-USE | STORAGE-OPTIMIZATION | VOLUME-FULL

volume_name instance-attribute

volume_name: NotRequired[String]

The name of the additional storage volume.