configservice_put_remediation_configurations: Adds or updates the remediation configuration with a specific...

Description Usage Arguments Value Request syntax

View source: R/configservice_operations.R

Description

Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the RemediationConfiguration object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.

If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.

This API does not support adding remediation configurations for service-linked AWS Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by AWS Security Hub.

Usage

1

Arguments

RemediationConfigurations

[required] A list of remediation configuration objects.

Value

A list with the following 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
38
39
list(
  FailedBatches = list(
    list(
      FailureMessage = "string",
      FailedItems = list(
        list(
          ConfigRuleName = "string",
          TargetType = "SSM_DOCUMENT",
          TargetId = "string",
          TargetVersion = "string",
          Parameters = list(
            list(
              ResourceValue = list(
                Value = "RESOURCE_ID"
              ),
              StaticValue = list(
                Values = list(
                  "string"
                )
              )
            )
          ),
          ResourceType = "string",
          Automatic = TRUE|FALSE,
          ExecutionControls = list(
            SsmControls = list(
              ConcurrentExecutionRatePercentage = 123,
              ErrorPercentage = 123
            )
          ),
          MaximumAutomaticAttempts = 123,
          RetryAttemptSeconds = 123,
          Arn = "string",
          CreatedByService = "string"
        )
      )
    )
  )
)

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
svc$put_remediation_configurations(
  RemediationConfigurations = list(
    list(
      ConfigRuleName = "string",
      TargetType = "SSM_DOCUMENT",
      TargetId = "string",
      TargetVersion = "string",
      Parameters = list(
        list(
          ResourceValue = list(
            Value = "RESOURCE_ID"
          ),
          StaticValue = list(
            Values = list(
              "string"
            )
          )
        )
      ),
      ResourceType = "string",
      Automatic = TRUE|FALSE,
      ExecutionControls = list(
        SsmControls = list(
          ConcurrentExecutionRatePercentage = 123,
          ErrorPercentage = 123
        )
      ),
      MaximumAutomaticAttempts = 123,
      RetryAttemptSeconds = 123,
      Arn = "string",
      CreatedByService = "string"
    )
  )
)

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