backup_create_legal_hold: Creates a legal hold on a recovery point (backup)

View source: R/backup_operations.R

backup_create_legal_holdR Documentation

Description

Creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

See https://www.paws-r-sdk.com/docs/backup_create_legal_hold/ for full documentation.

Usage

backup_create_legal_hold(
  Title,
  Description,
  IdempotencyToken = NULL,
  RecoveryPointSelection = NULL,
  Tags = NULL
)

Arguments

Title

[required] The title of the legal hold.

Description

[required] The description of the legal hold.

IdempotencyToken

This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

RecoveryPointSelection

The criteria to assign a set of resources, such as resource types or backup vaults.

Tags

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.


paws.storage documentation built on Sept. 12, 2024, 6:16 a.m.