Skip to content

PoolInfo

Source code in docs_src/capo_storage_gateway/types/pool_info.py
class PoolInfo(TypedDict, closed=True):
    pool_arn: NotRequired["capo_storage_gateway.types.pool_arn.PoolARN"]
    """<p>The Amazon Resource Name (ARN) of the custom tape pool. Use the <a>ListTapePools</a> operation to return a list of custom tape pools for your account and Amazon Web Services Region.</p>"""
    pool_name: NotRequired["capo_storage_gateway.types.pool_name.PoolName"]
    r"""<p>The name of the custom tape pool. <code>PoolName</code> can use all ASCII characters, except '/' and '\'.</p>"""
    storage_class: NotRequired[
        "capo_storage_gateway.types.tape_storage_class.TapeStorageClass"
    ]
    """<p>The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.</p>"""
    retention_lock_type: NotRequired[
        "capo_storage_gateway.types.retention_lock_type.RetentionLockType"
    ]
    """<p>Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.</p>"""
    retention_lock_time_in_days: NotRequired[
        "capo_storage_gateway.types.retention_lock_time_in_days.RetentionLockTimeInDays"
    ]
    """<p>Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).</p>"""
    pool_status: NotRequired["capo_storage_gateway.types.pool_status.PoolStatus"]
    """<p>Status of the custom tape pool. Pool can be <code>ACTIVE</code> or <code>DELETED</code>.</p>"""

pool_arn instance-attribute

pool_arn: NotRequired[PoolARN]

The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and Amazon Web Services Region.

pool_name instance-attribute

pool_name: NotRequired[PoolName]

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

pool_status instance-attribute

pool_status: NotRequired[PoolStatus]

Status of the custom tape pool. Pool can be ACTIVE or DELETED.

retention_lock_time_in_days instance-attribute

retention_lock_time_in_days: NotRequired[RetentionLockTimeInDays]

Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

retention_lock_type instance-attribute

retention_lock_type: NotRequired[RetentionLockType]

Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

storage_class instance-attribute

storage_class: NotRequired[TapeStorageClass]

The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.