AWS::Backup::Framework

Backup Framework

Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

Properties

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

Filter:

Property	Type	Flags
`FrameworkControls`	`Array<FrameworkControl>`	Required
`FrameworkDescription`	`string`
`FrameworkName`	`string`	Create-only
`FrameworkTags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`CreationTime`	`string`	The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
`DeploymentStatus`	`string`	The deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS \| UPDATE_IN_PROGRESS \| DELETE_IN_PROGRESS \| COMPLETED \| FAILED`
`FrameworkArn`	`string`	An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
`FrameworkStatus`	`string`	A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are: `ACTIVE` when recording is turned on for all resources ...

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::Framework

Resources:
  MyResource:
    Type: AWS::Backup::Framework
    Properties:
      FrameworkControls: []

Required IAM Permissions

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

create

backup:CreateFrameworkbackup:DescribeFrameworkbackup:ListTagsbackup:TagResourceiam:CreateServiceLinkedRole

read

backup:DescribeFrameworkbackup:ListTags

update

backup:DescribeFrameworkbackup:UpdateFrameworkbackup:ListTagsbackup:TagResourcebackup:UntagResource

delete

backup:DeleteFrameworkbackup:DescribeFramework

list

backup:ListFrameworks

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

Required1

TaggingSupported

Primary IDFrameworkArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

FrameworkName

Related Resources

External Links

AWS Documentation