AWS CDK Reference

Appearance

v2.274.0

CfnRemediationConfigurationProps Struct ​

Properties for defining a CfnRemediationConfiguration.

Source
Generated code

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_config as config } from 'aws-cdk-lib';

declare const parameters: any;
const cfnRemediationConfigurationProps: config.CfnRemediationConfigurationProps = {
  configRuleName: 'configRuleName',
  targetId: 'targetId',
  targetType: 'targetType',

  // the properties below are optional
  automatic: false,
  executionControls: {
    ssmControls: {
      concurrentExecutionRatePercentage: 123,
      errorPercentage: 123,
    },
  },
  maximumAutomaticAttempts: 123,
  parameters: parameters,
  resourceType: 'resourceType',
  retryAttemptSeconds: 123,
  targetVersion: 'targetVersion',
};

Properties ​

automaticoptionalboolean | IResolvableautomaticoptionaltyping.Union[bool, IResolvable]automaticoptionalBooleanAutomaticoptionalboolAutomaticoptionalinterface{}#
The remediation is triggered automatically.
configRuleNamestringconfig_rule_namestrconfigRuleNameStringConfigRuleNamestringConfigRuleName*stringrequired#
The name of the AWS Config rule.
executionControlsoptionalIResolvable | CfnRemediationConfiguration.ExecutionControlsPropertyexecution_controlsoptionaltyping.Union[IResolvable, ExecutionControlsProperty]executionControlsoptionalIResolvableExecutionControlsoptionalIResolvableExecutionControlsoptionalinterface{}#
An ExecutionControls object.
maximumAutomaticAttemptsoptionalnumbermaximum_automatic_attemptsoptionalint | floatmaximumAutomaticAttemptsoptionalNumberMaximumAutomaticAttemptsoptionaldoubleMaximumAutomaticAttemptsoptional*float64#
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.

parametersoptionalanyparametersoptionalAnyparametersoptionalObjectParametersoptionalobjectParametersoptionalinterface{}#
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.

resourceTypeoptionalstringresource_typeoptionalstrresourceTypeoptionalStringResourceTypeoptionalstringResourceTypeoptional*string#
The type of a resource.
retryAttemptSecondsoptionalnumberretry_attempt_secondsoptionalint | floatretryAttemptSecondsoptionalNumberRetryAttemptSecondsoptionaldoubleRetryAttemptSecondsoptional*float64#
Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.
notes

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.

targetIdstringtarget_idstrtargetIdStringTargetIdstringTargetId*stringrequired#
Target ID is the name of the SSM document.
targetTypestringtarget_typestrtargetTypeStringTargetTypestringTargetType*stringrequired#
The type of the target.

Target executes remediation. For example, SSM document.

targetVersionoptionalstringtarget_versionoptionalstrtargetVersionoptionalStringTargetVersionoptionalstringTargetVersionoptional*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.