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.
The identifier (ID) of the backup.
Type: String
Pattern: backup-[2-7a-zA-Z]{11,16}
Required: Yes
The Amazon Resource Name (ARN) of the backup.
Type: String
Pattern: ^(arn:aws(-(us-gov))?:cloudhsm:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]{1}):[0-9]{12}:backup/)?backup-[2-7a-zA-Z]{11,16}
Required: No
The state of the backup.
Type: String
Valid Values: CREATE_IN_PROGRESS | READY | DELETED | PENDING_DELETION
Required: No
The identifier (ID) of the cluster that was backed up.
Type: String
Pattern: cluster-[2-7a-zA-Z]{11,16}
Required: No
The date and time when the backup was copied from a source backup.
Type: Timestamp
Required: No
The date and time when the backup was created.
Type: Timestamp
Required: No
The date and time when the backup will be permanently deleted.
Type: Timestamp
Required: No
The HSM type used to create the backup.
Type: String
Length Constraints: Maximum length of 32.
Pattern: ((p|)hsm[0-9][a-z.]*\.[a-zA-Z]+)
Required: No
The mode of the cluster that was backed up.
Type: String
Valid Values: FIPS | NON_FIPS
Required: No
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.
Type: Boolean
Required: No
The identifier (ID) of the source backup from which the new backup was copied.
Type: String
Pattern: backup-[2-7a-zA-Z]{11,16}
Required: No
The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
Type: String
Pattern: cluster-[2-7a-zA-Z]{11,16}
Required: No
The AWS Region that contains the source backup from which the new backup was copied.
Type: String
Pattern: [a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\d
Required: No
The list of tags for the backup.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
For more information about using this API in one of the language-specific AWS SDKs, see the following:
Data Types
BackupRetentionPolicy
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4