View a markdown version of this page

AWS::Backup::LegalHold - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Backup::LegalHold

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.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Backup::LegalHold",
  "Properties" : {
      "Description" : String,
      "RecoveryPointSelection" : RecoveryPointSelection,
      "Tags" : [ TagsItems, ... ],
      "Title" : String
    }
}

YAML

Type: AWS::Backup::LegalHold
Properties:
  Description: String
  RecoveryPointSelection: 
    RecoveryPointSelection
  Tags: 
    - TagsItems
  Title: String

Properties

Description

The description of a legal hold.

Required: Yes

Type: String

Update requires: Replacement

RecoveryPointSelection

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

Required: Yes

Type: RecoveryPointSelection

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of TagsItems

Update requires: No interruption

Title

The title of a legal hold.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CreationDate

The time when the legal hold was created.

LegalHoldId

The ID of the legal hold.

Status

The status of the legal hold.