ConfigRule

The Amazon Resource Name (ARN) of the AWS Config rule.

The ID of the AWS Config rule.

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

The description that you provide for the AWS Config rule.

A string in JSON format that is passed to the AWS Config rule Lambda function.

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

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.