Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. backup
  5. Framework

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.backup.Framework

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

Create Framework Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Framework(name: string, args: FrameworkArgs, opts?: CustomResourceOptions);
@overload
def Framework(resource_name: str,
              args: FrameworkArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Framework(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              framework_controls: Optional[Sequence[FrameworkControlArgs]] = None,
              framework_description: Optional[str] = None,
              framework_name: Optional[str] = None,
              framework_tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewFramework(ctx *Context, name string, args FrameworkArgs, opts ...ResourceOption) (*Framework, error)
public Framework(string name, FrameworkArgs args, CustomResourceOptions? opts = null)
public Framework(String name, FrameworkArgs args)
public Framework(String name, FrameworkArgs args, CustomResourceOptions options)

type: aws-native:backup:Framework
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FrameworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FrameworkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FrameworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FrameworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FrameworkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Framework Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Framework resource accepts the following input properties:

FrameworkControls This property is required. List<Pulumi.AwsNative.Backup.Inputs.FrameworkControl>
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
FrameworkDescription string
An optional description of the framework with a maximum 1,024 characters.
FrameworkName 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 (_).
FrameworkTags List<Pulumi.AwsNative.Inputs.Tag>
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
FrameworkControls This property is required. []FrameworkControlArgs
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
FrameworkDescription string
An optional description of the framework with a maximum 1,024 characters.
FrameworkName 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 (_).
FrameworkTags TagArgs
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
frameworkControls This property is required. List<FrameworkControl>
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
frameworkDescription String
An optional description of the framework with a maximum 1,024 characters.
frameworkName 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 (_).
frameworkTags List<Tag>
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
frameworkControls This property is required. FrameworkControl[]
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
frameworkDescription string
An optional description of the framework with a maximum 1,024 characters.
frameworkName 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 (_).
frameworkTags Tag[]
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
framework_controls This property is required. Sequence[FrameworkControlArgs]
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
framework_description str
An optional description of the framework with a maximum 1,024 characters.
framework_name str
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_tags Sequence[TagArgs]
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
frameworkControls This property is required. List<Property Map>
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
frameworkDescription String
An optional description of the framework with a maximum 1,024 characters.
frameworkName 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 (_).
frameworkTags List<Property Map>
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

Outputs

All input properties are implicitly available as output properties. Additionally, the Framework resource produces the following output properties:

CreationTime 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.
DeploymentStatus string
The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
FrameworkArn string
An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
FrameworkStatus 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.

Id string
The provider-assigned unique ID for this managed resource.
CreationTime 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.
DeploymentStatus string
The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
FrameworkArn string
An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
FrameworkStatus 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.

Id string
The provider-assigned unique ID for this managed resource.
creationTime 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.
deploymentStatus String
The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
frameworkArn String
An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
frameworkStatus 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.

id String
The provider-assigned unique ID for this managed resource.
creationTime 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.
deploymentStatus string
The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
frameworkArn string
An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
frameworkStatus 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.

id string
The provider-assigned unique ID for this managed resource.
creation_time str
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 str
The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
framework_arn str
An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
framework_status str

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.

id str
The provider-assigned unique ID for this managed resource.
creationTime 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.
deploymentStatus String
The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
frameworkArn String
An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
frameworkStatus 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.

id String
The provider-assigned unique ID for this managed resource.

Supporting Types

FrameworkControl
, FrameworkControlArgs

ControlName This property is required. string
The name of a control. This name is between 1 and 256 characters.
ControlInputParameters List<Pulumi.AwsNative.Backup.Inputs.FrameworkControlInputParameter>
A list of ParameterName and ParameterValue pairs.
ControlScope Pulumi.AwsNative.Backup.Inputs.FrameworkControlControlScopeProperties
The 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.
ControlName This property is required. string
The name of a control. This name is between 1 and 256 characters.
ControlInputParameters []FrameworkControlInputParameter
A list of ParameterName and ParameterValue pairs.
ControlScope FrameworkControlControlScopeProperties
The 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.
controlName This property is required. String
The name of a control. This name is between 1 and 256 characters.
controlInputParameters List<FrameworkControlInputParameter>
A list of ParameterName and ParameterValue pairs.
controlScope FrameworkControlControlScopeProperties
The 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.
controlName This property is required. string
The name of a control. This name is between 1 and 256 characters.
controlInputParameters FrameworkControlInputParameter[]
A list of ParameterName and ParameterValue pairs.
controlScope FrameworkControlControlScopeProperties
The 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.
control_name This property is required. str
The name of a control. This name is between 1 and 256 characters.
control_input_parameters Sequence[FrameworkControlInputParameter]
A list of ParameterName and ParameterValue pairs.
control_scope FrameworkControlControlScopeProperties
The 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.
controlName This property is required. String
The name of a control. This name is between 1 and 256 characters.
controlInputParameters List<Property Map>
A list of ParameterName and ParameterValue pairs.
controlScope Property Map
The 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.

FrameworkControlControlScopeProperties
, FrameworkControlControlScopePropertiesArgs

ComplianceResourceIds List<string>
The ID of the only AWS resource that you want your control scope to contain.
ComplianceResourceTypes List<string>
Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
Tags List<Pulumi.AwsNative.Backup.Inputs.FrameworkTag>
Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
ComplianceResourceIds []string
The ID of the only AWS resource that you want your control scope to contain.
ComplianceResourceTypes []string
Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
Tags []FrameworkTag
Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
complianceResourceIds List<String>
The ID of the only AWS resource that you want your control scope to contain.
complianceResourceTypes List<String>
Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
tags List<FrameworkTag>
Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
complianceResourceIds string[]
The ID of the only AWS resource that you want your control scope to contain.
complianceResourceTypes string[]
Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
tags FrameworkTag[]
Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
compliance_resource_ids Sequence[str]
The ID of the only AWS resource that you want your control scope to contain.
compliance_resource_types Sequence[str]
Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
tags Sequence[FrameworkTag]
Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.
complianceResourceIds List<String>
The ID of the only AWS resource that you want your control scope to contain.
complianceResourceTypes List<String>
Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
tags List<Property Map>
Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.

FrameworkControlInputParameter
, FrameworkControlInputParameterArgs

ParameterName This property is required. string
The name of a parameter, for example, BackupPlanFrequency .
ParameterValue This property is required. string
The value of parameter, for example, hourly .
ParameterName This property is required. string
The name of a parameter, for example, BackupPlanFrequency .
ParameterValue This property is required. string
The value of parameter, for example, hourly .
parameterName This property is required. String
The name of a parameter, for example, BackupPlanFrequency .
parameterValue This property is required. String
The value of parameter, for example, hourly .
parameterName This property is required. string
The name of a parameter, for example, BackupPlanFrequency .
parameterValue This property is required. string
The value of parameter, for example, hourly .
parameter_name This property is required. str
The name of a parameter, for example, BackupPlanFrequency .
parameter_value This property is required. str
The value of parameter, for example, hourly .
parameterName This property is required. String
The name of a parameter, for example, BackupPlanFrequency .
parameterValue This property is required. String
The value of parameter, for example, hourly .

FrameworkTag
, FrameworkTagArgs

Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
key str
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native