Package software.amazon.awscdk.services.config

Interface CfnRemediationConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRemediationConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:25.703Z")
@Stability(Stable)
public interface CfnRemediationConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRemediationConfiguration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 Object parameters;
 CfnRemediationConfigurationProps cfnRemediationConfigurationProps = CfnRemediationConfigurationProps.builder()
         .configRuleName("configRuleName")
         .targetId("targetId")
         .targetType("targetType")
         // the properties below are optional
         .automatic(false)
         .executionControls(ExecutionControlsProperty.builder()
                 .ssmControls(SsmControlsProperty.builder()
                         .concurrentExecutionRatePercentage(123)
                         .errorPercentage(123)
                         .build())
                 .build())
         .maximumAutomaticAttempts(123)
         .parameters(parameters)
         .resourceType("resourceType")
         .retryAttemptSeconds(123)
         .targetVersion("targetVersion")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRemediationConfigurationProps.Builder	A builder for CfnRemediationConfigurationProps
static final class	CfnRemediationConfigurationProps.Jsii$Proxy	An implementation for CfnRemediationConfigurationProps

Method Summary

Modifier and Type	Method	Description
static CfnRemediationConfigurationProps.Builder	builder()
default Object	getAutomatic()	The remediation is triggered automatically.
String	getConfigRuleName()	The name of the AWS Config rule.
default Object	getExecutionControls()	An ExecutionControls object.
default Number	getMaximumAutomaticAttempts()	The maximum number of failed attempts for auto-remediation.
default Object	getParameters()	An object of the RemediationParameterValue.
default String	getResourceType()	The type of a resource.
default Number	getRetryAttemptSeconds()	Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.
String	getTargetId()	Target ID is the name of the SSM document.
String	getTargetType()	The type of the target.
default String	getTargetVersion()	Version of the target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigRuleName

@Stability(Stable)
@NotNull
String getConfigRuleName()

The name of the AWS Config rule.

See Also:

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

getTargetId

@Stability(Stable)
@NotNull
String getTargetId()

Target ID is the name of the SSM document.

See Also:

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

getTargetType

@Stability(Stable)
@NotNull
String getTargetType()

The type of the target.

Target executes remediation. For example, SSM document.

See Also:

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

getAutomatic

@Stability(Stable)
@Nullable
default Object getAutomatic()

The remediation is triggered automatically.

See Also:

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

getExecutionControls

@Stability(Stable)
@Nullable
default Object getExecutionControls()

An ExecutionControls object.

See Also:

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

getMaximumAutomaticAttempts

@Stability(Stable)
@Nullable
default Number getMaximumAutomaticAttempts()

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

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 Also:

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

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

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

The type is a map of strings to RemediationParameterValue.

See Also:

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

getResourceType

@Stability(Stable)
@Nullable
default String getResourceType()

The type of a resource.

See Also:

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

getRetryAttemptSeconds

@Stability(Stable)
@Nullable
default Number getRetryAttemptSeconds()

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

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 Also:

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

getTargetVersion

@Stability(Stable)
@Nullable
default String getTargetVersion()

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

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

See Also:

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

builder

@Stability(Stable)
static CfnRemediationConfigurationProps.Builder builder()

Returns:

a CfnRemediationConfigurationProps.Builder of CfnRemediationConfigurationProps