Skip to content

Backup

Source code in docs_src/capo_fsx/types/backup.py
class Backup(TypedDict, closed=True):
    backup_id: NotRequired["capo_fsx.types.backup_id.BackupId"]
    """<p>The ID of the backup.</p>"""
    lifecycle: NotRequired["capo_fsx.types.backup_lifecycle.BackupLifecycle"]
    """<p>The lifecycle status of the backup.</p> <ul> <li> <p> <code>AVAILABLE</code> - The backup is fully available.</p> </li> <li> <p> <code>PENDING</code> - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.</p> </li> <li> <p> <code>CREATING</code> - Amazon FSx is creating the backup.</p> </li> <li> <p> <code>TRANSFERRING</code> - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.</p> </li> <li> <p> <code>COPYING</code> - Amazon FSx is copying the backup.</p> </li> <li> <p> <code>DELETED</code> - Amazon FSx deleted the backup and it's no longer available.</p> </li> <li> <p> <code>FAILED</code> - Amazon FSx couldn't finish the backup.</p> </li> </ul>"""
    failure_details: NotRequired[
        "capo_fsx.types.backup_failure_details.BackupFailureDetails"
    ]
    """<p>Details explaining any failures that occurred when creating a backup.</p>"""
    type: NotRequired["capo_fsx.types.backup_type.BackupType"]
    """<p>The type of the file-system backup.</p>"""
    progress_percent: NotRequired["capo_fsx.types.progress_percent.ProgressPercent"]
    creation_time: NotRequired["capo_fsx.types.creation_time.CreationTime"]
    """<p>The time when a particular backup was created.</p>"""
    kms_key_id: NotRequired["capo_fsx.types.kms_key_id.KmsKeyId"]
    """<p>The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest. </p>"""
    resource_arn: NotRequired["capo_fsx.types.resource_arn.ResourceARN"]
    """<p>The Amazon Resource Name (ARN) for the backup resource.</p>"""
    tags: NotRequired["capo_fsx.types.tags.Tags"]
    """<p>The tags associated with a particular file system.</p>"""
    file_system: NotRequired["capo_fsx.types.file_system.FileSystem"]
    """<p>The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.</p>"""
    directory_information: NotRequired[
        "capo_fsx.types.active_directory_backup_attributes.ActiveDirectoryBackupAttributes"
    ]
    """<p>The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.</p>"""
    owner_id: NotRequired["capo_fsx.types.aws_account_id.AWSAccountId"]
    source_backup_id: NotRequired["capo_fsx.types.backup_id.BackupId"]
    source_backup_region: NotRequired["capo_fsx.types.region.Region"]
    """<p>The source Region of the backup. Specifies the Region from where this backup is copied.</p>"""
    resource_type: NotRequired["capo_fsx.types.resource_type.ResourceType"]
    """<p>Specifies the resource type that's backed up.</p>"""
    volume: NotRequired["capo_fsx.types.volume.Volume"]
    size_in_bytes: NotRequired["capo_fsx.types.size_in_bytes.SizeInBytes"]
    """<p> The size of the backup in bytes. This represents the amount of data that the file system would contain if you restore this backup. </p>"""

backup_id instance-attribute

backup_id: NotRequired[BackupId]

The ID of the backup.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

The time when a particular backup was created.

directory_information instance-attribute

directory_information: NotRequired[ActiveDirectoryBackupAttributes]

The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

failure_details instance-attribute

failure_details: NotRequired[BackupFailureDetails]

Details explaining any failures that occurred when creating a backup.

file_system instance-attribute

file_system: NotRequired[FileSystem]

The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

lifecycle instance-attribute

lifecycle: NotRequired[BackupLifecycle]

The lifecycle status of the backup.

  • AVAILABLE - The backup is fully available.

  • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.

  • CREATING - Amazon FSx is creating the backup.

  • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.

  • COPYING - Amazon FSx is copying the backup.

  • DELETED - Amazon FSx deleted the backup and it's no longer available.

  • FAILED - Amazon FSx couldn't finish the backup.

owner_id instance-attribute

owner_id: NotRequired[AWSAccountId]

progress_percent instance-attribute

progress_percent: NotRequired[ProgressPercent]

resource_arn instance-attribute

resource_arn: NotRequired[ResourceARN]

The Amazon Resource Name (ARN) for the backup resource.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

Specifies the resource type that's backed up.

size_in_bytes instance-attribute

size_in_bytes: NotRequired[SizeInBytes]

The size of the backup in bytes. This represents the amount of data that the file system would contain if you restore this backup.

source_backup_id instance-attribute

source_backup_id: NotRequired[BackupId]

source_backup_region instance-attribute

source_backup_region: NotRequired[Region]

The source Region of the backup. Specifies the Region from where this backup is copied.

tags instance-attribute

tags: NotRequired[Tags]

The tags associated with a particular file system.

type instance-attribute

type: NotRequired[BackupType]

The type of the file-system backup.

volume instance-attribute

volume: NotRequired[Volume]