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.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.591Z") @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();

  • Method Details

    • getConfigRuleName

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

    • getTargetId

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

    • getTargetType

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

      Target executes remediation. For example, SSM document.

    • getAutomatic

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

    • getExecutionControls

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

    • 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.

    • 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.

    • getResourceType

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

    • getRetryAttemptSeconds

      @Stability(Stable) @Nullable default Number getRetryAttemptSeconds()
      Maximum time in seconds that AWS Config runs auto-remediation.

      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.

    • 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.

    • builder

      @Stability(Stable) static CfnRemediationConfigurationProps.Builder builder()
      Returns:
      a CfnRemediationConfigurationProps.Builder of CfnRemediationConfigurationProps