The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ConfigRule

An AWS Config rule represents an AWS Lambda function that you create for a custom rule or a predefined function for an AWS managed rule. The function evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change to an AWS resource and at a periodic frequency that you choose (for example, every 24 hours).

Note

You can use the AWS CLI and AWS SDKs if you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

ConfigRuleArn

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

Type: String

Required: No

ConfigRuleId

The ID of the AWS Config rule.

Type: String

Required: No

ConfigRuleName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

ConfigRuleState

Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the AWS Config rule.

AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the AWS Config rule.

AWS Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the AWS Config rule.

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

Type: String

Valid Values: ACTIVE | DELETING | DELETING_RESULTS | EVALUATING

Required: No

CreatedBy

Service principal name of the service that created the rule.

Note

The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Description

The description that you provide for the AWS Config rule.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

InputParameters

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

MaximumExecutionFrequency

The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

You are using an AWS managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

Note

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Type: String

Valid Values: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours

Required: No

Scope

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.

Type: Scope object

Required: No

Source

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

Type: Source object

Required: Yes

ConfigRule

Contents

See Also