AWS Fundamentals Logo
AWS Fundamentals
L1 Construct

CfnRemediationConfiguration

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

Import

import { CfnRemediationConfiguration } from 'aws-cdk-lib/aws-config';

Or use the module namespace:

import * as config from 'aws-cdk-lib/aws-config';
// config.CfnRemediationConfiguration

Properties

Configuration passed to the constructor as CfnRemediationConfigurationProps.

configRuleNameRequired
string

The name of the AWS Config rule.

targetIdRequired
string

Target ID is the name of the SSM document.

targetTypeRequired
string

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

automaticOptional
boolean | IResolvable

The remediation is triggered automatically.

executionControlsOptional
IResolvable | ExecutionControlsProperty

An ExecutionControls object.

maximumAutomaticAttemptsOptional
number

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.

parametersOptional
any

An object of the RemediationParameterValue. For more information, see [RemediationParameterValue](https://docs.aws.amazon.com/config/latest/APIReference/API_RemediationParameterValue.html) . > The type is a map of strings to RemediationParameterValue.

resourceTypeOptional
string

The type of a resource.

retryAttemptSecondsOptional
number

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.

targetVersionOptional
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.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-config
Properties10

Related Constructs

Explore This Service

External Links