frameworks

Creates, updates, deletes or gets a framework resource or lists frameworks in a region

Overview

Name	frameworks
Type	Resource
Description	Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
Id	aws.backup.frameworks

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: ACTIVE when recording is turned on for all resources governed by the framework. PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework. INACTIVE when recording is turned off for all resources governed by the framework. 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.

For more information, see AWS::Backup::Framework.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FrameworkControls, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all frameworks in a region.

SELECT
region,
framework_name,
framework_description,
framework_arn,
deployment_status,
creation_time,
framework_controls,
framework_status,
framework_tags
FROM aws.backup.frameworks
WHERE region = 'us-east-1';

Gets all properties from an individual framework.

SELECT
region,
framework_name,
framework_description,
framework_arn,
deployment_status,
creation_time,
framework_controls,
framework_status,
framework_tags
FROM aws.backup.frameworks
WHERE region = 'us-east-1' AND data__Identifier = '<FrameworkArn>';

INSERT example

Use the following StackQL query and manifest file to create a new framework resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.backup.frameworks (
 FrameworkControls,
 region
)
SELECT 
'{{ FrameworkControls }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.backup.frameworks (
 FrameworkName,
 FrameworkDescription,
 FrameworkControls,
 FrameworkTags,
 region
)
SELECT 
 '{{ FrameworkName }}',
 '{{ FrameworkDescription }}',
 '{{ FrameworkControls }}',
 '{{ FrameworkTags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: framework
    props:
      - name: FrameworkName
        value: '{{ FrameworkName }}'
      - name: FrameworkDescription
        value: '{{ FrameworkDescription }}'
      - name: FrameworkControls
        value:
          - ControlName: '{{ ControlName }}'
            ControlInputParameters:
              - ParameterName: '{{ ParameterName }}'
                ParameterValue: '{{ ParameterValue }}'
            ControlScope:
              ComplianceResourceIds:
                - '{{ ComplianceResourceIds[0] }}'
              ComplianceResourceTypes:
                - '{{ ComplianceResourceTypes[0] }}'
              Tags:
                - Key: '{{ Key }}'
                  Value: '{{ Value }}'
      - name: FrameworkTags
        value:
          - null

DELETE example

/*+ delete */
DELETE FROM aws.backup.frameworks
WHERE data__Identifier = '<FrameworkArn>'
AND region = 'us-east-1';

Permissions

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

Create

backup:CreateFramework,
backup:DescribeFramework,
backup:ListTags,
backup:TagResource,
iam:CreateServiceLinkedRole

Read

backup:DescribeFramework,
backup:ListTags

Update

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

Delete

backup:DeleteFramework,
backup:DescribeFramework

List

backup:ListFrameworks