Package software.amazon.awscdk.services.config

Class ManagedRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.config.ManagedRule

All Implemented Interfaces:

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

Direct Known Subclasses:

AccessKeysRotated, CloudFormationStackDriftDetectionCheck, CloudFormationStackNotificationCheck

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-17T05:10:07.912Z")
@Stability(Stable)
public class ManagedRule
extends Resource
implements IRule

A new managed rule.

Example:

 // https://docs.aws.amazon.com/config/latest/developerguide/access-keys-rotated.html
 // https://docs.aws.amazon.com/config/latest/developerguide/access-keys-rotated.html
 ManagedRule.Builder.create(this, "AccessKeysRotated")
         .identifier(ManagedRuleIdentifiers.ACCESS_KEYS_ROTATED)
         .inputParameters(Map.of(
                 "maxAccessKeyAge", 60))
         // default is 24 hours
         .maximumExecutionFrequency(MaximumExecutionFrequency.TWELVE_HOURS)
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

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

IRule.Jsii$Default, IRule.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ManagedRule

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

ManagedRule

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

ManagedRule

@Stability(Stable)
public ManagedRule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ManagedRuleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromConfigRuleName

@Stability(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(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(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(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(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(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(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(Stable)
@NotNull
public String getConfigRuleArn()

The arn of the rule.

getConfigRuleComplianceType

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

The compliance status of the rule.

getConfigRuleId

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

The id of the rule.

getConfigRuleName

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

The name of the rule.

Specified by:

getConfigRuleName in interface IRule

getIsCustomWithChanges

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

setIsCustomWithChanges

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

getIsManaged

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

setIsManaged

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

getRuleScope

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

setRuleScope

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