Drop Backup

Deletes an existing database backup and all its contained snapshots.

Input Parameter Description

Name

Type

Description

backup_name

string

Name of the backup object to be deleted. An empty string or '*' will delete all existing backups if true.

datasink_name

string

Datasink where backup is stored.

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)

Parameter Description

dry_run

Dry run of drop backup The default value is false. The supported values are:

false
true

delete_all_backups

All multiple backups to be deleted if true and multiple backup names were found matching prefix of input parameter backup_name. The default value is false. The supported values are:

true
false

no_error_if_not_exists

If false will return an error if the provided input parameter backup_name does not exist. The default value is false. The supported values are:

true
false

Output Parameter Description

Name	Type	Description
backup_name	string	Value of input parameter backup_name.
backup_names	array of strings	Backups that were deleted.
info	map of string to strings	Additional information.