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
IRule
.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.config.IRule
IRule.Jsii$Default, IRule.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.default String
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 Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getConfigRuleName
The name of the rule.- Specified by:
getConfigRuleName
in interfaceIRule
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
onComplianceChange
@Stability(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 interfaceIRule
- Parameters:
id
- This parameter is required.options
-
-
onEvent
@Stability(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. -
onReEvaluationStatus
@Stability(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 interfaceIRule
- Parameters:
id
- This parameter is required.options
-
-