Skip to content

Create Framework

backup_create_framework R Documentation

Creates a framework with one or more controls

Description

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

Usage

backup_create_framework(FrameworkName, FrameworkDescription,
  FrameworkControls, IdempotencyToken, FrameworkTags)

Arguments

FrameworkName

[required] The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

FrameworkDescription

An optional description of the framework with a maximum of 1,024 characters.

FrameworkControls

[required] The controls that make up the framework. Each control in the list has a name, input parameters, and scope.

IdempotencyToken

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

FrameworkTags

The tags to assign to the framework.

Value

A list with the following syntax:

list(
  FrameworkName = "string",
  FrameworkArn = "string"
)

Request syntax

svc$create_framework(
  FrameworkName = "string",
  FrameworkDescription = "string",
  FrameworkControls = list(
    list(
      ControlName = "string",
      ControlInputParameters = list(
        list(
          ParameterName = "string",
          ParameterValue = "string"
        )
      ),
      ControlScope = list(
        ComplianceResourceIds = list(
          "string"
        ),
        ComplianceResourceTypes = list(
          "string"
        ),
        Tags = list(
          "string"
        )
      )
    )
  ),
  IdempotencyToken = "string",
  FrameworkTags = list(
    "string"
  )
)