Skip to content

Snapshot

Source code in docs_src/capo_redshift_serverless/types/snapshot.py
class Snapshot(TypedDict, closed=True):
    namespace_name: NotRequired["str"]
    """<p>The name of the namepsace.</p>"""
    namespace_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the namespace the snapshot was created from.</p>"""
    snapshot_name: NotRequired["str"]
    """<p>The name of the snapshot.</p>"""
    snapshot_create_time: NotRequired["datetime.datetime"]
    """<p>The timestamp of when the snapshot was created.</p>"""
    admin_username: NotRequired["str"]
    """<p>The username of the database within a snapshot.</p>"""
    status: NotRequired["capo_redshift_serverless.types.snapshot_status.SnapshotStatus"]
    """<p>The status of the snapshot.</p>"""
    kms_key_id: NotRequired["capo_redshift_serverless.types.kms_key_id.KmsKeyId"]
    """<p>The unique identifier of the KMS key used to encrypt the snapshot.</p>"""
    owner_account: NotRequired["str"]
    """<p>The owner Amazon Web Services; account of the snapshot.</p>"""
    total_backup_size_in_mega_bytes: NotRequired["float"]
    """<p>The total size, in megabytes, of how big the snapshot is.</p>"""
    actual_incremental_backup_size_in_mega_bytes: NotRequired["float"]
    """<p>The size of the incremental backup in megabytes.</p>"""
    backup_progress_in_mega_bytes: NotRequired["float"]
    """<p>The size in megabytes of the data that has been backed up to a snapshot.</p>"""
    current_backup_rate_in_mega_bytes_per_second: NotRequired["float"]
    """<p>The rate at which data is backed up into a snapshot in megabytes per second.</p>"""
    estimated_seconds_to_completion: NotRequired["int"]
    """<p>The estimated amount of seconds until the snapshot completes backup.</p>"""
    elapsed_time_in_seconds: NotRequired["int"]
    """<p>The amount of time it took to back up data into a snapshot.</p>"""
    snapshot_retention_period: NotRequired["int"]
    """<p>The period of time, in days, of how long the snapshot is retained.</p>"""
    snapshot_remaining_days: NotRequired["int"]
    """<p>The amount of days until the snapshot is deleted.</p>"""
    snapshot_retention_start_time: NotRequired["datetime.datetime"]
    """<p>The timestamp of when data within the snapshot started getting retained.</p>"""
    snapshot_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the snapshot.</p>"""
    accounts_with_restore_access: NotRequired[
        "capo_redshift_serverless.types.account_id_list.AccountIdList"
    ]
    """<p>All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.</p>"""
    accounts_with_provisioned_restore_access: NotRequired[
        "capo_redshift_serverless.types.account_id_list.AccountIdList"
    ]
    """<p>All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.</p>"""
    admin_password_secret_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.</p>"""
    admin_password_secret_kms_key_id: NotRequired[
        "capo_redshift_serverless.types.kms_key_id.KmsKeyId"
    ]
    """<p>The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.</p>"""

accounts_with_provisioned_restore_access instance-attribute

accounts_with_provisioned_restore_access: NotRequired[AccountIdList]

All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

accounts_with_restore_access instance-attribute

accounts_with_restore_access: NotRequired[AccountIdList]

All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

actual_incremental_backup_size_in_mega_bytes instance-attribute

actual_incremental_backup_size_in_mega_bytes: NotRequired[float]

The size of the incremental backup in megabytes.

admin_password_secret_arn instance-attribute

admin_password_secret_arn: NotRequired[str]

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

admin_password_secret_kms_key_id instance-attribute

admin_password_secret_kms_key_id: NotRequired[KmsKeyId]

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

admin_username instance-attribute

admin_username: NotRequired[str]

The username of the database within a snapshot.

backup_progress_in_mega_bytes instance-attribute

backup_progress_in_mega_bytes: NotRequired[float]

The size in megabytes of the data that has been backed up to a snapshot.

current_backup_rate_in_mega_bytes_per_second instance-attribute

current_backup_rate_in_mega_bytes_per_second: NotRequired[float]

The rate at which data is backed up into a snapshot in megabytes per second.

elapsed_time_in_seconds instance-attribute

elapsed_time_in_seconds: NotRequired[int]

The amount of time it took to back up data into a snapshot.

estimated_seconds_to_completion instance-attribute

estimated_seconds_to_completion: NotRequired[int]

The estimated amount of seconds until the snapshot completes backup.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The unique identifier of the KMS key used to encrypt the snapshot.

namespace_arn instance-attribute

namespace_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

namespace_name instance-attribute

namespace_name: NotRequired[str]

The name of the namepsace.

owner_account instance-attribute

owner_account: NotRequired[str]

The owner Amazon Web Services; account of the snapshot.

snapshot_arn instance-attribute

snapshot_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the snapshot.

snapshot_create_time instance-attribute

snapshot_create_time: NotRequired[datetime]

The timestamp of when the snapshot was created.

snapshot_name instance-attribute

snapshot_name: NotRequired[str]

The name of the snapshot.

snapshot_remaining_days instance-attribute

snapshot_remaining_days: NotRequired[int]

The amount of days until the snapshot is deleted.

snapshot_retention_period instance-attribute

snapshot_retention_period: NotRequired[int]

The period of time, in days, of how long the snapshot is retained.

snapshot_retention_start_time instance-attribute

snapshot_retention_start_time: NotRequired[datetime]

The timestamp of when data within the snapshot started getting retained.

status instance-attribute

status: NotRequired[SnapshotStatus]

The status of the snapshot.

total_backup_size_in_mega_bytes instance-attribute

total_backup_size_in_mega_bytes: NotRequired[float]

The total size, in megabytes, of how big the snapshot is.