Class CfnRemediationConfiguration
A CloudFormation AWS::Config::RemediationConfiguration
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.AWS.Config.dll
Syntax (csharp)
public class CfnRemediationConfiguration : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnRemediationConfiguration
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.
CloudformationResource: AWS::Config::RemediationConfiguration
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 cfnRemediationConfiguration = new CfnRemediationConfiguration(this, "MyCfnRemediationConfiguration", 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
CfnRemediationConfiguration(Construct, String, ICfnRemediationConfigurationProps) | Create a new |
CfnRemediationConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRemediationConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
Automatic | The remediation is triggered automatically. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Maximum time in seconds that AWS Config runs auto-remediation. |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRemediationConfiguration(Construct, String, ICfnRemediationConfigurationProps)
Create a new AWS::Config::RemediationConfiguration
.
public CfnRemediationConfiguration(Construct scope, string id, ICfnRemediationConfigurationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRemediationConfigurationProps
- resource properties.
CfnRemediationConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRemediationConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRemediationConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRemediationConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Automatic
The remediation is triggered automatically.
public virtual object Automatic { get; set; }
Property Value
System.Object
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConfigRuleName
The name of the AWS Config rule.
public virtual string ConfigRuleName { get; set; }
Property Value
System.String
Remarks
ExecutionControls
An ExecutionControls object.
public virtual 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 virtual 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 virtual 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 virtual string ResourceType { get; set; }
Property Value
System.String
Remarks
RetryAttemptSeconds
Maximum time in seconds that AWS Config runs auto-remediation.
public virtual Nullable<double> RetryAttemptSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
TargetId
Target ID is the name of the SSM document.
public virtual string TargetId { get; set; }
Property Value
System.String
Remarks
TargetType
The type of the target.
public virtual 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 virtual 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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>