Package software.amazon.awscdk.services.backup

Interface CfnFramework.ControlScopeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFramework.ControlScopeProperty.Jsii$Proxy

Enclosing class:

CfnFramework

@Stability(Stable)
public static interface CfnFramework.ControlScopeProperty
extends software.amazon.jsii.JsiiSerializable

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 .

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFramework.ControlScopeProperty.Builder	A builder for CfnFramework.ControlScopeProperty
static final class	CfnFramework.ControlScopeProperty.Jsii$Proxy	An implementation for CfnFramework.ControlScopeProperty

Method Summary

Modifier and Type	Method	Description
static CfnFramework.ControlScopeProperty.Builder	builder()
default List<String>	getComplianceResourceIds()	The ID of the only AWS resource that you want your control scope to contain.
default List<String>	getComplianceResourceTypes()	Describes whether the control scope includes one or more types of resources, such as EFS or RDS .
default List<CfnTag>	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

@Stability(Stable)
@Nullable
default List<String> getComplianceResourceIds()

The ID of the only AWS resource that you want your control scope to contain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html#cfn-backup-framework-controlscope-complianceresourceids

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html#cfn-backup-framework-controlscope-complianceresourcetypes

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 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html#cfn-backup-framework-controlscope-tags

builder

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

Returns:

a CfnFramework.ControlScopeProperty.Builder of CfnFramework.ControlScopeProperty