# RuleProps

Construction properties for a new rule.

- Source: [`aws-config/lib/rule.ts`](https://github.com/aws/aws-cdk/blob/v2.276.0/packages/aws-cdk-lib/aws-config/lib/rule.ts#L240)
- Type last changed: v2.145.0 · 7 Jun 2024

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_config as config } from 'aws-cdk-lib';

declare const evaluationMode: config.EvaluationMode;
declare const inputParameters: any;
declare const ruleScope: config.RuleScope;
const ruleProps: config.RuleProps = {
  configRuleName: 'configRuleName',
  description: 'description',
  evaluationModes: evaluationMode,
  inputParameters: {
    inputParametersKey: inputParameters,
  },
  maximumExecutionFrequency: config.MaximumExecutionFrequency.ONE_HOUR,
  ruleScope: ruleScope,
};
```

## Properties

- `configRuleName`: string — A name for the AWS Config rule.

  **Default:** CloudFormation generated name

- `description`: string — A description about this AWS Config rule.

  **Default:** No description

- `evaluationModes`: [EvaluationMode](/cdk/api/v2/docs/aws-cdk-lib.aws_config.EvaluationMode.html) — The modes the AWS Config rule can be evaluated in.

  **Default:** Detective evaluation mode only

  The valid values are distinct objects.

- `inputParameters`: { [key: string]: any } — Input parameter values that are passed to the AWS Config rule.

  **Default:** No input parameters

- `maximumExecutionFrequency`: [MaximumExecutionFrequency](/cdk/api/v2/docs/aws-cdk-lib.aws_config.MaximumExecutionFrequency.html) — The maximum frequency at which the AWS Config rule runs evaluations.

  **Default:** MaximumExecutionFrequency.TWENTY_FOUR_HOURS

- `ruleScope`: [RuleScope](/cdk/api/v2/docs/aws-cdk-lib.aws_config.RuleScope.html) — 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.