Class: Aws::Backup::Types::ControlScope

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

Overview

A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

To set a control scope that includes all of a particular resource, leave the ControlScope empty or do not pass it when calling CreateFramework.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compliance_resource_ids ⇒ Array<String>

The ID of the only Amazon Web Services resource that you want your control scope to contain.

Returns:

  • (Array<String>) 


1256
1257
1258
1259
1260
1261
1262
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1256

class ControlScope < Struct.new(
  :compliance_resource_ids,
  :compliance_resource_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_resource_types ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1256
1257
1258
1259
1260
1261
1262
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1256

class ControlScope < Struct.new(
  :compliance_resource_ids,
  :compliance_resource_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string if you are creating or editing a framework from the console (though the value can be an empty string when included in a CloudFormation template).

The structure to assign a tag is: [\{"Key":"string","Value":"string"\}].

Returns:

  • (Hash<String,String>) 


1256
1257
1258
1259
1260
1261
1262
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1256

class ControlScope < Struct.new(
  :compliance_resource_ids,
  :compliance_resource_types,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end