framework

Gets an individual framework resource

Overview

Name	framework
Type	Resource
Description	framework
Id	awscc.backup.framework

Fields

Name	Datatype	Description
framework_name	string	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 (_).
framework_description	string	An optional description of the framework with a maximum 1,024 characters.
framework_arn	string	An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
deployment_status	string	The deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`
creation_time	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.
framework_controls	array	Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
framework_status	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:<br/><br/>`ACTIVE` when recording is turned on for all resources governed by the framework.<br/><br/>`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.<br/><br/>`INACTIVE` when recording is turned off for all resources governed by the framework.<br/><br/>`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time.
framework_tags	array	Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
framework_name,
framework_description,
framework_arn,
deployment_status,
creation_time,
framework_controls,
framework_status,
framework_tags
FROM awscc.backup.framework
WHERE data__Identifier = '<FrameworkArn>';

Permissions

To operate on the framework resource, the following permissions are required:

Read

backup:DescribeFramework,
backup:ListTags

Update

backup:DescribeFramework,
backup:UpdateFramework,
backup:ListTags,
backup:TagResource,
backup:UntagResource

Delete

backup:DeleteFramework,
backup:DescribeFramework