Class: Aws::Backup::Types::FrameworkControl

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Note:

When making an API call, you may pass FrameworkControl data as a hash:

{
  control_name: "ControlName", # required
  control_input_parameters: [
    {
      parameter_name: "ParameterName",
      parameter_value: "ParameterValue",
    },
  ],
  control_scope: {
    compliance_resource_ids: ["string"],
    compliance_resource_types: ["ARN"],
    tags: {
      "string" => "string",
    },
  },
}

Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#control_input_parameters ⇒ Array<Types::ControlInputParameter>

A list of ParameterName and ParameterValue pairs.

Returns:



3214
3215
3216
3217
3218
3219
3220
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3214

class FrameworkControl < Struct.new(
  :control_name,
  :control_input_parameters,
  :control_scope)
  SENSITIVE = []
  include Aws::Structure
end

#control_name ⇒ String

The name of a control. This name is between 1 and 256 characters.

Returns:

  • (String) 


3214
3215
3216
3217
3218
3219
3220
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3214

class FrameworkControl < Struct.new(
  :control_name,
  :control_input_parameters,
  :control_scope)
  SENSITIVE = []
  include Aws::Structure
end

#control_scope ⇒ Types::ControlScope

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. For more information, see ControlScope.

Returns:



3214
3215
3216
3217
3218
3219
3220
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3214

class FrameworkControl < Struct.new(
  :control_name,
  :control_input_parameters,
  :control_scope)
  SENSITIVE = []
  include Aws::Structure
end