You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ConfigService::Types::RemediationConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RemediationConfiguration as input to an Aws::Client method, you can use a vanilla 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",
}

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

Amazon Resource Name (ARN) of remediation configuration.

Returns:

  • (String) —

    Amazon Resource Name (ARN) of remediation configuration.

#automatic ⇒ Boolean

The remediation is triggered automatically.

Returns:

  • (Boolean) —

    The remediation is triggered automatically.

#config_rule_name ⇒ String

The name of the AWS Config rule.

Returns:

  • (String) —

    The name of the AWS Config rule.

#created_by_service ⇒ String

Name of the service that owns the service linked rule, if applicable.

Returns:

  • (String) —

    Name of the service that owns the service linked rule, if applicable.

#execution_controls ⇒ Types::ExecutionControls

An ExecutionControls object.

Returns:

#maximum_automatic_attempts ⇒ Integer

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 RetryAttemptsSeconds as 50 seconds, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

Returns:

  • (Integer) —

    The maximum number of failed attempts for auto-remediation.

#parameters ⇒ Hash<String,Types::RemediationParameterValue>

An object of the RemediationParameterValue.

Returns:

#resource_type ⇒ String

The type of a resource.

Returns:

  • (String) —

    The type of a resource.

#retry_attempt_seconds ⇒ Integer

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

For example, if you specify RetryAttemptsSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

Returns:

  • (Integer) —

    Maximum time in seconds that AWS Config runs auto-remediation.

#target_id ⇒ String

Target ID is the name of the public document.

Returns:

  • (String) —

    Target ID is the name of the public document.

#target_type ⇒ String

The type of the target. Target executes remediation. For example, SSM document.

Possible values:

  • SSM_DOCUMENT

Returns:

  • (String) —

    The type of the target.

#target_version ⇒ String

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

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

Returns:

  • (String) —

    Version of the target.