Package software.amazon.awscdk.services.config

Interface CfnConfigRule.ScopeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigRule.ScopeProperty.Jsii$Proxy

Enclosing class:

CfnConfigRule

@Stability(Stable)
public static interface CfnConfigRule.ScopeProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComplianceResourceId

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourceid

getComplianceResourceTypes

@Stability(Stable)
@Nullable
default List<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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourcetypes

getTagKey

@Stability(Stable)
@Nullable
default String getTagKey()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagkey

getTagValue

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagvalue

builder

@Stability(Stable)
static CfnConfigRule.ScopeProperty.Builder builder()

Returns:

a CfnConfigRule.ScopeProperty.Builder of CfnConfigRule.ScopeProperty