Skip to content

Backup

Source code in docs_src/capo_cloudhsm_v2/types/backup.py
class Backup(TypedDict, closed=True):
    backup_id: "capo_cloudhsm_v2.types.backup_id.BackupId"
    """<p>The identifier (ID) of the backup.</p>"""
    backup_arn: NotRequired["capo_cloudhsm_v2.types.backup_arn.BackupArn"]
    """<p>The Amazon Resource Name (ARN) of the backup.</p>"""
    backup_state: NotRequired["capo_cloudhsm_v2.types.backup_state.BackupState"]
    """<p>The state of the backup.</p>"""
    cluster_id: NotRequired["capo_cloudhsm_v2.types.cluster_id.ClusterId"]
    """<p>The identifier (ID) of the cluster that was backed up.</p>"""
    create_timestamp: NotRequired["capo_cloudhsm_v2.types.timestamp.Timestamp"]
    """<p>The date and time when the backup was created.</p>"""
    copy_timestamp: NotRequired["capo_cloudhsm_v2.types.timestamp.Timestamp"]
    """<p>The date and time when the backup was copied from a source backup.</p>"""
    never_expires: NotRequired["capo_cloudhsm_v2.types.boolean.Boolean"]
    """<p>Specifies whether the service should exempt a backup from the retention policy for the cluster. <code>True</code> exempts a backup from the retention policy. <code>False</code> means the service applies the backup retention policy defined at the cluster.</p>"""
    source_region: NotRequired["capo_cloudhsm_v2.types.region.Region"]
    """<p>The AWS Region that contains the source backup from which the new backup was copied.</p>"""
    source_backup: NotRequired["capo_cloudhsm_v2.types.backup_id.BackupId"]
    """<p>The identifier (ID) of the source backup from which the new backup was copied.</p>"""
    source_cluster: NotRequired["capo_cloudhsm_v2.types.cluster_id.ClusterId"]
    """<p>The identifier (ID) of the cluster containing the source backup from which the new backup was copied.</p>"""
    delete_timestamp: NotRequired["capo_cloudhsm_v2.types.timestamp.Timestamp"]
    """<p>The date and time when the backup will be permanently deleted.</p>"""
    tag_list: NotRequired["capo_cloudhsm_v2.types.tag_list.TagList"]
    """<p>The list of tags for the backup.</p>"""
    hsm_type: NotRequired["capo_cloudhsm_v2.types.hsm_type.HsmType"]
    """<p>The HSM type used to create the backup.</p>"""
    mode: NotRequired["capo_cloudhsm_v2.types.cluster_mode.ClusterMode"]
    """<p>The mode of the cluster that was backed up.</p>"""

backup_arn instance-attribute

backup_arn: NotRequired[BackupArn]

The Amazon Resource Name (ARN) of the backup.

backup_id instance-attribute

backup_id: BackupId

The identifier (ID) of the backup.

backup_state instance-attribute

backup_state: NotRequired[BackupState]

The state of the backup.

cluster_id instance-attribute

cluster_id: NotRequired[ClusterId]

The identifier (ID) of the cluster that was backed up.

copy_timestamp instance-attribute

copy_timestamp: NotRequired[Timestamp]

The date and time when the backup was copied from a source backup.

create_timestamp instance-attribute

create_timestamp: NotRequired[Timestamp]

The date and time when the backup was created.

delete_timestamp instance-attribute

delete_timestamp: NotRequired[Timestamp]

The date and time when the backup will be permanently deleted.

hsm_type instance-attribute

hsm_type: NotRequired[HsmType]

The HSM type used to create the backup.

mode instance-attribute

mode: NotRequired[ClusterMode]

The mode of the cluster that was backed up.

never_expires instance-attribute

never_expires: NotRequired[Boolean]

Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

source_backup instance-attribute

source_backup: NotRequired[BackupId]

The identifier (ID) of the source backup from which the new backup was copied.

source_cluster instance-attribute

source_cluster: NotRequired[ClusterId]

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

source_region instance-attribute

source_region: NotRequired[Region]

The AWS Region that contains the source backup from which the new backup was copied.

tag_list instance-attribute

tag_list: NotRequired[TagList]

The list of tags for the backup.