software.amazon.awscdk.services.config

Interface IRule

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IRule.Jsii$Default

All Known Implementing Classes:

AccessKeysRotated, CloudFormationStackDriftDetectionCheck, CloudFormationStackNotificationCheck, CustomRule, IRule.Jsii$Proxy, ManagedRule

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.740Z")
 @Stability(value=Stable)
public interface IRule
extends software.amazon.jsii.JsiiSerializable, IResource

Interface representing an AWS Config rule.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IRule.Jsii$Default Internal default implementation for IRule.
static class	IRule.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
String	getConfigRuleName() The name of the rule.
Rule	onComplianceChange(String id) Defines a EventBridge event rule which triggers for rule compliance events.
Rule	onComplianceChange(String id, OnEventOptions options) Defines a EventBridge event rule which triggers for rule compliance events.
Rule	onEvent(String id) Defines an EventBridge event rule which triggers for rule events.
Rule	onEvent(String id, OnEventOptions options) Defines an EventBridge event rule which triggers for rule events.
Rule	onReEvaluationStatus(String id) Defines a EventBridge event rule which triggers for rule re-evaluation status events.
Rule	onReEvaluationStatus(String id, OnEventOptions options) Defines a EventBridge event rule which triggers for rule re-evaluation status events.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConfigRuleName

@Stability(value=Stable)
 @NotNull
String getConfigRuleName()

The name of the rule.

onComplianceChange

@Stability(value=Stable)
 @NotNull
Rule onComplianceChange(@NotNull
                                                           String id,
                                                           @Nullable
                                                           OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onComplianceChange

@Stability(value=Stable)
 @NotNull
Rule onComplianceChange(@NotNull
                                                           String id)

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

Parameters:

id - This parameter is required.

onEvent

@Stability(value=Stable)
 @NotNull
Rule onEvent(@NotNull
                                                String id,
                                                @Nullable
                                                OnEventOptions options)

Defines an EventBridge event rule which triggers for rule events.

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

Parameters:

id - This parameter is required.

options -

onEvent

@Stability(value=Stable)
 @NotNull
Rule onEvent(@NotNull
                                                String id)

Defines an EventBridge event rule which triggers for rule events.

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

Parameters:

id - This parameter is required.

onReEvaluationStatus

@Stability(value=Stable)
 @NotNull
Rule onReEvaluationStatus(@NotNull
                                                             String id,
                                                             @Nullable
                                                             OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onReEvaluationStatus

@Stability(value=Stable)
 @NotNull
Rule onReEvaluationStatus(@NotNull
                                                             String id)

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

Parameters:

id - This parameter is required.