Skip to content

Snapshot

Source code in docs_src/capo_fsx/types/snapshot.py
class Snapshot(TypedDict, closed=True):
    resource_arn: NotRequired["capo_fsx.types.resource_arn.ResourceARN"]
    snapshot_id: NotRequired["capo_fsx.types.snapshot_id.SnapshotId"]
    """<p>The ID of the snapshot.</p>"""
    name: NotRequired["capo_fsx.types.snapshot_name.SnapshotName"]
    """<p>The name of the snapshot.</p>"""
    volume_id: NotRequired["capo_fsx.types.volume_id.VolumeId"]
    """<p>The ID of the volume that the snapshot is of.</p>"""
    creation_time: NotRequired["capo_fsx.types.creation_time.CreationTime"]
    lifecycle: NotRequired["capo_fsx.types.snapshot_lifecycle.SnapshotLifecycle"]
    """<p>The lifecycle status of the snapshot.</p> <ul> <li> <p> <code>PENDING</code> - Amazon FSx hasn't started creating the snapshot.</p> </li> <li> <p> <code>CREATING</code> - Amazon FSx is creating the snapshot.</p> </li> <li> <p> <code>DELETING</code> - Amazon FSx is deleting the snapshot.</p> </li> <li> <p> <code>AVAILABLE</code> - The snapshot is fully available.</p> </li> </ul>"""
    lifecycle_transition_reason: NotRequired[
        "capo_fsx.types.lifecycle_transition_reason.LifecycleTransitionReason"
    ]
    tags: NotRequired["capo_fsx.types.tags.Tags"]
    administrative_actions: NotRequired[
        "capo_fsx.types.administrative_actions.AdministrativeActions"
    ]
    """<p>A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.</p>"""

administrative_actions instance-attribute

administrative_actions: NotRequired[AdministrativeActions]

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

lifecycle instance-attribute

lifecycle: NotRequired[SnapshotLifecycle]

The lifecycle status of the snapshot.

  • PENDING - Amazon FSx hasn't started creating the snapshot.

  • CREATING - Amazon FSx is creating the snapshot.

  • DELETING - Amazon FSx is deleting the snapshot.

  • AVAILABLE - The snapshot is fully available.

lifecycle_transition_reason instance-attribute

lifecycle_transition_reason: NotRequired[LifecycleTransitionReason]

name instance-attribute

name: NotRequired[SnapshotName]

The name of the snapshot.

resource_arn instance-attribute

resource_arn: NotRequired[ResourceARN]

snapshot_id instance-attribute

snapshot_id: NotRequired[SnapshotId]

The ID of the snapshot.

tags instance-attribute

tags: NotRequired[Tags]

volume_id instance-attribute

volume_id: NotRequired[VolumeId]

The ID of the volume that the snapshot is of.