software.amazon.awscdk.services.config

Interface CfnConfigRule.ScopeProperty

All Known Implementing Classes:

CfnConfigRule.ScopeProperty.Jsii$Proxy

Enclosing class:

CfnConfigRule

public static interface CfnConfigRule.ScopeProperty

Defines which resources trigger an evaluation for an AWS Config rule.

The 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. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

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.config.*;
 ScopeProperty scopeProperty = ScopeProperty.builder()
         .complianceResourceId("complianceResourceId")
         .complianceResourceTypes(List.of("complianceResourceTypes"))
         .tagKey("tagKey")
         .tagValue("tagValue")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnConfigRule.ScopeProperty.Builder A builder for CfnConfigRule.ScopeProperty
static class	CfnConfigRule.ScopeProperty.Jsii$Proxy An implementation for CfnConfigRule.ScopeProperty

Method Summary

Modifier and Type	Method and Description
static CfnConfigRule.ScopeProperty.Builder	builder()
default java.lang.String	getComplianceResourceId() The ID of the only AWS resource that you want to trigger an evaluation for the rule.
default java.util.List<java.lang.String>	getComplianceResourceTypes() The resource types of only those AWS resources that you want to trigger an evaluation for the rule.
default java.lang.String	getTagKey() The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
default java.lang.String	getTagValue() The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.

Method Detail

getComplianceResourceId

default java.lang.String getComplianceResourceId()

The ID of the only AWS resource that you want to trigger an evaluation for the rule.

If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes .

getComplianceResourceTypes

default java.util.List<java.lang.String> getComplianceResourceTypes()

The resource types of only those AWS resources that you want to trigger an evaluation for the rule.

You can only specify one type if you also specify a resource ID for ComplianceResourceId .

getTagKey

default java.lang.String getTagKey()

The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.

getTagValue

default java.lang.String getTagValue()

The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.

If you specify a value for TagValue , you must also specify a value for TagKey .

builder

static CfnConfigRule.ScopeProperty.Builder builder()

Returns:

a CfnConfigRule.ScopeProperty.Builder of CfnConfigRule.ScopeProperty