software.amazon.awscdk.services.config

Class CustomRule

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.config.CustomRule

All Implemented Interfaces:

IConstruct, IDependable, IResource, IRule

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.786Z")
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 interface software.amazon.awscdk.services.config.IRule

IRule.Jsii$Default, IRule.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

CustomRule

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

CustomRule

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

CustomRule

public CustomRule(software.constructs.Construct scope,
                  java.lang.String id,
                  CustomRuleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromConfigRuleName

public static IRule fromConfigRuleName(software.constructs.Construct scope,
                                       java.lang.String id,
                                       java.lang.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

public Rule onComplianceChange(java.lang.String id,
                               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

public Rule onComplianceChange(java.lang.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

public Rule onEvent(java.lang.String id,
                    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

public Rule onEvent(java.lang.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

public Rule onReEvaluationStatus(java.lang.String id,
                                 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

public Rule onReEvaluationStatus(java.lang.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

public java.lang.String getConfigRuleArn()

The arn of the rule.

getConfigRuleComplianceType

public java.lang.String getConfigRuleComplianceType()

The compliance status of the rule.

getConfigRuleId

public java.lang.String getConfigRuleId()

The id of the rule.

getConfigRuleName

public java.lang.String getConfigRuleName()

The name of the rule.

Specified by:

getConfigRuleName in interface IRule

getIsCustomWithChanges

protected java.lang.Boolean getIsCustomWithChanges()

setIsCustomWithChanges

protected void setIsCustomWithChanges(java.lang.Boolean value)

getIsManaged

protected java.lang.Boolean getIsManaged()

setIsManaged

protected void setIsManaged(java.lang.Boolean value)

getRuleScope

protected RuleScope getRuleScope()

setRuleScope

protected void setRuleScope(RuleScope value)