Class CfnRemediationConfiguration
An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRemediationConfiguration : CfnResource, IInspectable
Syntax (vb)
Public Class CfnRemediationConfiguration
Inherits CfnResource
Implements IInspectable
Remarks
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(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 |
CfnRemediationConfiguration(Construct, String, ICfnRemediationConfigurationProps) |
Properties
AttrId | |
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. |
Parameters | An object of the 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnRemediationConfiguration(Construct, String, ICfnRemediationConfigurationProps)
public CfnRemediationConfiguration(Construct scope, string id, ICfnRemediationConfigurationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnRemediationConfigurationProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
Automatic
The remediation is triggered automatically.
public virtual object Automatic { get; set; }
Property Value
System.Object
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
ExecutionControls
An ExecutionControls object.
public virtual object ExecutionControls { get; set; }
Property Value
System.Object
MaximumAutomaticAttempts
The maximum number of failed attempts for auto-remediation.
public virtual Nullable<double> MaximumAutomaticAttempts { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
If you do not select a number, the default is 5.
Parameters
An object of the RemediationParameterValue.
public virtual object Parameters { get; set; }
Property Value
System.Object
Remarks
For more information, see RemediationParameterValue .
ResourceType
The type of a resource.
public virtual string ResourceType { get; set; }
Property Value
System.String
RetryAttemptSeconds
Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.
public virtual Nullable<double> RetryAttemptSeconds { get; set; }
Property Value
System.Nullable<System.Double>
TargetId
Target ID is the name of the SSM document.
public virtual string TargetId { get; set; }
Property Value
System.String
TargetType
The type of the target.
public virtual string TargetType { get; set; }
Property Value
System.String
TargetVersion
Version of the target.
public virtual string TargetVersion { get; set; }
Property Value
System.String
Remarks
For example, version of the SSM document.
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>