AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
Version: (assembly version)
public class ConfigRule : Object
The ConfigRule type exposes the following members
Gets and sets the property ConfigRuleArn.
The Amazon Resource Name (ARN) of the AWS Config rule.
Gets and sets the property ConfigRuleId.
The ID of the AWS Config rule.
Gets and sets the property ConfigRuleName.
The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
Gets and sets the property ConfigRuleState.
Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
AWS Config sets the state of a rule to
You cannot add a rule to AWS Config that has the state set to
Gets and sets the property Description.
The description that you provide for the AWS Config rule.
Gets and sets the property InputParameters.
A string in JSON format that is passed to the AWS Config rule Lambda function.
Gets and sets the property MaximumExecutionFrequency.
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
Gets and sets the property 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.
Gets and sets the property Source.
Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
Supported in: 4.5, 4.0, 3.5