LegalHold

A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

CancellationDate

This is the time in number format when legal hold was cancelled.

Type: Timestamp

Required: No

CreationDate

This is the time in number format when legal hold was created.

Type: Timestamp

Required: No

Description

This is the description of a legal hold.

Type: String

Required: No

LegalHoldArn

This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Type: String

Required: No

LegalHoldId

ID of specific legal hold on one or more recovery points.

Type: String

Required: No

Status

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

Type: String

Valid Values: CREATING | ACTIVE | CANCELING | CANCELED

Required: No

Title

This is the title of a legal hold.

Type: String

Required: No

LegalHold

Contents

See Also