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
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
-
#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
Maximum time in seconds that Config runs auto-remediation.
-
#target_id ⇒ String
Target ID is the name of the public 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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
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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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 public document.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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.
7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7837 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 |