Interface CfnFramework.ControlScopeProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnFramework.ControlScopeProperty extends
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 .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 ControlScopeProperty controlScopeProperty = ControlScopeProperty.builder()
  • Method Details

    • getComplianceResourceIds

      @Stability(Stable) @Nullable default List<String> getComplianceResourceIds()
      The ID of the only AWS resource that you want your control scope to contain.
    • getComplianceResourceTypes

      @Stability(Stable) @Nullable default List<String> getComplianceResourceTypes()
      Describes whether the control scope includes one or more types of resources, such as EFS or RDS .
    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      The tag key-value pair applied to those AWS 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. The structure to assign a tag is: [{"Key":"string","Value":"string"}] .

    • builder

      @Stability(Stable) static CfnFramework.ControlScopeProperty.Builder builder()
      a CfnFramework.ControlScopeProperty.Builder of CfnFramework.ControlScopeProperty