1.204.0

interface CfnRemediationConfigurationProps

LanguageType name
.NETAmazon.CDK.AWS.Config.CfnRemediationConfigurationProps
Javasoftware.amazon.awscdk.services.config.CfnRemediationConfigurationProps
Pythonaws_cdk.aws_config.CfnRemediationConfigurationProps
TypeScript @aws-cdk/aws-config » CfnRemediationConfigurationProps

Properties for defining a CfnRemediationConfiguration.

Example

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

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

NameTypeDescription
configRuleNamestringThe name of the AWS Config rule.
targetIdstringTarget ID is the name of the SSM document.
targetTypestringThe type of the target.
automatic?boolean | IResolvableThe remediation is triggered automatically.
executionControls?IResolvable | ExecutionControlsPropertyAn ExecutionControls object.
maximumAutomaticAttempts?numberThe maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
parameters?anyAn object of the RemediationParameterValue. For more information, see RemediationParameterValue .
resourceType?stringThe type of a resource.
retryAttemptSeconds?numberMaximum time in seconds that AWS Config runs auto-remediation.
targetVersion?stringVersion of the target. For example, version of the SSM document.

configRuleName

Type: string

The name of the AWS Config rule.

targetId

Type: string

Target ID is the name of the SSM document.

targetType

Type: string

The type of the target.

Target executes remediation. For example, SSM document.

automatic?

Type: boolean | IResolvable (optional)

The remediation is triggered automatically.

executionControls?

Type: IResolvable | ExecutionControlsProperty (optional)

An ExecutionControls object.

maximumAutomaticAttempts?

Type: number (optional)

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.

parameters?

Type: any (optional)

An object of the RemediationParameterValue. For more information, see RemediationParameterValue .

The type is a map of strings to RemediationParameterValue.

resourceType?

Type: string (optional)

The type of a resource.

retryAttemptSeconds?

Type: number (optional)

Maximum time in seconds that AWS 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, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

targetVersion?

Type: string (optional)

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.

← PreviousNext →