software.amazon.awscdk.services.config

Class CustomRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.config.CustomRule

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.739Z")
 @Stability(value=Stable)
public class CustomRule
extends Resource
implements IRule

A new custom rule.

Example:

 // Lambda function containing logic that evaluates compliance with the rule.
 Function evalComplianceFn = Function.Builder.create(this, "CustomFunction")
         .code(AssetCode.fromInline("exports.handler = (event) => console.log(event);"))
         .handler("index.handler")
         .runtime(Runtime.NODEJS_14_X)
         .build();
 // A custom rule that runs on configuration changes of EC2 instances
 CustomRule customRule = CustomRule.Builder.create(this, "Custom")
         .configurationChanges(true)
         .lambdaFunction(evalComplianceFn)
         .ruleScope(RuleScope.fromResource(ResourceType.EC2_INSTANCE))
         .build();
 // A rule to detect stack drifts
 CloudFormationStackDriftDetectionCheck driftRule = new CloudFormationStackDriftDetectionCheck(this, "Drift");
 // Topic to which compliance notification events will be published
 Topic complianceTopic = new Topic(this, "ComplianceTopic");
 // Send notification on compliance change events
 driftRule.onComplianceChange("ComplianceChange", OnEventOptions.builder()
         .target(new SnsTopic(complianceTopic))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomRule.Builder A fluent builder for CustomRule.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IRule.Jsii$Default, IRule.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	CustomRule(software.constructs.Construct scope, String id, CustomRuleProps props)
protected	CustomRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CustomRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IRule	fromConfigRuleName(software.constructs.Construct scope, String id, String configRuleName) Imports an existing rule.
String	getConfigRuleArn() The arn of the rule.
String	getConfigRuleComplianceType() The compliance status of the rule.
String	getConfigRuleId() The id of the rule.
String	getConfigRuleName() The name of the rule.
protected Boolean	getIsCustomWithChanges()
protected Boolean	getIsManaged()
protected RuleScope	getRuleScope()
Rule	onComplianceChange(String id) Defines an EventBridge event rule which triggers for rule compliance events.
Rule	onComplianceChange(String id, OnEventOptions options) Defines an 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 an EventBridge event rule which triggers for rule re-evaluation status events.
Rule	onReEvaluationStatus(String id, OnEventOptions options) Defines an EventBridge event rule which triggers for rule re-evaluation status events.
protected void	setIsCustomWithChanges(Boolean value)
protected void	setIsManaged(Boolean value)
protected void	setRuleScope(RuleScope value)

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

CustomRule

protected CustomRule(software.amazon.jsii.JsiiObjectRef objRef)

CustomRule

protected CustomRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CustomRule

@Stability(value=Stable)
public CustomRule(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CustomRuleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromConfigRuleName

@Stability(value=Stable)
 @NotNull
public static IRule fromConfigRuleName(@NotNull
                                                                          software.constructs.Construct scope,
                                                                          @NotNull
                                                                          String id,
                                                                          @NotNull
                                                                          String configRuleName)

Imports an existing rule.

Parameters:

scope - This parameter is required.

id - This parameter is required.

configRuleName - the name of the rule. This parameter is required.

onComplianceChange

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

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

Specified by:

onComplianceChange in interface IRule

Parameters:

id - This parameter is required.

options -

onComplianceChange

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

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

Specified by:

onComplianceChange in interface IRule

Parameters:

id - This parameter is required.

onEvent

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

onEvent

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

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.

onReEvaluationStatus

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

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

Specified by:

onReEvaluationStatus in interface IRule

Parameters:

id - This parameter is required.

options -

onReEvaluationStatus

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

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

Specified by:

onReEvaluationStatus in interface IRule

Parameters:

id - This parameter is required.

getConfigRuleArn

@Stability(value=Stable)
 @NotNull
public String getConfigRuleArn()

The arn of the rule.

getConfigRuleComplianceType

@Stability(value=Stable)
 @NotNull
public String getConfigRuleComplianceType()

The compliance status of the rule.

getConfigRuleId

@Stability(value=Stable)
 @NotNull
public String getConfigRuleId()

The id of the rule.

getConfigRuleName

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

The name of the rule.

Specified by:

getConfigRuleName in interface IRule

getIsCustomWithChanges

@Stability(value=Stable)
 @Nullable
protected Boolean getIsCustomWithChanges()

setIsCustomWithChanges

@Stability(value=Stable)
protected void setIsCustomWithChanges(@Nullable
                                                               Boolean value)

getIsManaged

@Stability(value=Stable)
 @Nullable
protected Boolean getIsManaged()

setIsManaged

@Stability(value=Stable)
protected void setIsManaged(@Nullable
                                                     Boolean value)

getRuleScope

@Stability(value=Stable)
 @Nullable
protected RuleScope getRuleScope()

setRuleScope

@Stability(value=Stable)
protected void setRuleScope(@Nullable
                                                     RuleScope value)