Interface CfnFramework.ControlScopeProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFramework.ControlScopeProperty.Jsii$Proxy
- Enclosing class:
CfnFramework
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 callingCreateFramework
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.backup.*; ControlScopeProperty controlScopeProperty = ControlScopeProperty.builder() .complianceResourceIds(List.of("complianceResourceIds")) .complianceResourceTypes(List.of("complianceResourceTypes")) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnFramework.ControlScopeProperty
static final class
An implementation forCfnFramework.ControlScopeProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The ID of the only AWS resource that you want your control scope to contain.Describes whether the control scope includes one or more types of resources, such asEFS
orRDS
.getTags()
The tag key-value pair applied to those AWS resources that you want to trigger an evaluation for a rule.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComplianceResourceIds
The ID of the only AWS resource that you want your control scope to contain.- See Also:
-
getComplianceResourceTypes
Describes whether the control scope includes one or more types of resources, such asEFS
orRDS
.- See Also:
-
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 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"}]
.- See Also:
-
builder
-