RemediationConfiguration

import type { RemediationConfiguration } from "https://aws-api.deno.dev/v0.4/services/configservice.ts?docs=full";

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

interface RemediationConfiguration {

Arn?: string | null;

Automatic?: boolean | null;

ConfigRuleName: string;

CreatedByService?: string | null;

ExecutionControls?: ExecutionControls | null;

MaximumAutomaticAttempts?: number | null;

Parameters?: {

[key: string]: RemediationParameterValue | null | undefined;

} | null;

ResourceType?: string | null;

RetryAttemptSeconds?: number | null;

TargetId: string;

TargetType: RemediationTargetType;

TargetVersion?: string | null;

}

§Properties

Arn?: string | null

[src]

Amazon Resource Name (ARN) of remediation configuration.

Automatic?: boolean | null

[src]

The remediation is triggered automatically.

ConfigRuleName: string

[src]

The name of the Config rule.

CreatedByService?: string | null

[src]

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

ExecutionControls?: ExecutionControls | null

[src]

An ExecutionControls object.

MaximumAutomaticAttempts?: number | null

[src]

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?: {

[key: string]: RemediationParameterValue | null | undefined;

} | null

[src]

An object of the RemediationParameterValue.

ResourceType?: string | null

[src]

The type of a resource.

RetryAttemptSeconds?: number | null

[src]

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.

TargetId: string

[src]

Target ID is the name of the public document.

TargetType: RemediationTargetType

[src]

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

TargetVersion?: string | null

[src]

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.