Interface RuleProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
AccessKeysRotatedProps
,CloudFormationStackDriftDetectionCheckProps
,CloudFormationStackNotificationCheckProps
,CustomRuleProps
,ManagedRuleProps
- All Known Implementing Classes:
AccessKeysRotatedProps.Jsii$Proxy
,CloudFormationStackDriftDetectionCheckProps.Jsii$Proxy
,CloudFormationStackNotificationCheckProps.Jsii$Proxy
,CustomRuleProps.Jsii$Proxy
,ManagedRuleProps.Jsii$Proxy
,RuleProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:48.628Z")
@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.*; Object inputParameters; RuleScope ruleScope; RuleProps ruleProps = RuleProps.builder() .configRuleName("configRuleName") .description("description") .inputParameters(Map.of( "inputParametersKey", inputParameters)) .maximumExecutionFrequency(MaximumExecutionFrequency.ONE_HOUR) .ruleScope(ruleScope) .build();
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RuleProps.Builder
builder()
default String
A name for the AWS Config rule.default String
A description about this AWS Config rule.Input parameter values that are passed to the AWS Config rule.default MaximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.default RuleScope
Defines which resources trigger an evaluation for an AWS Config rule.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getConfigRuleName
A name for the AWS Config rule.Default: - CloudFormation generated name
-
getDescription
A description about this AWS Config rule.Default: - No description
-
getInputParameters
Input parameter values that are passed to the AWS Config rule.Default: - No input parameters
-
getMaximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS
-
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
- Returns:
- a
RuleProps.Builder
ofRuleProps
-