Interface RuleProps

All Superinterfaces:
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
Construction properties for a new rule.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object inputParameters;
 RuleScope ruleScope;
 RuleProps ruleProps = RuleProps.builder()
                 "inputParametersKey", inputParameters))
  • 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

    • 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()
      a RuleProps.Builder of RuleProps