CfnRemediationConfigurationProps

class aws_cdk.aws_config.CfnRemediationConfigurationProps(*, config_rule_name, target_id, target_type, automatic=None, execution_controls=None, maximum_automatic_attempts=None, parameters=None, resource_type=None, retry_attempt_seconds=None, target_version=None)

Bases: object

Properties for defining a CfnRemediationConfiguration.

Parameters:

  • config_rule_name (str) – The name of the AWS Config rule.

  • target_id (str) – Target ID is the name of the SSM document.

  • target_type (str) – The type of the target. Target executes remediation. For example, SSM document.

  • automatic (Union[bool, IResolvable, None]) – The remediation is triggered automatically.

  • execution_controls (Union[IResolvable, ExecutionControlsProperty, Dict[str, Any], None]) – An ExecutionControls object.

  • maximum_automatic_attempts (Union[int, float, None]) – 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 (Optional[Any]) – An object of the RemediationParameterValue. For more information, see RemediationParameterValue . .. epigraph:: The type is a map of strings to RemediationParameterValue.

  • resource_type (Optional[str]) – The type of a resource.

  • retry_attempt_seconds (Union[int, float, None]) – 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.

  • target_version (Optional[str]) – Version of the target. For example, version of the SSM document. .. epigraph:: If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_config as config

# parameters: Any

cfn_remediation_configuration_props = config.CfnRemediationConfigurationProps(
    config_rule_name="configRuleName",
    target_id="targetId",
    target_type="targetType",

    # the properties below are optional
    automatic=False,
    execution_controls=config.CfnRemediationConfiguration.ExecutionControlsProperty(
        ssm_controls=config.CfnRemediationConfiguration.SsmControlsProperty(
            concurrent_execution_rate_percentage=123,
            error_percentage=123
        )
    ),
    maximum_automatic_attempts=123,
    parameters=parameters,
    resource_type="resourceType",
    retry_attempt_seconds=123,
    target_version="targetVersion"
)

Attributes

automatic

The remediation is triggered automatically.

Link:

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

config_rule_name

The name of the AWS Config rule.

Link:

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

execution_controls

An ExecutionControls object.

Link:

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

maximum_automatic_attempts

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.

Link:

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

parameters

//docs.aws.amazon.com/config/latest/APIReference/API_RemediationParameterValue.html>`_ .

The type is a map of strings to RemediationParameterValue.

Link:

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

Type:

An object of the RemediationParameterValue. For more information, see `RemediationParameterValue <https

resource_type

The type of a resource.

Link:

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

retry_attempt_seconds

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.

Link:

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

target_id

Target ID is the name of the SSM document.

Link:

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

target_type

The type of the target.

Target executes remediation. For example, SSM document.

Link:

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

target_version

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.

Link:

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