Package software.amazon.awscdk.services.config

Class CfnRemediationConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.config.CfnRemediationConfiguration
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.585Z") @Stability(Stable) public class CfnRemediationConfiguration extends CfnResource implements IInspectable
A CloudFormation AWS::Config::RemediationConfiguration.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnRemediationConfigurationProps props)
      Create a new AWS::Config::RemediationConfiguration.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

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

    • getCfnProperties

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

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

    • getParameters

      @Stability(Stable) @NotNull public Object getParameters()
      An object of the RemediationParameterValue. For more information, see RemediationParameterValue .

      The type is a map of strings to RemediationParameterValue.

    • setParameters

      @Stability(Stable) public void setParameters(@NotNull Object value)
      An object of the RemediationParameterValue. For more information, see RemediationParameterValue .

      The type is a map of strings to RemediationParameterValue.

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

      Target executes remediation. For example, SSM document.

    • setTargetType

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

      Target executes remediation. For example, SSM document.

    • getAutomatic

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

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

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

      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.

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

      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.

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

    • setRetryAttemptSeconds

      @Stability(Stable) public void setRetryAttemptSeconds(@Nullable Number value)
      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 public 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.

    • setTargetVersion

      @Stability(Stable) public void setTargetVersion(@Nullable String value)
      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.