frameworks

Creates, updates, deletes, gets or lists a frameworks resource.

Overview

Name	frameworks
Type	Resource
Id	aws.backup.frameworks

Fields

The following fields are returned by SELECT queries:

describe_framework

Name	Datatype	Description
creation_time	string (date-time)	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.
deployment_status	string	The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
framework_arn	string	An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
framework_controls	array	The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
framework_description	string	An optional description of the framework. (pattern: <code>.\S.</code>)
framework_name	string	The unique name of a framework. (pattern: <code>[a-zA-Z][_a-zA-Z0-9]*</code>)
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 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 Backup is unable to validate recording status at this time.
idempotency_token	string	A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

list_frameworks

Name	Datatype	Description
frameworks	array	The frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.
next_token	string	An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_framework	select	framework_name, region		Returns the framework details for the specified FrameworkName.
list_frameworks	select	region	MaxResults, NextToken	Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
create_framework	insert	region, FrameworkName, FrameworkControls		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.
update_framework	update	framework_name, region		Updates the specified framework.
delete_framework	delete	framework_name, region		Deletes the framework specified by a framework name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
framework_name	string	The unique name of a framework.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
NextToken	string	An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

SELECT examples

describe_framework

Returns the framework details for the specified FrameworkName.

SELECT
creation_time,
deployment_status,
framework_arn,
framework_controls,
framework_description,
framework_name,
framework_status,
idempotency_token
FROM aws.backup.frameworks
WHERE framework_name = '{{ framework_name }}' -- required
AND region = '{{ region }}' -- required
;

list_frameworks

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

SELECT
frameworks,
next_token
FROM aws.backup.frameworks
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_framework

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.

INSERT INTO aws.backup.frameworks (
FrameworkName,
FrameworkDescription,
FrameworkControls,
IdempotencyToken,
FrameworkTags,
region
)
SELECT 
'{{ FrameworkName }}' /* required */,
'{{ FrameworkDescription }}',
'{{ FrameworkControls }}' /* required */,
'{{ IdempotencyToken }}',
'{{ FrameworkTags }}',
'{{ region }}'
RETURNING
framework_arn,
framework_name
;

Manifest

# Description fields are for documentation purposes
- name: frameworks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the frameworks resource.
  - name: FrameworkName
    value: "{{ FrameworkName }}"
  - name: FrameworkDescription
    value: "{{ FrameworkDescription }}"
  - name: FrameworkControls
    value:
      - ControlName: "{{ ControlName }}"
        ControlInputParameters: "{{ ControlInputParameters }}"
        ControlScope:
          ComplianceResourceIds:
            - "{{ ComplianceResourceIds }}"
          ComplianceResourceTypes:
            - "{{ ComplianceResourceTypes }}"
          Tags: "{{ Tags }}"
  - name: IdempotencyToken
    value: "{{ IdempotencyToken }}"
  - name: FrameworkTags
    value: "{{ FrameworkTags }}"

UPDATE examples

update_framework

Updates the specified framework.

UPDATE aws.backup.frameworks
SET 
FrameworkDescription = '{{ FrameworkDescription }}',
FrameworkControls = '{{ FrameworkControls }}',
IdempotencyToken = '{{ IdempotencyToken }}'
WHERE 
framework_name = '{{ framework_name }}' --required
AND region = '{{ region }}' --required
RETURNING
creation_time,
framework_arn,
framework_name;

DELETE examples

delete_framework

Deletes the framework specified by a framework name.

DELETE FROM aws.backup.frameworks
WHERE framework_name = '{{ framework_name }}' --required
AND region = '{{ region }}' --required
;