AWS SDK Version 3 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.

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).

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.

Inheritance Hierarchy

System.Object
  Amazon.ConfigService.Model.ConfigRule

Namespace: Amazon.ConfigService.Model
Assembly: AWSSDK.ConfigService.dll
Version: 3.x.y.z

Syntax

C#
public class ConfigRule

The ConfigRule type exposes the following members

Constructors

NameDescription
Public Method ConfigRule()

Properties

NameTypeDescription
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 is currently being deleted by AWS Config. It can also indicate the evaluation status for the 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 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 Config rule.

AWS Config sets the state of a rule to DELETING temporarily 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.

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 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.

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

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 notifications that cause the function to evaluate your AWS resources.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms