Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Backup

Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.

Hierarchy

  • Backup

Index

Properties

BackupId

BackupId: string | undefined

The identifier (ID) of the backup.

Optional BackupState

BackupState: BackupState | string

The state of the backup.

Optional ClusterId

ClusterId: undefined | string

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

Optional CopyTimestamp

CopyTimestamp: Date

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

Optional CreateTimestamp

CreateTimestamp: Date

The date and time when the backup was created.

Optional DeleteTimestamp

DeleteTimestamp: Date

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

Optional NeverExpires

NeverExpires: undefined | false | true

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.

Optional SourceBackup

SourceBackup: undefined | string

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

Optional SourceCluster

SourceCluster: undefined | string

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

Optional SourceRegion

SourceRegion: undefined | string

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

Optional TagList

TagList: Tag[]

The list of tags for the backup.