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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb

Overview

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",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

Amazon Resource Name (ARN) of remediation configuration.

Returns:

  • (String)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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

#automaticBoolean

The remediation is triggered automatically.

Returns:

  • (Boolean)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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_nameString

The name of the AWS Config rule.

Returns:

  • (String)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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_serviceString

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

Returns:

  • (String)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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_controlsTypes::ExecutionControls

An ExecutionControls object.



7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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_attemptsInteger

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

Returns:

  • (Integer)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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

#parametersHash<String,Types::RemediationParameterValue>

An object of the RemediationParameterValue.

Returns:



7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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_typeString

The type of a resource.

Returns:

  • (String)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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_secondsInteger

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 RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

Returns:

  • (Integer)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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_idString

Target ID is the name of the public document.

Returns:

  • (String)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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_typeString

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

Returns:

  • (String)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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_versionString

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)


7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7431

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