1. Packages
  2. AWS Classic
  3. API Docs
  4. backup
  5. getFramework

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

aws.backup.getFramework

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

    Use this data source to get information on an existing backup framework.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.backup.getFramework({
        name: "my_example_backup_framework_name",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.backup.get_framework(name="my_example_backup_framework_name")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/backup"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := backup.LookupFramework(ctx, &backup.LookupFrameworkArgs{
    			Name: "my_example_backup_framework_name",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Backup.GetFramework.Invoke(new()
        {
            Name = "my_example_backup_framework_name",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.backup.BackupFunctions;
    import com.pulumi.aws.backup.inputs.GetFrameworkArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = BackupFunctions.getFramework(GetFrameworkArgs.builder()
                .name("my_example_backup_framework_name")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:backup:getFramework
          Arguments:
            name: my_example_backup_framework_name
    

    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(name: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetFrameworkResult
    def get_framework_output(name: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, 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:backup/getFramework:getFramework
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Backup framework name.
    Tags Dictionary<string, string>
    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.
    Name string
    Backup framework name.
    Tags map[string]string
    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.
    name String
    Backup framework name.
    tags Map<String,String>
    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.
    name string
    Backup framework name.
    tags {[key: string]: string}
    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.
    name str
    Backup framework name.
    tags Mapping[str, str]
    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.
    name String
    Backup framework name.
    tags Map<String>
    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.

    getFramework Result

    The following output properties are available:

    Arn string
    ARN of the backup framework.
    Controls List<GetFrameworkControl>
    One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.
    CreationTime string
    Date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).
    DeploymentStatus string
    Deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED| FAILED.
    Description string
    Description of the framework.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of a parameter, for example, BackupPlanFrequency.
    Status string
    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 Status
    Tags Dictionary<string, string>
    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.
    Arn string
    ARN of the backup framework.
    Controls []GetFrameworkControl
    One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.
    CreationTime string
    Date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).
    DeploymentStatus string
    Deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED| FAILED.
    Description string
    Description of the framework.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of a parameter, for example, BackupPlanFrequency.
    Status string
    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 Status
    Tags map[string]string
    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.
    arn String
    ARN of the backup framework.
    controls List<GetFrameworkControl>
    One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.
    creationTime String
    Date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).
    deploymentStatus String
    Deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED| FAILED.
    description String
    Description of the framework.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of a parameter, for example, BackupPlanFrequency.
    status String
    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 Status
    tags Map<String,String>
    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.
    arn string
    ARN of the backup framework.
    controls GetFrameworkControl[]
    One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.
    creationTime string
    Date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).
    deploymentStatus string
    Deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED| FAILED.
    description string
    Description of the framework.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of a parameter, for example, BackupPlanFrequency.
    status string
    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 Status
    tags {[key: string]: string}
    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.
    arn str
    ARN of the backup framework.
    controls Sequence[GetFrameworkControl]
    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 str
    Date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).
    deployment_status str
    Deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED| FAILED.
    description str
    Description of the framework.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of a parameter, for example, BackupPlanFrequency.
    status str
    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 Status
    tags Mapping[str, str]
    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.
    arn String
    ARN of the backup framework.
    controls List<Property Map>
    One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.
    creationTime String
    Date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).
    deploymentStatus String
    Deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED| FAILED.
    description String
    Description of the framework.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of a parameter, for example, BackupPlanFrequency.
    status String
    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 Status
    tags Map<String>
    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.

    Supporting Types

    GetFrameworkControl

    InputParameters List<GetFrameworkControlInputParameter>
    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 string
    Backup framework name.
    Scopes List<GetFrameworkControlScope>
    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.
    InputParameters []GetFrameworkControlInputParameter
    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 string
    Backup framework name.
    Scopes []GetFrameworkControlScope
    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.
    inputParameters List<GetFrameworkControlInputParameter>
    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 String
    Backup framework name.
    scopes List<GetFrameworkControlScope>
    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.
    inputParameters GetFrameworkControlInputParameter[]
    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 string
    Backup framework name.
    scopes GetFrameworkControlScope[]
    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_parameters Sequence[GetFrameworkControlInputParameter]
    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 str
    Backup framework name.
    scopes Sequence[GetFrameworkControlScope]
    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.
    inputParameters List<Property Map>
    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 String
    Backup framework name.
    scopes List<Property Map>
    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.

    GetFrameworkControlInputParameter

    Name string
    Backup framework name.
    Value string
    Value of parameter, for example, hourly.
    Name string
    Backup framework name.
    Value string
    Value of parameter, for example, hourly.
    name String
    Backup framework name.
    value String
    Value of parameter, for example, hourly.
    name string
    Backup framework name.
    value string
    Value of parameter, for example, hourly.
    name str
    Backup framework name.
    value str
    Value of parameter, for example, hourly.
    name String
    Backup framework name.
    value String
    Value of parameter, for example, hourly.

    GetFrameworkControlScope

    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 Dictionary<string, string>
    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.
    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 map[string]string
    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.
    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 Map<String,String>
    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.
    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 {[key: string]: string}
    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.
    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 Mapping[str, str]
    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.
    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 Map<String>
    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.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi