1.204.0

interface ScopeProperty

LanguageType name
.NETAmazon.CDK.AWS.Config.CfnConfigRule.ScopeProperty
Javasoftware.amazon.awscdk.services.config.CfnConfigRule.ScopeProperty
Pythonaws_cdk.aws_config.CfnConfigRule.ScopeProperty
TypeScript @aws-cdk/aws-config » 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 * as config from '@aws-cdk/aws-config';
const scopeProperty: config.CfnConfigRule.ScopeProperty = {
  complianceResourceId: 'complianceResourceId',
  complianceResourceTypes: ['complianceResourceTypes'],
  tagKey: 'tagKey',
  tagValue: 'tagValue',
};

Properties

NameTypeDescription
complianceResourceId?stringThe 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?stringThe tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
tagValue?stringThe tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.

complianceResourceId?

Type: string (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 .

← PreviousNext →