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.

Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.

You can use this action for custom Config rules and AWS managed Config rules. A custom Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.

If you are adding a new custom Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About AWS Managed Config Rules.

For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules.

If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.

The maximum number of rules that AWS Config supports is 50.

For more information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

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

Note:

For PCL this operation is only available in asynchronous form. Please refer to PutConfigRuleAsync.

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

Syntax

C#
public virtual PutConfigRuleResponse PutConfigRule(
         PutConfigRuleRequest request
)
Parameters
request
Type: Amazon.ConfigService.Model.PutConfigRuleRequest

Container for the necessary parameters to execute the PutConfigRule service method.

Return Value
The response from the PutConfigRule service method, as returned by ConfigService.

Exceptions

ExceptionCondition
InsufficientPermissionsException Indicates one of the following errors: The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action. The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
InvalidParameterValueException One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.
MaxNumberOfConfigRulesExceededException Failed to add the AWS Config rule because the account already contains the maximum number of 50 rules. Consider deleting any deactivated rules before adding new rules.
NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
ResourceInUseException The rule is currently being deleted or the rule is deleting your evaluation results. Try your request again later.

Version Information

.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

See Also