Create Legal Hold

backup_create_legal_hold

R Documentation

Creates a legal hold on a recovery point (backup)¶

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.

Usage¶

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

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: + - = . _ : /.

Value¶

A list with the following syntax:

list(
  Title = "string",
  Status = "CREATING"|"ACTIVE"|"CANCELING"|"CANCELED",
  Description = "string",
  LegalHoldId = "string",
  LegalHoldArn = "string",
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  RecoveryPointSelection = list(
    VaultNames = list(
      "string"
    ),
    ResourceIdentifiers = list(
      "string"
    ),
    DateRange = list(
      FromDate = as.POSIXct(
        "2015-01-01"
      ),
      ToDate = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$create_legal_hold(
  Title = "string",
  Description = "string",
  IdempotencyToken = "string",
  RecoveryPointSelection = list(
    VaultNames = list(
      "string"
    ),
    ResourceIdentifiers = list(
      "string"
    ),
    DateRange = list(
      FromDate = as.POSIXct(
        "2015-01-01"
      ),
      ToDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  Tags = list(
    "string"
  )
)