Skip to content

BackupSummary

Source code in docs_src/capo_dynamodb/types/backup_summary.py
class BackupSummary(TypedDict, closed=True):
    table_name: NotRequired["capo_dynamodb.types.table_name.TableName"]
    """<p>Name of the table.</p>"""
    table_id: NotRequired["capo_dynamodb.types.table_id.TableId"]
    """<p>Unique identifier for the table.</p>"""
    table_arn: NotRequired["capo_dynamodb.types.table_arn.TableArn"]
    """<p>ARN associated with the table.</p>"""
    backup_arn: NotRequired["capo_dynamodb.types.backup_arn.BackupArn"]
    """<p>ARN associated with the backup.</p>"""
    backup_name: NotRequired["capo_dynamodb.types.backup_name.BackupName"]
    """<p>Name of the specified backup.</p>"""
    backup_creation_date_time: NotRequired[
        "capo_dynamodb.types.backup_creation_date_time.BackupCreationDateTime"
    ]
    """<p>Time at which the backup was created.</p>"""
    backup_expiry_date_time: NotRequired["capo_dynamodb.types.date.Date"]
    """<p>Time at which the automatic on-demand backup created by DynamoDB will expire. This <code>SYSTEM</code> on-demand backup expires automatically 35 days after its creation.</p>"""
    backup_status: NotRequired["capo_dynamodb.types.backup_status.BackupStatus"]
    """<p>Backup can be in one of the following states: CREATING, ACTIVE, DELETED.</p>"""
    backup_type: NotRequired["capo_dynamodb.types.backup_type.BackupType"]
    """<p>BackupType:</p> <ul> <li> <p> <code>USER</code> - You create and manage these using the on-demand backup feature.</p> </li> <li> <p> <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled, a <code>SYSTEM</code> backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. </p> </li> <li> <p> <code>AWS_BACKUP</code> - On-demand backup created by you from Backup service.</p> </li> </ul>"""
    backup_size_bytes: NotRequired[
        "capo_dynamodb.types.backup_size_bytes.BackupSizeBytes"
    ]
    """<p>Size of the backup in bytes.</p>"""

backup_arn instance-attribute

backup_arn: NotRequired[BackupArn]

ARN associated with the backup.

backup_creation_date_time instance-attribute

backup_creation_date_time: NotRequired[BackupCreationDateTime]

Time at which the backup was created.

backup_expiry_date_time instance-attribute

backup_expiry_date_time: NotRequired[Date]

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

backup_name instance-attribute

backup_name: NotRequired[BackupName]

Name of the specified backup.

backup_size_bytes instance-attribute

backup_size_bytes: NotRequired[BackupSizeBytes]

Size of the backup in bytes.

backup_status instance-attribute

backup_status: NotRequired[BackupStatus]

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

backup_type instance-attribute

backup_type: NotRequired[BackupType]

BackupType:

  • USER - You create and manage these using the on-demand backup feature.

  • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

  • AWS_BACKUP - On-demand backup created by you from Backup service.

table_arn instance-attribute

table_arn: NotRequired[TableArn]

ARN associated with the table.

table_id instance-attribute

table_id: NotRequired[TableId]

Unique identifier for the table.

table_name instance-attribute

table_name: NotRequired[TableName]

Name of the table.