Package software.amazon.awscdk.services.config

Interface RuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AccessKeysRotatedProps, CloudFormationStackDriftDetectionCheckProps, CloudFormationStackNotificationCheckProps, CustomPolicyProps, CustomRuleProps, ManagedRuleProps

All Known Implementing Classes:

AccessKeysRotatedProps.Jsii$Proxy, CloudFormationStackDriftDetectionCheckProps.Jsii$Proxy, CloudFormationStackNotificationCheckProps.Jsii$Proxy, CustomPolicyProps.Jsii$Proxy, CustomRuleProps.Jsii$Proxy, ManagedRuleProps.Jsii$Proxy, RuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:34.302Z")
@Stability(Stable)
public interface RuleProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for a new rule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 EvaluationMode evaluationMode;
 Object inputParameters;
 RuleScope ruleScope;
 RuleProps ruleProps = RuleProps.builder()
         .configRuleName("configRuleName")
         .description("description")
         .evaluationModes(evaluationMode)
         .inputParameters(Map.of(
                 "inputParametersKey", inputParameters))
         .maximumExecutionFrequency(MaximumExecutionFrequency.ONE_HOUR)
         .ruleScope(ruleScope)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RuleProps.Builder	A builder for RuleProps
static final class	RuleProps.Jsii$Proxy	An implementation for RuleProps

Method Summary

Modifier and Type	Method	Description
static RuleProps.Builder	builder()
default String	getConfigRuleName()	A name for the AWS Config rule.
default String	getDescription()	A description about this AWS Config rule.
default EvaluationMode	getEvaluationModes()	The modes the AWS Config rule can be evaluated in.
default Map<String,Object>	getInputParameters()	Input parameter values that are passed to the AWS Config rule.
default MaximumExecutionFrequency	getMaximumExecutionFrequency()	The maximum frequency at which the AWS Config rule runs evaluations.
default RuleScope	getRuleScope()	Defines which resources trigger an evaluation for an AWS Config rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigRuleName

@Stability(Stable)
@Nullable
default String getConfigRuleName()

A name for the AWS Config rule.

Default: - CloudFormation generated name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description about this AWS Config rule.

Default: - No description

getEvaluationModes

@Stability(Stable)
@Nullable
default EvaluationMode getEvaluationModes()

The modes the AWS Config rule can be evaluated in.

The valid values are distinct objects.

Default: - Detective evaluation mode only

getInputParameters

@Stability(Stable)
@Nullable
default Map<String,Object> getInputParameters()

Input parameter values that are passed to the AWS Config rule.

Default: - No input parameters

getMaximumExecutionFrequency

@Stability(Stable)
@Nullable
default MaximumExecutionFrequency getMaximumExecutionFrequency()

The maximum frequency at which the AWS Config rule runs evaluations.

Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS

getRuleScope

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

Defines which resources trigger an evaluation for an AWS Config rule.

Default: - evaluations for the rule are triggered when any resource in the recording group changes.

builder

@Stability(Stable)
static RuleProps.Builder builder()

Returns:

a RuleProps.Builder of RuleProps