AWS Native v0.54.0, Mar 21 23

aws-native.backup.getFramework

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

Using getFramework

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFramework(args: GetFrameworkArgs, opts?: InvokeOptions): Promise<GetFrameworkResult>
function getFrameworkOutput(args: GetFrameworkOutputArgs, opts?: InvokeOptions): Output<GetFrameworkResult>

def get_framework(framework_arn: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetFrameworkResult
def get_framework_output(framework_arn: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetFrameworkResult]

func LookupFramework(ctx *Context, args *LookupFrameworkArgs, opts ...InvokeOption) (*LookupFrameworkResult, error)
func LookupFrameworkOutput(ctx *Context, args *LookupFrameworkOutputArgs, opts ...InvokeOption) LookupFrameworkResultOutput

> Note: This function is named LookupFramework in the Go SDK.

public static class GetFramework 
{
    public static Task<GetFrameworkResult> InvokeAsync(GetFrameworkArgs args, InvokeOptions? opts = null)
    public static Output<GetFrameworkResult> Invoke(GetFrameworkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFrameworkResult> getFramework(GetFrameworkArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:backup:getFramework
  arguments:
    # arguments dictionary

The following arguments are supported:

FrameworkArn string: An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource

FrameworkArn string: An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource

frameworkArn String: An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource

frameworkArn string: An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource

framework_arn str: An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource

frameworkArn String: An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource

getFramework Result

The following output properties are available:

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

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

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.

FrameworkTags List<Pulumi.AwsNative.Backup.Outputs.FrameworkTag>

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

CreationTime string

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

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

FrameworkStatus string

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.

FrameworkTags []FrameworkTag

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

creationTime String

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

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

frameworkStatus String

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.

frameworkTags List<FrameworkTag>

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

creationTime string

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

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

frameworkStatus string

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.

frameworkTags FrameworkTag[]

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

creation_time str

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_controls Sequence[FrameworkControl]

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_status str

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 Sequence[FrameworkTag]

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

creationTime String

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

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.

frameworkStatus String

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.

frameworkTags List<Property Map>

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

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

ParameterName string
ParameterValue string

ParameterName string
ParameterValue string

parameterName String
parameterValue String

parameterName string
parameterValue string

parameter_name str
parameter_value str

parameterName String
parameterValue String

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: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

aws-native.backup.getFramework

Using getFramework

getFramework Result

Supporting Types

FrameworkControl

FrameworkControlControlScopeProperties

FrameworkControlInputParameter

FrameworkTag

Package Details

Contents