Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudhsmv2 ]

delete-backup

Description

Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-backup
--backup-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--backup-id (string)

The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Backup -> (structure)

Information on the Backup object deleted.

BackupId -> (string)

The identifier (ID) of the backup.

BackupState -> (string)

The state of the backup.

ClusterId -> (string)

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

CreateTimestamp -> (timestamp)

The date and time when the backup was created.

CopyTimestamp -> (timestamp)

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

NeverExpires -> (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.

SourceRegion -> (string)

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

SourceBackup -> (string)

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

SourceCluster -> (string)

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

DeleteTimestamp -> (timestamp)

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

TagList -> (list)

The list of tags for the backup.

(structure)

Contains a tag. A tag is a key-value pair.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.