2.233.0

interface CfnRemediationConfigurationMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Config.Mixins.CfnRemediationConfigurationMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsconfig/mixins#CfnRemediationConfigurationMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.config.mixins.CfnRemediationConfigurationMixinProps
Pythonaws_cdk.mixins_preview.aws_config.mixins.CfnRemediationConfigurationMixinProps
TypeScript @aws-cdk/mixins-preview » aws_config » mixins » CfnRemediationConfigurationMixinProps

Properties for CfnRemediationConfigurationPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html

Example

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

declare const parameters: any;
const cfnRemediationConfigurationMixinProps: config_mixins.CfnRemediationConfigurationMixinProps = {
  automatic: false,
  configRuleName: 'configRuleName',
  executionControls: {
    ssmControls: {
      concurrentExecutionRatePercentage: 123,
      errorPercentage: 123,
    },
  },
  maximumAutomaticAttempts: 123,
  parameters: parameters,
  resourceType: 'resourceType',
  retryAttemptSeconds: 123,
  targetId: 'targetId',
  targetType: 'targetType',
  targetVersion: 'targetVersion',
};

Properties

NameTypeDescription
automatic?boolean | IResolvableThe remediation is triggered automatically.
configRuleName?stringThe name of the AWS Config rule.
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?numberTime window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.
targetId?stringTarget ID is the name of the SSM document.
targetType?stringThe type of the target.
targetVersion?stringVersion of the target. For example, version of the SSM document.

automatic?

Type: boolean | IResolvable (optional)

The remediation is triggered automatically.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-automatic

configRuleName?

Type: string (optional)

The name of the AWS Config rule.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-configrulename

executionControls?

Type: IResolvable | ExecutionControlsProperty (optional)

An ExecutionControls object.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-executioncontrols

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-maximumautomaticattempts

parameters?

Type: any (optional)

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

The type is a map of strings to RemediationParameterValue.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-parameters

resourceType?

Type: string (optional)

The type of a resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-resourcetype

retryAttemptSeconds?

Type: number (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-retryattemptseconds

targetId?

Type: string (optional)

Target ID is the name of the SSM document.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-targetid

targetType?

Type: string (optional)

The type of the target.

Target executes remediation. For example, SSM document.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-targettype

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-targetversion

← PreviousNext →