configservice_put_config_rule: Adds or updates an AWS Config rule for evaluating whether...

Description Usage Arguments Value Request syntax

View source: R/configservice_operations.R

Description

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 AWS Config rules and AWS managed Config rules. A custom AWS 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 AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the put_config_rule 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 150.

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

Usage

1

Arguments

ConfigRule

[required] The rule that you want to add to your account.

Tags

An array of tag object.

Value

An empty list.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
svc$put_config_rule(
  ConfigRule = list(
    ConfigRuleName = "string",
    ConfigRuleArn = "string",
    ConfigRuleId = "string",
    Description = "string",
    Scope = list(
      ComplianceResourceTypes = list(
        "string"
      ),
      TagKey = "string",
      TagValue = "string",
      ComplianceResourceId = "string"
    ),
    Source = list(
      Owner = "CUSTOM_LAMBDA"|"AWS",
      SourceIdentifier = "string",
      SourceDetails = list(
        list(
          EventSource = "aws.config",
          MessageType = "ConfigurationItemChangeNotification"|"ConfigurationSnapshotDeliveryCompleted"|"ScheduledNotification"|"OversizedConfigurationItemChangeNotification",
          MaximumExecutionFrequency = "One_Hour"|"Three_Hours"|"Six_Hours"|"Twelve_Hours"|"TwentyFour_Hours"
        )
      )
    ),
    InputParameters = "string",
    MaximumExecutionFrequency = "One_Hour"|"Three_Hours"|"Six_Hours"|"Twelve_Hours"|"TwentyFour_Hours",
    ConfigRuleState = "ACTIVE"|"DELETING"|"DELETING_RESULTS"|"EVALUATING",
    CreatedBy = "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.