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.
Overview
| Name | backups |
| Type | Resource |
| Description | 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. |
| Id | aws.cloudhsm.backups |
Fields
| Name | Datatype | Description |
|---|
backup_id | string | The identifier (ID) of the backup. |
backup_state | string | The state of the backup. |
cluster_id | string | The identifier (ID) of the cluster that was backed up. |
create_timestamp | string | The date and time when the backup was created. |
copy_timestamp | string | The date and time when the backup was copied from a source backup. |
never_expires | 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_region | string | The AWS Region that contains the source backup from which the new backup was copied. |
source_backup | string | The identifier (ID) of the source backup from which the new backup was copied. |
source_cluster | string | The identifier (ID) of the cluster containing the source backup from which the new backup was copied. |
delete_timestamp | string | The date and time when the backup will be permanently deleted. |
tag_list | array | The list of tags for the backup. |
region | string | AWS region. |
Methods
| Name | Accessible by | Required Params |
|---|
describe_backups | SELECT | region |
delete_backup | DELETE | X-Amz-Target, data__BackupId, region |
copy_backup_to_region | EXEC | X-Amz-Target, data__BackupId, data__DestinationRegion, region |
modify_backup_attributes | EXEC | X-Amz-Target, data__BackupId, data__NeverExpires, region |
restore_backup | EXEC | X-Amz-Target, data__BackupId, region |