Adding, Updating, and Deleting Amazon Config Rules

To add a rule

1. Sign in to the Amazon Web Services Management Console and open the Amazon Config console at https://console.amazonaws.cn/config/.

2. In the Amazon Web Services Management Console menu, verify that the region selector is set to a region that supports Amazon Config rules. For the list of supported regions, see Amazon Config Regions and Endpoints in the Amazon Web Services General Reference.

3. In the left navigation, choose Rules.

4. On the Rules page, choose Add rule.

5. On the Specify rule type page, specify the rule type by completing the following steps:

   1. Type in the search field to filter the list of managed rules by rule name, description, and label. For example, type EC2 to return rules that evaluate EC2 resource types or type periodic to return rules that are triggered periodically.

   2. You can also create your own custom rule. Choose Create custom rule using Lambda or Create custom rule using Guard, and follow the procedure in Creating Amazon Config Custom Lambda Rules or Creating Amazon Config Custom Policy Rules.

6. On the Configure rule page, configure your rule by completing the following steps:

   1. For Name, type a unique name for the rule.

   2. For Description, type a description for the rule.

   3. For Evaluation mode, choose when in the resource creation and management process you want Amazon Config to evaluate your resources. Depending on the rule, Amazon Config can evaluate your resource configurations before a resource has been deployed, after a resource has been deployed, or both.

      1. Choose Turn on proactive evaluation to allow you to run evaluations on the configuration settings of your resources before they are deployed.

         Once you have turned on proactive evaluation, you can use the StartResourceEvaluation API and GetResourceEvaluationSummary API to check if the resources you specify in these commands would be flagged as NON_COMPLIANT by the proactive rules in your account in your Region.

         For more information on using this commands, see Evaluating Your Resources with Amazon Config Rules. For a list of managed rules that support proactive evaluation, see List of Amazon Config Managed Rules by Evaluation Mode.

      2. Choose Turn on detective evaluation to evaluate the configuration settings of your existing resources.

         For detective evaluation, there are two types of triggers: When configuration changes and Periodic.

         1. If the trigger types for your rule include Configuration changes, specify one of the following options for Scope of changes with which Amazon Config invokes your Lambda function:

            • Resources – When a resource that matches the specified resource type, or the type plus identifier, is created, changed, or deleted.

            • Tags – When a resource with the specified tag is created, changed, or deleted.

            • All changes – When a resource recorded by Amazon Config is created, changed, or deleted.

            Amazon Config runs the evaluation when it detects a change to a resource that matches the rule's scope. You can use the scope to define which resources initiate evaluations.

         2. If the trigger types for your rule include Periodic, specify the Frequency with which Amazon Config invokes your Lambda function.

   4. For Parameters, you can customize the values for the provided keys if your rule includes parameters. A parameter is an attribute that your resources must adhere to before they are considered compliant with the rule.

7. On the Review and create page, review all your selections before adding the rule to your Amazon account. If your rule is not working as expected, you might see one of the following for Compliance:

   • No results reported - Amazon Config evaluated your resources against the rule. The rule did not apply to the Amazon resources in its scope, the specified resources were deleted, or the evaluation results were deleted. To get evaluation results, update the rule, change its scope, or choose Re-evaluate.

     This message may also appear if the rule didn't report evaluation results.

   • No resources in scope - Amazon Config cannot evaluate your recorded Amazon resources against this rule because none of your resources are within the rule’s scope. To get evaluation results, edit the rule and change its scope, or add resources for Amazon Config to record by using the Settings page.

   • Evaluations failed - For information that can help you determine the problem, choose the rule name to open its details page and see the error message.

To view your rules

1. Sign in to the Amazon Web Services Management Console and open the Amazon Config console at https://console.amazonaws.cn/config/.

2. In the Amazon Web Services Management Console menu, verify that the region selector is set to a region that supports Amazon Config rules. For the list of supported regions, see Amazon Config Regions and Endpoints in the Amazon Web Services General Reference.

3. In the left navigation, choose Rules.

4. The Rules page shows all the rule that are currently in your Amazon Web Services account. It lists the name, associated remediation action, and compliance status of each rule.

   • Choose Add rule to get started with creating a rule.

   • Choose a rule to see its settings, or choose a rule and View details.

   • See the compliance status of the rule when it evaluates your resources.

   • Choose a rule and Edit rule to change the configuration settings of the rule and set a remediation action for a noncompliant rule.

To update a rule

1. Sign in to the Amazon Web Services Management Console and open the Amazon Config console at https://console.amazonaws.cn/config/.

