Interface ICfnRemediationConfigurationMixinProps

Properties for CfnRemediationConfigurationPropsMixin.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Config

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface ICfnRemediationConfigurationMixinProps

Syntax (vb)

Public Interface ICfnRemediationConfigurationMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Config;

             var parameters;

             var cfnRemediationConfigurationMixinProps = new CfnRemediationConfigurationMixinProps {
                 Automatic = false,
                 ConfigRuleName = "configRuleName",
                 ExecutionControls = new ExecutionControlsProperty {
                     SsmControls = new SsmControlsProperty {
                         ConcurrentExecutionRatePercentage = 123,
                         ErrorPercentage = 123
                     }
                 },
                 MaximumAutomaticAttempts = 123,
                 Parameters = parameters,
                 ResourceType = "resourceType",
                 RetryAttemptSeconds = 123,
                 TargetId = "targetId",
                 TargetType = "targetType",
                 TargetVersion = "targetVersion"
             };

Synopsis

Properties

Automatic	The remediation is triggered automatically.
ConfigRuleName	The name of the AWS Config rule.
ExecutionControls	An ExecutionControls object.
MaximumAutomaticAttempts	The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
Parameters	An object of the RemediationParameterValue. For more information, see RemediationParameterValue .
ResourceType	The type of a resource.
RetryAttemptSeconds	Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.
TargetId	Target ID is the name of the SSM document.
TargetType	The type of the target.
TargetVersion	Version of the target. For example, version of the SSM document.

Properties

Automatic

The remediation is triggered automatically.

object? Automatic { get; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

ConfigRuleName

The name of the AWS Config rule.

string? ConfigRuleName { get; }

Property Value

string

Remarks

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

ExecutionControls

An ExecutionControls object.

object? ExecutionControls { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnRemediationConfigurationPropsMixin.IExecutionControlsProperty

MaximumAutomaticAttempts

The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

double? MaximumAutomaticAttempts { get; }

Property Value

double?

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-maximumautomaticattempts

Parameters

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

object? Parameters { get; }

Property Value

object

Remarks

The type is a map of strings to RemediationParameterValue.

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

ResourceType

The type of a resource.

string? ResourceType { get; }

Property Value

string

Remarks

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

RetryAttemptSeconds

Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.

double? RetryAttemptSeconds { get; }

Property Value

double?

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-remediationconfiguration.html#cfn-config-remediationconfiguration-retryattemptseconds

TargetId

Target ID is the name of the SSM document.

string? TargetId { get; }

Property Value

string

Remarks

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

TargetType

The type of the target.

string? TargetType { get; }

Property Value

string

Remarks

Target executes remediation. For example, SSM document.

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

TargetVersion

Version of the target. For example, version of the SSM document.

string? TargetVersion { get; }

Property Value

string

Remarks

If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.

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