interface ScopeProperty

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.Config.CfnConfigRulePropsMixin.ScopeProperty`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsconfig#CfnConfigRulePropsMixin_ScopeProperty`
Java	`software.amazon.awscdk.cfnpropertymixins.services.config.CfnConfigRulePropsMixin.ScopeProperty`
Python	`aws_cdk.cfn_property_mixins.aws_config.CfnConfigRulePropsMixin.ScopeProperty`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_config` » `CfnConfigRulePropsMixin` » `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 { aws_config as config } from '@aws-cdk/cfn-property-mixins';
const scopeProperty: config.CfnConfigRulePropsMixin.ScopeProperty = {
  complianceResourceId: 'complianceResourceId',
  complianceResourceTypes: ['complianceResourceTypes'],
  tagKey: 'tagKey',
  tagValue: 'tagValue',
};

Properties

Name	Type	Description
complianceResourceId?	`string \|` `IVolumeRef`	The ID of the only AWS resource that you want to trigger an evaluation for the rule.
complianceResourceTypes?	`string[]`	The resource types of only those AWS resources that you want to trigger an evaluation for the rule.
tagKey?	`string`	The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
tagValue?	`string`	The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.

complianceResourceId?

Type: string | IVolumeRef (optional)

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 .

complianceResourceTypes?

Type: string[] (optional)

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 .

tagKey?

Type: string (optional)

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

tagValue?

Type: string (optional)

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 .

AWS CDK

2.248.0