AWS Native

v0.43.0 published on Thursday, Dec 1, 2022 by Pulumi

Framework

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

new Framework(name: string, args: FrameworkArgs, opts?: CustomResourceOptions);
@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[FrameworkTagArgs]] = None)
@overload
def Framework(resource_name: str,
              args: FrameworkArgs,
              opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args FrameworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args FrameworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FrameworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args 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

The Framework resource accepts the following input properties:

FrameworkControls List<Pulumi.AwsNative.Backup.Inputs.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 List<Pulumi.AwsNative.Backup.Inputs.FrameworkTagArgs>

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

FrameworkControls []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 []FrameworkTagArgs

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

frameworkControls List<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 List<FrameworkTagArgs>

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

frameworkControls 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 FrameworkTagArgs[]

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

framework_controls 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[FrameworkTagArgs]

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

frameworkControls 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 double

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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 float64

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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 Double

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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 number

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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 float

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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 Number

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

ControlName 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 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 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 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 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 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

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

FrameworkTag

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 -.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0