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

Inherits:

Struct

• Object
• Struct
• Aws::ConfigService::Types::RemediationConfiguration

Defined in:

gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  Amazon Resource Name (ARN) of remediation configuration.

• #automatic ⇒ Boolean

  The remediation is triggered automatically.

• #config_rule_name ⇒ String

  The name of the Config rule.

• #created_by_service ⇒ String

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

• #execution_controls ⇒ Types::ExecutionControls

  An ExecutionControls object.

• #maximum_automatic_attempts ⇒ Integer

  The maximum number of failed attempts for auto-remediation.

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

  An object of the RemediationParameterValue.

• #resource_type ⇒ String

  The type of a resource.

• #retry_attempt_seconds ⇒ Integer

  Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.

• #target_id ⇒ String

  Target ID is the name of the SSM document.

• #target_type ⇒ String

  The type of the target.

• #target_version ⇒ String

  Version of the target.

Instance Attribute Details

#arn ⇒ String

Amazon Resource Name (ARN) of remediation configuration.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

#automatic ⇒ Boolean

The remediation is triggered automatically.

Returns:

• (Boolean)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

#config_rule_name ⇒ String

The name of the Config rule.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

#created_by_service ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

#execution_controls ⇒ Types::ExecutionControls

An ExecutionControls object.

Returns:

• (Types::ExecutionControls)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Integer)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

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

An object of the RemediationParameterValue.

Returns:

• (Hash<String,Types::RemediationParameterValue>)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of a resource.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

#retry_attempt_seconds ⇒ Integer

Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If MaximumAutomaticAttempts remediation attempts have been made under RetryAttemptSeconds, a remediation exception will be added to the resource. 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 adding a remediation exception to the resource.

Returns:

• (Integer)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

#target_id ⇒ String

Target ID is the name of the SSM document.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

#target_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8589

class RemediationConfiguration < Struct.new(
  :config_rule_name,
  :target_type,
  :target_id,
  :target_version,
  :parameters,
  :resource_type,
  :automatic,
  :execution_controls,
  :maximum_automatic_attempts,
  :retry_attempt_seconds,
  :arn,
  :created_by_service)
  SENSITIVE = []
  include Aws::Structure
end