class Aws::ConfigService::Types::RemediationConfiguration

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

@note When making an API call, you may pass RemediationConfiguration

data as a hash:

    {
      config_rule_name: "ConfigRuleName", # required
      target_type: "SSM_DOCUMENT", # required, accepts SSM_DOCUMENT
      target_id: "StringWithCharLimit256", # required
      target_version: "String",
      parameters: {
        "StringWithCharLimit256" => {
          resource_value: {
            value: "RESOURCE_ID", # required, accepts RESOURCE_ID
          },
          static_value: {
            values: ["StringWithCharLimit256"], # required
          },
        },
      },
      resource_type: "String",
      automatic: false,
      execution_controls: {
        ssm_controls: {
          concurrent_execution_rate_percentage: 1,
          error_percentage: 1,
        },
      },
      maximum_automatic_attempts: 1,
      retry_attempt_seconds: 1,
      arn: "StringWithCharLimit1024",
      created_by_service: "StringWithCharLimit1024",
    }

@!attribute [rw] config_rule_name

The name of the Config rule.
@return [String]

@!attribute [rw] target_type

The type of the target. Target executes remediation. For example,
SSM document.
@return [String]

@!attribute [rw] target_id

Target ID is the name of the public document.
@return [String]

@!attribute [rw] target_version

Version of the target. For example, version of the SSM document.

<note markdown="1"> If you make backward incompatible changes to the SSM document, you
must call PutRemediationConfiguration API again to ensure the
remediations can run.

 </note>
@return [String]

@!attribute [rw] parameters

An object of the RemediationParameterValue.
@return [Hash<String,Types::RemediationParameterValue>]

@!attribute [rw] resource_type

The type of a resource.
@return [String]

@!attribute [rw] automatic

The remediation is triggered automatically.
@return [Boolean]

@!attribute [rw] execution_controls

An ExecutionControls object.
@return [Types::ExecutionControls]

@!attribute [rw] maximum_automatic_attempts

The maximum number of failed attempts for auto-remediation. If you
do not select a number, the default is 5.

For example, if you specify MaximumAutomaticAttempts as 5 with
RetryAttemptSeconds as 50 seconds, Config will put a
RemediationException on your behalf for the failing resource after
the 5th failed attempt within 50 seconds.
@return [Integer]

@!attribute [rw] retry_attempt_seconds

Maximum time in seconds that Config runs auto-remediation. If you do
not select a number, the default is 60 seconds.

For example, if you specify RetryAttemptSeconds as 50 seconds and
MaximumAutomaticAttempts as 5, Config will run auto-remediations 5
times within 50 seconds before throwing an exception.
@return [Integer]

@!attribute [rw] arn

Amazon Resource Name (ARN) of remediation configuration.
@return [String]

@!attribute [rw] created_by_service

Name of the service that owns the service linked rule, if
applicable.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/RemediationConfiguration AWS API Documentation

Constants

SENSITIVE