interface IRule

Language	Type name
.NET	Amazon.CDK.AWS.Config.IRule
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsconfig#IRule
Java	software.amazon.awscdk.services.config.IRule
Python	aws_cdk.aws_config.IRule
TypeScript (source)	aws-cdk-lib » aws_config » IRule

Implemented by AccessKeysRotated, CloudFormationStackDriftDetectionCheck, CloudFormationStackNotificationCheck, CustomPolicy, CustomRule, ManagedRule

Obtainable from CustomPolicy.fromConfigRuleName(), CustomRule.fromConfigRuleName(), ManagedRule.fromConfigRuleName()

Interface representing an AWS Config rule.

Properties

Name	Type	Description
configRuleName	string	The name of the rule.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

configRuleName

Type: string

The name of the rule.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
onComplianceChange(id, options?)	Defines a EventBridge event rule which triggers for rule compliance events.
onEvent(id, options?)	Defines an EventBridge event rule which triggers for rule events.
onReEvaluationStatus(id, options?)	Defines a EventBridge event rule which triggers for rule re-evaluation status events.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

onComplianceChange(id, options?)

public onComplianceChange(id: string, options?: OnEventOptions): Rule

Parameters

• id string
• options OnEventOptions

Returns

• Rule

Defines a EventBridge event rule which triggers for rule compliance events.

---

onEvent(id, options?)

public onEvent(id: string, options?: OnEventOptions): Rule

Parameters

• id string
• options OnEventOptions

Returns

• Rule

Defines an EventBridge event rule which triggers for rule events.

Use rule.addEventPattern(pattern) to specify a filter.

---

onReEvaluationStatus(id, options?)

public onReEvaluationStatus(id: string, options?: OnEventOptions): Rule

Parameters

• id string
• options OnEventOptions

Returns

• Rule

Defines a EventBridge event rule which triggers for rule re-evaluation status events.