Package software.amazon.awscdk.services.config

Class CfnRemediationConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.config.CfnRemediationConfiguration
All Implemented Interfaces:
IInspectable, IRemediationConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:35.546Z") @Stability(Stable) public class CfnRemediationConfiguration extends CfnResource implements IInspectable, IRemediationConfigurationRef
An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

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;
 CfnRemediationConfiguration cfnRemediationConfiguration = CfnRemediationConfiguration.Builder.create(this, "MyCfnRemediationConfiguration")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRemediationConfiguration

      protected CfnRemediationConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRemediationConfiguration

      protected CfnRemediationConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRemediationConfiguration

      @Stability(Stable) public CfnRemediationConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRemediationConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromRemediationConfigurationId

      @Stability(Stable) @NotNull public static IRemediationConfigurationRef fromRemediationConfigurationId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String remediationConfigurationId)
      Creates a new IRemediationConfigurationRef from a remediationConfigurationId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      remediationConfigurationId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRemediationConfigurationRef

      @Stability(Stable) @NotNull public RemediationConfigurationReference getRemediationConfigurationRef()
      A reference to a RemediationConfiguration resource.
      Specified by:
      getRemediationConfigurationRef in interface IRemediationConfigurationRef

    • getConfigRuleName

      @Stability(Stable) @NotNull public String getConfigRuleName()
      The name of the AWS Config rule.

    • setConfigRuleName

      @Stability(Stable) public void setConfigRuleName(@NotNull String value)
      The name of the AWS Config rule.

    • getTargetId

      @Stability(Stable) @NotNull public String getTargetId()
      Target ID is the name of the SSM document.

    • setTargetId

      @Stability(Stable) public void setTargetId(@NotNull String value)
      Target ID is the name of the SSM document.

    • getTargetType

      @Stability(Stable) @NotNull public String getTargetType()
      The type of the target.

    • setTargetType

      @Stability(Stable) public void setTargetType(@NotNull String value)
      The type of the target.

    • getAutomatic

      @Stability(Stable) @Nullable public Object getAutomatic()
      The remediation is triggered automatically.

      Returns union: either Boolean or IResolvable

    • setAutomatic

      @Stability(Stable) public void setAutomatic(@Nullable Boolean value)
      The remediation is triggered automatically.

    • setAutomatic

      @Stability(Stable) public void setAutomatic(@Nullable IResolvable value)
      The remediation is triggered automatically.

    • getExecutionControls

      @Stability(Stable) @Nullable public Object getExecutionControls()
      An ExecutionControls object.

      Returns union: either IResolvable or CfnRemediationConfiguration.ExecutionControlsProperty

    • setExecutionControls

      @Stability(Stable) public void setExecutionControls(@Nullable IResolvable value)
      An ExecutionControls object.

    • setExecutionControls

      @Stability(Stable) public void setExecutionControls(@Nullable CfnRemediationConfiguration.ExecutionControlsProperty value)
      An ExecutionControls object.

    • getMaximumAutomaticAttempts

      @Stability(Stable) @Nullable public Number getMaximumAutomaticAttempts()
      The maximum number of failed attempts for auto-remediation.

      If you do not select a number, the default is 5.

    • setMaximumAutomaticAttempts

      @Stability(Stable) public void setMaximumAutomaticAttempts(@Nullable Number value)
      The maximum number of failed attempts for auto-remediation.

      If you do not select a number, the default is 5.

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      An object of the RemediationParameterValue.

      For more information, see RemediationParameterValue .

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable Object value)
      An object of the RemediationParameterValue.

      For more information, see RemediationParameterValue .

    • getResourceType

      @Stability(Stable) @Nullable public String getResourceType()
      The type of a resource.

    • setResourceType

      @Stability(Stable) public void setResourceType(@Nullable String value)
      The type of a resource.

    • getRetryAttemptSeconds

      @Stability(Stable) @Nullable public Number getRetryAttemptSeconds()
      Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.

    • setRetryAttemptSeconds

      @Stability(Stable) public void setRetryAttemptSeconds(@Nullable Number value)
      Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.

    • getTargetVersion

      @Stability(Stable) @Nullable public String getTargetVersion()
      Version of the target.

      For example, version of the SSM document.

    • setTargetVersion

      @Stability(Stable) public void setTargetVersion(@Nullable String value)
      Version of the target.

      For example, version of the SSM document.