interface IRule
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Config.IRule |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsconfig#IRule |
![]() | software.amazon.awscdk.services.config.IRule |
![]() | aws_cdk.aws_config.IRule |
![]() | aws-cdk-lib » aws_config » IRule |
Implemented by
Access
, Cloud
, Cloud
, Custom
, Custom
, Managed
Obtainable from
Custom
.fromConfigRuleName()
, Custom
.fromConfigRuleName()
, Managed
.fromConfigRuleName()
Interface representing an AWS Config rule.
Properties
Name | Type | Description |
---|---|---|
config | string | The name of the rule. |
env | Resource | 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:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that 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 |
---|---|
apply | Apply the given removal policy to this resource. |
on | Defines a EventBridge event rule which triggers for rule compliance events. |
on | Defines an EventBridge event rule which triggers for rule events. |
on | Defines a EventBridge event rule which triggers for rule re-evaluation status events. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
On
Event Options
Returns
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
On
Event Options
Returns
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
On
Event Options
Returns
Defines a EventBridge event rule which triggers for rule re-evaluation status events.