Skip to content

RemediationConfiguration

Source code in docs_src/capo_config_service/types/remediation_configuration.py
class RemediationConfiguration(TypedDict, closed=True):
    config_rule_name: "capo_config_service.types.config_rule_name.ConfigRuleName"
    """<p>The name of the Config rule.</p>"""
    target_type: (
        "capo_config_service.types.remediation_target_type.RemediationTargetType"
    )
    """<p>The type of the target. Target executes remediation. For example, SSM document.</p>"""
    target_id: (
        "capo_config_service.types.string_with_char_limit256.StringWithCharLimit256"
    )
    """<p>Target ID is the name of the SSM document.</p>"""
    target_version: NotRequired["capo_config_service.types.string.String"]
    """<p>Version of the target. For example, version of the SSM document.</p> <note> <p>If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.</p> </note>"""
    parameters: NotRequired[
        "capo_config_service.types.remediation_parameters.RemediationParameters"
    ]
    """<p>An object of the RemediationParameterValue.</p>"""
    resource_type: NotRequired["capo_config_service.types.string.String"]
    """<p>The type of a resource. </p>"""
    automatic: "capo_config_service.types.boolean.Boolean"
    """<p>The remediation is triggered automatically.</p>"""
    execution_controls: NotRequired[
        "capo_config_service.types.execution_controls.ExecutionControls"
    ]
    """<p>An ExecutionControls object.</p>"""
    maximum_automatic_attempts: NotRequired[
        "capo_config_service.types.auto_remediation_attempts.AutoRemediationAttempts"
    ]
    """<p>The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.</p> <p>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.</p>"""
    retry_attempt_seconds: NotRequired[
        "capo_config_service.types.auto_remediation_attempt_seconds.AutoRemediationAttemptSeconds"
    ]
    """<p>Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If <code>MaximumAutomaticAttempts</code> remediation attempts have been made under <code>RetryAttemptSeconds</code>, a remediation exception will be added to the resource. If you do not select a number, the default is 60 seconds. </p> <p>For example, if you specify <code>RetryAttemptSeconds</code> as 50 seconds and <code>MaximumAutomaticAttempts</code> as 5, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.</p>"""
    arn: NotRequired[
        "capo_config_service.types.string_with_char_limit1024.StringWithCharLimit1024"
    ]
    """<p>Amazon Resource Name (ARN) of remediation configuration.</p>"""
    created_by_service: NotRequired[
        "capo_config_service.types.string_with_char_limit1024.StringWithCharLimit1024"
    ]
    """<p>Name of the service that owns the service-linked rule, if applicable.</p>"""

arn instance-attribute

arn: NotRequired[StringWithCharLimit1024]

Amazon Resource Name (ARN) of remediation configuration.

automatic instance-attribute

automatic: Boolean

The remediation is triggered automatically.

config_rule_name instance-attribute

config_rule_name: ConfigRuleName

The name of the Config rule.

created_by_service instance-attribute

created_by_service: NotRequired[StringWithCharLimit1024]

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

execution_controls instance-attribute

execution_controls: NotRequired[ExecutionControls]

An ExecutionControls object.

maximum_automatic_attempts instance-attribute

maximum_automatic_attempts: NotRequired[AutoRemediationAttempts]

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.

parameters instance-attribute

parameters: NotRequired[RemediationParameters]

An object of the RemediationParameterValue.

resource_type instance-attribute

resource_type: NotRequired[String]

The type of a resource.

retry_attempt_seconds instance-attribute

retry_attempt_seconds: NotRequired[AutoRemediationAttemptSeconds]

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.

target_id instance-attribute

Target ID is the name of the SSM document.

target_type instance-attribute

target_type: RemediationTargetType

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

target_version instance-attribute

target_version: NotRequired[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.