Use this data source to get information on an existing backup framework.
data "aws_backup_framework" "example" {
name = "tf_example_backup_framework_name"
}
This data source supports the following arguments:
name
- (Required) Backup framework name.This data source exports the following attributes in addition to the arguments above:
arn
- ARN of the backup framework.control
- One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.creation_time
- Date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).deployment_status
- Deployment status of a framework. The statuses are: CREATE_IN_PROGRESS
| UPDATE_IN_PROGRESS
| DELETE_IN_PROGRESS
| COMPLETED
| FAILED
.description
- Description of the framework.id
- ID of the framework.status
- 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
, PARTIALLY_ACTIVE
, INACTIVE
, UNAVAILABLE
. For more information refer to the AWS documentation for Framework Statustags
- Metadata that helps organize the frameworks you create.control
has the following attributes:
input_parameter
- One or more input parameter blocks. An example of a control with two parameters is: "backup plan frequency is at least daily and the retention period is at least 1 year". The first parameter is daily. The second parameter is 1 year. Detailed below.name
- Name of a control.scope
- Scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. Detailed below.input_parameter
has the following attributes:
name
- Name of a parameter, for example, BackupPlanFrequency.value
- Value of parameter, for example, hourly.scope
has the following attributes:
compliance_resource_ids
- The ID of the only AWS resource that you want your control scope to contain.compliance_resource_types
- Describes whether the control scope includes one or more types of resources, such as EFS or RDS.tags
- Tag key-value pair applied to those AWS resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided.