RemediationConfiguration - AWS Config

RemediationConfiguration

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

Contents

ConfigRuleName

The name of the AWS Config rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

TargetId

Target ID is the name of the SSM document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

TargetType

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

Type: String

Valid Values: SSM_DOCUMENT

Required: Yes

Arn

Amazon Resource Name (ARN) of remediation configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Automatic

The remediation is triggered automatically.

Type: Boolean

Required: No

CreatedByService

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

ExecutionControls

An ExecutionControls object.

Type: ExecutionControls object

Required: No

MaximumAutomaticAttempts

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

Parameters

An object of the RemediationParameterValue.

Type: String to RemediationParameterValue object map

Map Entries: Minimum number of 0 items. Maximum number of 25 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

ResourceType

The type of a resource.

Type: String

Required: No

RetryAttemptSeconds

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, AWS Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 2678000.

Required: No

TargetVersion

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

Note

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: