CfnRemediationConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_config.mixins.CfnRemediationConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html
CloudformationResource:: AWS::Config::RemediationConfiguration
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# parameters: Any

cfn_remediation_configuration_props_mixin = config_mixins.CfnRemediationConfigurationPropsMixin(config_mixins.CfnRemediationConfigurationMixinProps(
    automatic=False,
    config_rule_name="configRuleName",
    execution_controls=config_mixins.CfnRemediationConfigurationPropsMixin.ExecutionControlsProperty(
        ssm_controls=config_mixins.CfnRemediationConfigurationPropsMixin.SsmControlsProperty(
            concurrent_execution_rate_percentage=123,
            error_percentage=123
        )
    ),
    maximum_automatic_attempts=123,
    parameters=parameters,
    resource_type="resourceType",
    retry_attempt_seconds=123,
    target_id="targetId",
    target_type="targetType",
    target_version="targetVersion"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Config::RemediationConfiguration.

Parameters:

props (Union[CfnRemediationConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['automatic', 'configRuleName', 'executionControls', 'maximumAutomaticAttempts', 'parameters', 'resourceType', 'retryAttemptSeconds', 'targetId', 'targetType', 'targetVersion']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ExecutionControlsProperty

class CfnRemediationConfigurationPropsMixin.ExecutionControlsProperty(*, ssm_controls=None)

Bases: object

An ExecutionControls object.

Parameters:: ssm_controls (Union[IResolvable, SsmControlsProperty, Dict[str, Any], None]) – A SsmControls object.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-executioncontrols.html
ExampleMetadata:: fixture=_generated

Example:

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

execution_controls_property = config_mixins.CfnRemediationConfigurationPropsMixin.ExecutionControlsProperty(
    ssm_controls=config_mixins.CfnRemediationConfigurationPropsMixin.SsmControlsProperty(
        concurrent_execution_rate_percentage=123,
        error_percentage=123
    )
)

Attributes

ssm_controls

A SsmControls object.

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

RemediationParameterValueProperty

class CfnRemediationConfigurationPropsMixin.RemediationParameterValueProperty(*, resource_value=None, static_value=None)

Bases: object

The value is either a dynamic (resource) value or a static value.

You must select either a dynamic value or a static value.

Parameters:

resource_value (Union[IResolvable, ResourceValueProperty, Dict[str, Any], None]) – The value is dynamic and changes at run-time.
static_value (Union[IResolvable, StaticValueProperty, Dict[str, Any], None]) – The value is static and does not change at run-time.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

remediation_parameter_value_property = config_mixins.CfnRemediationConfigurationPropsMixin.RemediationParameterValueProperty(
    resource_value=config_mixins.CfnRemediationConfigurationPropsMixin.ResourceValueProperty(
        value="value"
    ),
    static_value=config_mixins.CfnRemediationConfigurationPropsMixin.StaticValueProperty(
        value=["value"],
        values=["values"]
    )
)

Attributes

resource_value

The value is dynamic and changes at run-time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-remediationparametervalue.html#cfn-config-remediationconfiguration-remediationparametervalue-resourcevalue

static_value

The value is static and does not change at run-time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-remediationparametervalue.html#cfn-config-remediationconfiguration-remediationparametervalue-staticvalue

ResourceValueProperty

class CfnRemediationConfigurationPropsMixin.ResourceValueProperty(*, value=None)

Bases: object

Parameters:: value (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-resourcevalue.html
ExampleMetadata:: fixture=_generated

Example:

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

resource_value_property = config_mixins.CfnRemediationConfigurationPropsMixin.ResourceValueProperty(
    value="value"
)

Attributes

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-resourcevalue.html#cfn-config-remediationconfiguration-resourcevalue-value

Type:: see

SsmControlsProperty

class CfnRemediationConfigurationPropsMixin.SsmControlsProperty(*, concurrent_execution_rate_percentage=None, error_percentage=None)

Bases: object

AWS Systems Manager (SSM) specific remediation controls.

Parameters:

concurrent_execution_rate_percentage (Union[int, float, None]) – The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.
error_percentage (Union[int, float, None]) – The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

ssm_controls_property = config_mixins.CfnRemediationConfigurationPropsMixin.SsmControlsProperty(
    concurrent_execution_rate_percentage=123,
    error_percentage=123
)

Attributes

concurrent_execution_rate_percentage

The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule.

You can specify a percentage, such as 10%. The default value is 10.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-ssmcontrols.html#cfn-config-remediationconfiguration-ssmcontrols-concurrentexecutionratepercentage

error_percentage

The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule.

You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-ssmcontrols.html#cfn-config-remediationconfiguration-ssmcontrols-errorpercentage

StaticValueProperty

class CfnRemediationConfigurationPropsMixin.StaticValueProperty(*, value=None, values=None)

Bases: object

Parameters:

value (Optional[Sequence[str]])
values (Optional[Sequence[str]])

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

static_value_property = config_mixins.CfnRemediationConfigurationPropsMixin.StaticValueProperty(
    value=["value"],
    values=["values"]
)

Attributes

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-staticvalue.html#cfn-config-remediationconfiguration-staticvalue-value

Type:: see

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-staticvalue.html#cfn-config-remediationconfiguration-staticvalue-values

Type:: see