2. In the Amazon Web Services Management Console menu, verify that the region selector is set to a region that supports Amazon Config rules. For the list of supported regions, see Amazon Config Regions and Endpoints in the Amazon Web Services General Reference.

3. In the left navigation, choose Rules.

4. Choose a rule and Edit rule for the rule that you want to update.

5. Modify the settings on the Edit rule page to change your rule as needed.

6. Choose Save.

To delete a rule

1. Sign in to the Amazon Web Services Management Console and open the Amazon Config console at https://console.amazonaws.cn/config/.

2. In the Amazon Web Services Management Console menu, verify that the region selector is set to a region that supports Amazon Config rules. For the list of supported regions, see Amazon Config Regions and Endpoints in the Amazon Web Services General Reference.

3. In the left navigation, choose Rules.

4. Choose a rule from the table that you want to delete.

5. From the Actions dropdown list, choose Delete rule.

6. When prompted, type "Delete" (case-sensitive) and then choose Delete.

To turn on proactive evalution

1. Sign in to the Amazon Web Services Management Console and open the Amazon Config console at https://console.amazonaws.cn/config/.

2. In the Amazon Web Services Management Console menu, verify that the Region selector is set to a Region that supports Amazon Config rules. For the list of supported Amazon Regions, see Amazon Config Regions and Endpoints in the Amazon Web Services General Reference.

3. In the left navigation, choose Rules. For a list of managed rules that support proactive evaluation, see List of Amazon Config Managed Rules by Evaluation Mode.

4. Choose a rule, and then choose Edit rule for the rule that you want to update.

5. For Evaluation mode, choose Turn on proactive evaluation to allow you to run evaluations on the configuration settings of your resources before they are deployed.

6. Choose Save.

To view your rules

• Use the describe-config-rules command:

  $ aws configservice describe-config-rules

  Amazon Config returns the details for all of your rules.

To update or add a rule

1. Use the put-config-rule command with the --generate-cli-skeleton parameter to create a local JSON file that has the parameters for your rule:

   $ aws configservice put-config-rule --generate-cli-skeleton > putConfigRule.json

2. Open the JSON file in a text editor and remove any parameters that don't need updating, with the following exceptions:

   • Include at least one of the following parameters to identify the rule:

     ConfigRuleName, ConfigRuleArn, or ConfigRuleId.

   • If you are updating a custom rule, you must include the Source object and its parameters.

3. Fill in the values for the parameters that remain. To reference the details of your rule, use the describe-config-rules command.

   For example, the following JSON code updates the resource types that are in the scope of a custom rule:

   {
     "ConfigRule": {
       "ConfigRuleName": "ConfigRuleName",
       "Scope": {
         "ComplianceResourceTypes": [
           "AWS::EC2::Instance",
           "AWS::EC2::Volume",
           "AWS::EC2::VPC"
         ]
       },
       "Source": {
         "Owner": "CUSTOM_LAMBDA",
         "SourceIdentifier": "arn:aws:lambda:us-east-2:123456789012:function:ConfigRuleName",
         "SourceDetails": [
           {
             "EventSource": "aws.config",
             "MessageType": "ConfigurationItemChangeNotification"
           }
         ]
       }
     }
   }

4. Use the put-config-rule command with the --cli-input-json parameter to pass your JSON configuration to Amazon Config:

   $ aws configservice put-config-rule --cli-input-json file://putConfigRule.json

5. To verify that you successfully updated your rule, use the describe-config-rules command to view the rule's configuration:

   $ aws configservice describe-config-rules --config-rule-name ConfigRuleName
   {
       "ConfigRules": [
           {
               "ConfigRuleState": "ACTIVE",
               "ConfigRuleName": "ConfigRuleName",
               "ConfigRuleArn": "arn:aws:config:us-east-2:123456789012:config-rule/config-rule-nnnnnn",
               "Source": {
                   "Owner": "CUSTOM_LAMBDA",
                   "SourceIdentifier": "arn:aws:lambda:us-east-2:123456789012:function:ConfigRuleName",
                   "SourceDetails": [
                       {
                           "EventSource": "aws.config",
                           "MessageType": "ConfigurationItemChangeNotification"
                       }
                   ]
               },
               "Scope": {
                   "ComplianceResourceTypes": [
                       "AWS::EC2::Instance",
                       "AWS::EC2::Volume",
                       "AWS::EC2::VPC"
                   ]
               },
               "ConfigRuleId": "config-rule-nnnnnn"
           }
       ]
   }

To delete a rule

• Use the delete-config-rule command as shown in the following example:

  $ aws configservice delete-config-rule --config-rule-name ConfigRuleName