aws logo
AWS Classic v5.28.0, Jan 23 23

aws.backup.Framework

Provides an AWS Backup Framework resource.

Note: For the Deployment Status of the Framework to be successful, please turn on resource tracking to enable AWS Config recording to track configuration changes of your backup resources. This can be done from the AWS Console.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Backup.Framework("example", new()
    {
        Controls = new[]
        {
            new Aws.Backup.Inputs.FrameworkControlArgs
            {
                InputParameters = new[]
                {
                    new Aws.Backup.Inputs.FrameworkControlInputParameterArgs
                    {
                        Name = "requiredRetentionDays",
                        Value = "35",
                    },
                },
                Name = "BACKUP_RECOVERY_POINT_MINIMUM_RETENTION_CHECK",
            },
            new Aws.Backup.Inputs.FrameworkControlArgs
            {
                InputParameters = new[]
                {
                    new Aws.Backup.Inputs.FrameworkControlInputParameterArgs
                    {
                        Name = "requiredFrequencyUnit",
                        Value = "hours",
                    },
                    new Aws.Backup.Inputs.FrameworkControlInputParameterArgs
                    {
                        Name = "requiredRetentionDays",
                        Value = "35",
                    },
                    new Aws.Backup.Inputs.FrameworkControlInputParameterArgs
                    {
                        Name = "requiredFrequencyValue",
                        Value = "1",
                    },
                },
                Name = "BACKUP_PLAN_MIN_FREQUENCY_AND_MIN_RETENTION_CHECK",
            },
            new Aws.Backup.Inputs.FrameworkControlArgs
            {
                Name = "BACKUP_RECOVERY_POINT_ENCRYPTED",
            },
            new Aws.Backup.Inputs.FrameworkControlArgs
            {
                Name = "BACKUP_RESOURCES_PROTECTED_BY_BACKUP_PLAN",
                Scope = new Aws.Backup.Inputs.FrameworkControlScopeArgs
                {
                    ComplianceResourceTypes = new[]
                    {
                        "EBS",
                    },
                },
            },
            new Aws.Backup.Inputs.FrameworkControlArgs
            {
                Name = "BACKUP_RECOVERY_POINT_MANUAL_DELETION_DISABLED",
            },
            new Aws.Backup.Inputs.FrameworkControlArgs
            {
                InputParameters = new[]
                {
                    new Aws.Backup.Inputs.FrameworkControlInputParameterArgs
                    {
                        Name = "maxRetentionDays",
                        Value = "100",
                    },
                    new Aws.Backup.Inputs.FrameworkControlInputParameterArgs
                    {
                        Name = "minRetentionDays",
                        Value = "1",
                    },
                },
                Name = "BACKUP_RESOURCES_PROTECTED_BY_BACKUP_VAULT_LOCK",
                Scope = new Aws.Backup.Inputs.FrameworkControlScopeArgs
                {
                    ComplianceResourceTypes = new[]
                    {
                        "EBS",
                    },
                },
            },
            new Aws.Backup.Inputs.FrameworkControlArgs
            {
                InputParameters = new[]
                {
                    new Aws.Backup.Inputs.FrameworkControlInputParameterArgs
                    {
                        Name = "recoveryPointAgeUnit",
                        Value = "days",
                    },
                    new Aws.Backup.Inputs.FrameworkControlInputParameterArgs
                    {
                        Name = "recoveryPointAgeValue",
                        Value = "1",
                    },
                },
                Name = "BACKUP_LAST_RECOVERY_POINT_CREATED",
                Scope = new Aws.Backup.Inputs.FrameworkControlScopeArgs
                {
                    ComplianceResourceTypes = new[]
                    {
                        "EBS",
                    },
                },
            },
        },
        Description = "this is an example framework",
        Tags = 
        {
            { "Name", "Example Framework" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/backup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := backup.NewFramework(ctx, "example", &backup.FrameworkArgs{
			Controls: backup.FrameworkControlArray{
				&backup.FrameworkControlArgs{
					InputParameters: backup.FrameworkControlInputParameterArray{
						&backup.FrameworkControlInputParameterArgs{
							Name:  pulumi.String("requiredRetentionDays"),
							Value: pulumi.String("35"),
						},
					},
					Name: pulumi.String("BACKUP_RECOVERY_POINT_MINIMUM_RETENTION_CHECK"),
				},
				&backup.FrameworkControlArgs{
					InputParameters: backup.FrameworkControlInputParameterArray{
						&backup.FrameworkControlInputParameterArgs{
							Name:  pulumi.String("requiredFrequencyUnit"),
							Value: pulumi.String("hours"),
						},
						&backup.FrameworkControlInputParameterArgs{
							Name:  pulumi.String("requiredRetentionDays"),
							Value: pulumi.String("35"),
						},
						&backup.FrameworkControlInputParameterArgs{
							Name:  pulumi.String("requiredFrequencyValue"),
							Value: pulumi.String("1"),
						},
					},
					Name: pulumi.String("BACKUP_PLAN_MIN_FREQUENCY_AND_MIN_RETENTION_CHECK"),
				},
				&backup.FrameworkControlArgs{
					Name: pulumi.String("BACKUP_RECOVERY_POINT_ENCRYPTED"),
				},
				&backup.FrameworkControlArgs{
					Name: pulumi.String("BACKUP_RESOURCES_PROTECTED_BY_BACKUP_PLAN"),
					Scope: &backup.FrameworkControlScopeArgs{
						ComplianceResourceTypes: pulumi.StringArray{
							pulumi.String("EBS"),
						},
					},
				},
				&backup.FrameworkControlArgs{
					Name: pulumi.String("BACKUP_RECOVERY_POINT_MANUAL_DELETION_DISABLED"),
				},
				&backup.FrameworkControlArgs{
					InputParameters: backup.FrameworkControlInputParameterArray{
						&backup.FrameworkControlInputParameterArgs{
							Name:  pulumi.String("maxRetentionDays"),
							Value: pulumi.String("100"),
						},
						&backup.FrameworkControlInputParameterArgs{
							Name:  pulumi.String("minRetentionDays"),
							Value: pulumi.String("1"),
						},
					},
					Name: pulumi.String("BACKUP_RESOURCES_PROTECTED_BY_BACKUP_VAULT_LOCK"),
					Scope: &backup.FrameworkControlScopeArgs{
						ComplianceResourceTypes: pulumi.StringArray{
							pulumi.String("EBS"),
						},
					},
				},
				&backup.FrameworkControlArgs{
					InputParameters: backup.FrameworkControlInputParameterArray{
						&backup.FrameworkControlInputParameterArgs{
							Name:  pulumi.String("recoveryPointAgeUnit"),
							Value: pulumi.String("days"),
						},
						&backup.FrameworkControlInputParameterArgs{
							Name:  pulumi.String("recoveryPointAgeValue"),
							Value: pulumi.String("1"),
						},
					},
					Name: pulumi.String("BACKUP_LAST_RECOVERY_POINT_CREATED"),
					Scope: &backup.FrameworkControlScopeArgs{
						ComplianceResourceTypes: pulumi.StringArray{
							pulumi.String("EBS"),
						},
					},
				},
			},
			Description: pulumi.String("this is an example framework"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example Framework"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.backup.Framework;
import com.pulumi.aws.backup.FrameworkArgs;
import com.pulumi.aws.backup.inputs.FrameworkControlArgs;
import com.pulumi.aws.backup.inputs.FrameworkControlScopeArgs;
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) {
        var example = new Framework("example", FrameworkArgs.builder()        
            .controls(            
                FrameworkControlArgs.builder()
                    .inputParameters(FrameworkControlInputParameterArgs.builder()
                        .name("requiredRetentionDays")
                        .value("35")
                        .build())
                    .name("BACKUP_RECOVERY_POINT_MINIMUM_RETENTION_CHECK")
                    .build(),
                FrameworkControlArgs.builder()
                    .inputParameters(                    
                        FrameworkControlInputParameterArgs.builder()
                            .name("requiredFrequencyUnit")
                            .value("hours")
                            .build(),
                        FrameworkControlInputParameterArgs.builder()
                            .name("requiredRetentionDays")
                            .value("35")
                            .build(),
                        FrameworkControlInputParameterArgs.builder()
                            .name("requiredFrequencyValue")
                            .value("1")
                            .build())
                    .name("BACKUP_PLAN_MIN_FREQUENCY_AND_MIN_RETENTION_CHECK")
                    .build(),
                FrameworkControlArgs.builder()
                    .name("BACKUP_RECOVERY_POINT_ENCRYPTED")
                    .build(),
                FrameworkControlArgs.builder()
                    .name("BACKUP_RESOURCES_PROTECTED_BY_BACKUP_PLAN")
                    .scope(FrameworkControlScopeArgs.builder()
                        .complianceResourceTypes("EBS")
                        .build())
                    .build(),
                FrameworkControlArgs.builder()
                    .name("BACKUP_RECOVERY_POINT_MANUAL_DELETION_DISABLED")
                    .build(),
                FrameworkControlArgs.builder()
                    .inputParameters(                    
                        FrameworkControlInputParameterArgs.builder()
                            .name("maxRetentionDays")
                            .value("100")
                            .build(),
                        FrameworkControlInputParameterArgs.builder()
                            .name("minRetentionDays")
                            .value("1")
                            .build())
                    .name("BACKUP_RESOURCES_PROTECTED_BY_BACKUP_VAULT_LOCK")
                    .scope(FrameworkControlScopeArgs.builder()
                        .complianceResourceTypes("EBS")
                        .build())
                    .build(),
                FrameworkControlArgs.builder()
                    .inputParameters(                    
                        FrameworkControlInputParameterArgs.builder()
                            .name("recoveryPointAgeUnit")
                            .value("days")
                            .build(),
                        FrameworkControlInputParameterArgs.builder()
                            .name("recoveryPointAgeValue")
                            .value("1")
                            .build())
                    .name("BACKUP_LAST_RECOVERY_POINT_CREATED")
                    .scope(FrameworkControlScopeArgs.builder()
                        .complianceResourceTypes("EBS")
                        .build())
                    .build())
            .description("this is an example framework")
            .tags(Map.of("Name", "Example Framework"))
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.backup.Framework("example",
    controls=[
        aws.backup.FrameworkControlArgs(
            input_parameters=[aws.backup.FrameworkControlInputParameterArgs(
                name="requiredRetentionDays",
                value="35",
            )],
            name="BACKUP_RECOVERY_POINT_MINIMUM_RETENTION_CHECK",
        ),
        aws.backup.FrameworkControlArgs(
            input_parameters=[
                aws.backup.FrameworkControlInputParameterArgs(
                    name="requiredFrequencyUnit",
                    value="hours",
                ),
                aws.backup.FrameworkControlInputParameterArgs(
                    name="requiredRetentionDays",
                    value="35",
                ),
                aws.backup.FrameworkControlInputParameterArgs(
                    name="requiredFrequencyValue",
                    value="1",
                ),
            ],
            name="BACKUP_PLAN_MIN_FREQUENCY_AND_MIN_RETENTION_CHECK",
        ),
        aws.backup.FrameworkControlArgs(
            name="BACKUP_RECOVERY_POINT_ENCRYPTED",
        ),
        aws.backup.FrameworkControlArgs(
            name="BACKUP_RESOURCES_PROTECTED_BY_BACKUP_PLAN",
            scope=aws.backup.FrameworkControlScopeArgs(
                compliance_resource_types=["EBS"],
            ),
        ),
        aws.backup.FrameworkControlArgs(
            name="BACKUP_RECOVERY_POINT_MANUAL_DELETION_DISABLED",
        ),
        aws.backup.FrameworkControlArgs(
            input_parameters=[
                aws.backup.FrameworkControlInputParameterArgs(
                    name="maxRetentionDays",
                    value="100",
                ),
                aws.backup.FrameworkControlInputParameterArgs(
                    name="minRetentionDays",
                    value="1",
                ),
            ],
            name="BACKUP_RESOURCES_PROTECTED_BY_BACKUP_VAULT_LOCK",
            scope=aws.backup.FrameworkControlScopeArgs(
                compliance_resource_types=["EBS"],
            ),
        ),
        aws.backup.FrameworkControlArgs(
            input_parameters=[
                aws.backup.FrameworkControlInputParameterArgs(
                    name="recoveryPointAgeUnit",
                    value="days",
                ),
                aws.backup.FrameworkControlInputParameterArgs(
                    name="recoveryPointAgeValue",
                    value="1",
                ),
            ],
            name="BACKUP_LAST_RECOVERY_POINT_CREATED",
            scope=aws.backup.FrameworkControlScopeArgs(
                compliance_resource_types=["EBS"],
            ),
        ),
    ],
    description="this is an example framework",
    tags={
        "Name": "Example Framework",
    })
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.backup.Framework("example", {
    controls: [
        {
            inputParameters: [{
                name: "requiredRetentionDays",
                value: "35",
            }],
            name: "BACKUP_RECOVERY_POINT_MINIMUM_RETENTION_CHECK",
        },
        {
            inputParameters: [
                {
                    name: "requiredFrequencyUnit",
                    value: "hours",
                },
                {
                    name: "requiredRetentionDays",
                    value: "35",
                },
                {
                    name: "requiredFrequencyValue",
                    value: "1",
                },
            ],
            name: "BACKUP_PLAN_MIN_FREQUENCY_AND_MIN_RETENTION_CHECK",
        },
        {
            name: "BACKUP_RECOVERY_POINT_ENCRYPTED",
        },
        {
            name: "BACKUP_RESOURCES_PROTECTED_BY_BACKUP_PLAN",
            scope: {
                complianceResourceTypes: ["EBS"],
            },
        },
        {
            name: "BACKUP_RECOVERY_POINT_MANUAL_DELETION_DISABLED",
        },
        {
            inputParameters: [
                {
                    name: "maxRetentionDays",
                    value: "100",
                },
                {
                    name: "minRetentionDays",
                    value: "1",
                },
            ],
            name: "BACKUP_RESOURCES_PROTECTED_BY_BACKUP_VAULT_LOCK",
            scope: {
                complianceResourceTypes: ["EBS"],
            },
        },
        {
            inputParameters: [
                {
                    name: "recoveryPointAgeUnit",
                    value: "days",
                },
                {
                    name: "recoveryPointAgeValue",
                    value: "1",
                },
            ],
            name: "BACKUP_LAST_RECOVERY_POINT_CREATED",
            scope: {
                complianceResourceTypes: ["EBS"],
            },
        },
    ],
    description: "this is an example framework",
    tags: {
        Name: "Example Framework",
    },
});
resources:
  example:
    type: aws:backup:Framework
    properties:
      controls:
        - inputParameters:
            - name: requiredRetentionDays
              value: '35'
          name: BACKUP_RECOVERY_POINT_MINIMUM_RETENTION_CHECK
        - inputParameters:
            - name: requiredFrequencyUnit
              value: hours
            - name: requiredRetentionDays
              value: '35'
            - name: requiredFrequencyValue
              value: '1'
          name: BACKUP_PLAN_MIN_FREQUENCY_AND_MIN_RETENTION_CHECK
        - name: BACKUP_RECOVERY_POINT_ENCRYPTED
        - name: BACKUP_RESOURCES_PROTECTED_BY_BACKUP_PLAN
          scope:
            complianceResourceTypes:
              - EBS
        - name: BACKUP_RECOVERY_POINT_MANUAL_DELETION_DISABLED
        - inputParameters:
            - name: maxRetentionDays
              value: '100'
            - name: minRetentionDays
              value: '1'
          name: BACKUP_RESOURCES_PROTECTED_BY_BACKUP_VAULT_LOCK
          scope:
            complianceResourceTypes:
              - EBS
        - inputParameters:
            - name: recoveryPointAgeUnit
              value: days
            - name: recoveryPointAgeValue
              value: '1'
          name: BACKUP_LAST_RECOVERY_POINT_CREATED
          scope:
            complianceResourceTypes:
              - EBS
      description: this is an example framework
      tags:
        Name: Example Framework

Create Framework Resource

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

Controls List<FrameworkControlArgs>

One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.

Description string

The description of the framework with a maximum of 1,024 characters

Name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

Tags Dictionary<string, string>

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Controls []FrameworkControlArgs

One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.

Description string

The description of the framework with a maximum of 1,024 characters

Name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

Tags map[string]string

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

controls List<FrameworkControlArgs>

One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.

description String

The description of the framework with a maximum of 1,024 characters

name String

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

tags Map<String,String>

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

controls FrameworkControlArgs[]

One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.

description string

The description of the framework with a maximum of 1,024 characters

name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

tags {[key: string]: string}

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

controls Sequence[FrameworkControlArgs]

One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below.

description str

The description of the framework with a maximum of 1,024 characters

name str

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

tags Mapping[str, str]

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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.

description String

The description of the framework with a maximum of 1,024 characters

name String

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

tags Map<String>

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

Arn string

The ARN of the backup framework.

CreationTime string

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

DeploymentStatus string

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

Id string

The provider-assigned unique ID for this managed resource.

Status 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. For more information refer to the AWS documentation for Framework Status

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

The ARN of the backup framework.

CreationTime string

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

DeploymentStatus string

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

Id string

The provider-assigned unique ID for this managed resource.

Status 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. For more information refer to the AWS documentation for Framework Status

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The ARN of the backup framework.

creationTime String

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

deploymentStatus String

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

id String

The provider-assigned unique ID for this managed resource.

status 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. For more information refer to the AWS documentation for Framework Status

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

The ARN of the backup framework.

creationTime string

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

deploymentStatus string

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

id string

The provider-assigned unique ID for this managed resource.

status 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. For more information refer to the AWS documentation for Framework Status

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

The ARN of the backup framework.

creation_time str

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

deployment_status str

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

id str

The provider-assigned unique ID for this managed resource.

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. For more information refer to the AWS documentation for Framework Status

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The ARN of the backup framework.

creationTime String

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

deploymentStatus String

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

id String

The provider-assigned unique ID for this managed resource.

status 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. For more information refer to the AWS documentation for Framework Status

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing Framework Resource

Get an existing Framework resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FrameworkState, opts?: CustomResourceOptions): Framework
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        controls: Optional[Sequence[FrameworkControlArgs]] = None,
        creation_time: Optional[str] = None,
        deployment_status: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Framework
func GetFramework(ctx *Context, name string, id IDInput, state *FrameworkState, opts ...ResourceOption) (*Framework, error)
public static Framework Get(string name, Input<string> id, FrameworkState? state, CustomResourceOptions? opts = null)
public static Framework get(String name, Output<String> id, FrameworkState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string

The ARN of the backup framework.

Controls List<FrameworkControlArgs>

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

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

DeploymentStatus string

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

Description string

The description of the framework with a maximum of 1,024 characters

Name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

Status 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. For more information refer to the AWS documentation for Framework Status

Tags Dictionary<string, string>

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

The ARN of the backup framework.

Controls []FrameworkControlArgs

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

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

DeploymentStatus string

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

Description string

The description of the framework with a maximum of 1,024 characters

Name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

Status 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. For more information refer to the AWS documentation for Framework Status

Tags map[string]string

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The ARN of the backup framework.

controls List<FrameworkControlArgs>

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

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

deploymentStatus String

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

description String

The description of the framework with a maximum of 1,024 characters

name String

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

status 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. For more information refer to the AWS documentation for Framework Status

tags Map<String,String>

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

The ARN of the backup framework.

controls FrameworkControlArgs[]

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

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

deploymentStatus string

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

description string

The description of the framework with a maximum of 1,024 characters

name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

status 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. For more information refer to the AWS documentation for Framework Status

tags {[key: string]: string}

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

The ARN of the backup framework.

controls Sequence[FrameworkControlArgs]

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

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

deployment_status str

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

description str

The description of the framework with a maximum of 1,024 characters

name str

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

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. For more information refer to the AWS documentation for Framework Status

tags Mapping[str, str]

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The 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

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC).

deploymentStatus String

The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED.

description String

The description of the framework with a maximum of 1,024 characters

name String

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

status 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. For more information refer to the AWS documentation for Framework Status

tags Map<String>

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Supporting Types

FrameworkControl

Name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

InputParameters List<FrameworkControlInputParameter>

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.

Scope FrameworkControlScope

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

Name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

InputParameters []FrameworkControlInputParameter

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.

Scope FrameworkControlScope

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

name String

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

inputParameters List<FrameworkControlInputParameter>

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.

scope FrameworkControlScope

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

name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

inputParameters FrameworkControlInputParameter[]

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.

scope FrameworkControlScope

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

name str

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

input_parameters Sequence[FrameworkControlInputParameter]

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.

scope FrameworkControlScope

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

name String

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

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.

scope 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. Detailed below.

FrameworkControlInputParameter

Name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

Value string

The value of parameter, for example, hourly.

Name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

Value string

The value of parameter, for example, hourly.

name String

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

value String

The value of parameter, for example, hourly.

name string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

value string

The value of parameter, for example, hourly.

name str

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

value str

The value of parameter, for example, hourly.

name String

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

value String

The value of parameter, for example, hourly.

FrameworkControlScope

ComplianceResourceIds List<string>

The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.

ComplianceResourceTypes List<string>

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

Tags Dictionary<string, string>

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

ComplianceResourceIds []string

The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.

ComplianceResourceTypes []string

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

Tags map[string]string

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

complianceResourceIds List<String>

The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.

complianceResourceTypes List<String>

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

tags Map<String,String>

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

complianceResourceIds string[]

The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.

complianceResourceTypes string[]

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

tags {[key: string]: string}

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

compliance_resource_ids Sequence[str]

The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.

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]

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

complianceResourceIds List<String>

The ID of the only AWS resource that you want your control scope to contain. Minimum number of 1 item. Maximum number of 100 items.

complianceResourceTypes List<String>

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

tags Map<String>

Metadata that you can assign to help organize the frameworks you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Import

Backup Framework can be imported using the id which corresponds to the name of the Backup Framework, e.g.,

 $ pulumi import aws:backup/framework:Framework test <id>

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.