Class CfnRemediationConfigurationProps
Properties for defining a CfnRemediationConfiguration
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRemediationConfigurationProps : Object, ICfnRemediationConfigurationProps
Syntax (vb)
Public Class CfnRemediationConfigurationProps
Inherits Object
Implements ICfnRemediationConfigurationProps
Remarks
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.AWS.Config;
var parameters;
var cfnRemediationConfigurationProps = new CfnRemediationConfigurationProps {
ConfigRuleName = "configRuleName",
TargetId = "targetId",
TargetType = "targetType",
// the properties below are optional
Automatic = false,
ExecutionControls = new ExecutionControlsProperty {
SsmControls = new SsmControlsProperty {
ConcurrentExecutionRatePercentage = 123,
ErrorPercentage = 123
}
},
MaximumAutomaticAttempts = 123,
Parameters = parameters,
ResourceType = "resourceType",
RetryAttemptSeconds = 123,
TargetVersion = "targetVersion"
};
Synopsis
Constructors
CfnRemediationConfigurationProps() |
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. |
Constructors
CfnRemediationConfigurationProps()
public CfnRemediationConfigurationProps()
Properties
Automatic
The remediation is triggered automatically.
public object Automatic { get; set; }
Property Value
System.Object
Remarks
ConfigRuleName
The name of the AWS Config rule.
public string ConfigRuleName { get; set; }
Property Value
System.String
Remarks
ExecutionControls
An ExecutionControls object.
public object ExecutionControls { get; set; }
Property Value
System.Object
Remarks
MaximumAutomaticAttempts
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
public Nullable<double> MaximumAutomaticAttempts { get; set; }
Property Value
System.Nullable<System.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.
Parameters
An object of the RemediationParameterValue. For more information, see RemediationParameterValue .
public object Parameters { get; set; }
Property Value
System.Object
Remarks
The type is a map of strings to RemediationParameterValue.
ResourceType
The type of a resource.
public string ResourceType { get; set; }
Property Value
System.String
Remarks
RetryAttemptSeconds
Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.
public Nullable<double> RetryAttemptSeconds { get; set; }
Property Value
System.Nullable<System.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.
TargetId
Target ID is the name of the SSM document.
public string TargetId { get; set; }
Property Value
System.String
Remarks
TargetType
The type of the target.
public string TargetType { get; set; }
Property Value
System.String
Remarks
Target executes remediation. For example, SSM document.
TargetVersion
Version of the target. For example, version of the SSM document.
public string TargetVersion { get; set; }
Property Value
System.String
Remarks
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.