software.amazon.awscdk.services.config

Interface IRule.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IRule, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IRule.Jsii$Proxy

Enclosing interface:

IRule

@Internal
public static interface IRule.Jsii$Default
extends IRule, IResource.Jsii$Default

Internal default implementation for IRule.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.config.IRule

IRule.Jsii$Default, IRule.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default String	getConfigRuleName() The name of the rule.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default Rule	onComplianceChange(String id, OnEventOptions options) Defines a EventBridge event rule which triggers for rule compliance events.
default Rule	onEvent(String id, OnEventOptions options) Defines an EventBridge event rule which triggers for rule events.
default 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.services.config.IRule

onComplianceChange, onEvent, onReEvaluationStatus

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getConfigRuleName

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

The name of the rule.

Specified by:

getConfigRuleName in interface IRule

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy 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).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

onComplianceChange

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

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

Specified by:

onComplianceChange in interface IRule

Parameters:

id - This parameter is required.

options -

onEvent

@Stability(value=Stable)
 @NotNull
default 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.

Specified by:

onEvent in interface IRule

Parameters:

id - This parameter is required.

options -

onReEvaluationStatus

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

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

Specified by:

onReEvaluationStatus in interface IRule

Parameters:

id - This parameter is required.

options -