aws-cdk-lib.aws_config.IRule

IRule Interface

Interface representing an AWS Config rule.

IRule

extends

• IResource,
• IConfigRuleRef

implemented by

• AccessKeysRotated,
• CloudFormationStackDriftDetectionCheck,
• 4 more

  • CloudFormationStackNotificationCheck,
  • CustomPolicy,
  • CustomRule,
  • ManagedRule

Source

aws-config/lib/rule.ts

Type last changed

v2.236.0 · 23 Jan 2026

Properties

configRuleNamestringconfig_rule_namestrconfigRuleNameStringConfigRuleNamestringConfigRuleName*string#

The name of the rule.

configRuleRefConfigRuleReferenceconfig_rule_refConfigRuleReferenceconfigRuleRefConfigRuleReferenceConfigRuleRefConfigRuleReferenceConfigRuleRefConfigRuleReference#

A reference to a ConfigRule resource.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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: string, options?: OnEventOptions): Ruledef on_compliance_change(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onComplianceChange(String id, OnEventOptions options)public Rule OnComplianceChange(string id, OnEventOptions? options = null)func OnComplianceChange(Id *string, Options OnEventOptions) Rule#

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

onEvent(id: string, options?: OnEventOptions): Ruledef on_event(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onEvent(String id, OnEventOptions options)public Rule OnEvent(string id, OnEventOptions? options = null)func OnEvent(Id *string, Options OnEventOptions) Rule#

Defines an EventBridge event rule which triggers for rule events.

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

onReEvaluationStatus(id: string, options?: OnEventOptions): Ruledef on_re_evaluation_status(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onReEvaluationStatus(String id, OnEventOptions options)public Rule OnReEvaluationStatus(string id, OnEventOptions? options = null)func OnReEvaluationStatus(Id *string, Options OnEventOptions) Rule#

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

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining