ControlScope
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.
Note
To set a control scope that includes all of a particular resource, leave the
ControlScope empty or do not pass it when calling
CreateFramework.
Contents
- ComplianceResourceIds
-
The ID of the only Amazon resource that you want your control scope to contain.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
- ComplianceResourceTypes
-
Describes whether the control scope includes one or more types of resources, such as
EFSorRDS.Type: Array of strings
Required: No
- Tags
-
The tag key-value pair applied to those Amazon 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"}].Type: String to string map
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: