AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 4.5
An AWS Lambda function that 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 or delivers a configuration snapshot.

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

Inheritance Hierarchy


Namespace: Amazon.ConfigService.Model
Assembly: AWSSDK.dll
Version: (assembly version)


public class ConfigRule : Object

The ConfigRule type exposes the following members


Public Method ConfigRule()


Public Property ConfigRuleArn System.String Gets and sets the property ConfigRuleArn.

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

Public Property ConfigRuleId System.String Gets and sets the property ConfigRuleId.

The ID of the AWS Config rule.

Public Property ConfigRuleName System.String 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.

Public Property ConfigRuleState Amazon.ConfigService.ConfigRuleState 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 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.

Public Property Description System.String Gets and sets the property Description.

The description that you provide for the AWS Config rule.

Public Property InputParameters System.String Gets and sets the property InputParameters.

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

Public Property MaximumExecutionFrequency Amazon.ConfigService.MaximumExecutionFrequency 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 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.

Public Property Scope Amazon.ConfigService.Model.Scope 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.

Public Property Source Amazon.ConfigService.Model.Source 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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5