AWS::Backup::Framework - AWS CloudFormation (original) (raw)

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

For a sample AWS CloudFormation template, see the AWS Backup Developer Guide.

Syntax

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

JSON

{
  "Type" : "AWS::Backup::Framework",
  "Properties" : {
      "FrameworkControls" : [ FrameworkControl, ... ],
      "FrameworkDescription" : String,
      "FrameworkName" : String,
      "FrameworkTags" : [ Tag, ... ]
    }
}

Properties

FrameworkControls

Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

Required: Yes

Type: Array of FrameworkControl

Update requires: No interruption

FrameworkDescription

An optional description of the framework with a maximum 1,024 characters.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

FrameworkName

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Required: No

Type: String

Pattern: [a-zA-Z][_a-zA-Z0-9]*

Minimum: 1

Maximum: 256

Update requires: Replacement

FrameworkTags

The tags to assign to your framework.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the framework ARN.

Fn::GetAtt

CreationTime

The UTC time when you created your framework.

DeploymentStatus

Depolyment status refers to whether your framework has completed deployment. This status is usually Completed, but might also be Create in progress or another status. For a list of statuses, see Framework compliance status in the AWS Backup; Developer Guide.

FrameworkArn

The Amazon Resource Name (ARN) of your framework.

FrameworkStatus

Framework status refers to whether you have turned on resource tracking for all of your resources. This status is Active when you turn on all resources the framework evaluates. For other statuses and steps to correct them, see Framework compliance status in the AWS Backup; Developer Guide.