AWS::Backup::LegalHold

Backup LegalHold

Creates a legal hold on recovery points (backups). A legal hold prevents backups from being deleted while under hold.

Properties

4 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`Description`	`string`	RequiredCreate-only
`RecoveryPointSelection`	`object`	RequiredCreate-only
`Title`	`string`	RequiredCreate-only
`Tags`	`Array<object>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) of the legal hold.
`CreationDate`	`string`	The time when the legal hold was created.
`LegalHoldId`	`string`	The ID of the legal hold.
`Status`	`string`	The status of the legal hold.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Backup::LegalHold

Resources:
  MyResource:
    Type: AWS::Backup::LegalHold
    Properties:
      Title: "value"
      Description: "value"
      RecoveryPointSelection: {}
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

backup:CreateLegalHoldbackup:GetLegalHoldbackup:TagResource

read

backup:GetLegalHoldbackup:ListTags

update

backup:GetLegalHoldbackup:TagResourcebackup:UntagResourcebackup:ListTags

delete

backup:CancelLegalHoldbackup:GetLegalHold

list

backup:ListLegalHolds

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceBackup

Properties8

Required3

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

TitleDescriptionRecoveryPointSelection

Related Resources

External Links

AWS Documentation