Class RemediationConfiguration

java.lang.Object
software.amazon.awssdk.services.config.model.RemediationConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RemediationConfiguration.Builder,RemediationConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class RemediationConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RemediationConfiguration.Builder,RemediationConfiguration>

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

See Also:

  • Method Details

    • configRuleName

      public final String configRuleName()

      The name of the Config rule.

      Returns:
      The name of the Config rule.

    • targetType

      public final RemediationTargetType targetType()

      The type of the target. Target executes remediation. For example, SSM document.

      If the service returns an enum value that is not available in the current SDK version, targetType will return RemediationTargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

      Returns:
      The type of the target. Target executes remediation. For example, SSM document.
      See Also:

    • targetTypeAsString

      public final String targetTypeAsString()

      The type of the target. Target executes remediation. For example, SSM document.

      If the service returns an enum value that is not available in the current SDK version, targetType will return RemediationTargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

      Returns:
      The type of the target. Target executes remediation. For example, SSM document.
      See Also:

    • targetId

      public final String targetId()

      Target ID is the name of the SSM document.

      Returns:
      Target ID is the name of the SSM document.

    • targetVersion

      public final String targetVersion()

      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.

      Returns:
      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.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parameters

      public final Map<String,RemediationParameterValue> parameters()

      An object of the RemediationParameterValue.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

      Returns:
      An object of the RemediationParameterValue.

    • resourceType

      public final String resourceType()

      The type of a resource.

      Returns:
      The type of a resource.

    • automatic

      public final Boolean automatic()

      The remediation is triggered automatically.

      Returns:
      The remediation is triggered automatically.

    • executionControls

      public final ExecutionControls executionControls()

      An ExecutionControls object.

      Returns:
      An ExecutionControls object.

    • maximumAutomaticAttempts

      public final Integer maximumAutomaticAttempts()

      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, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

      Returns:
      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, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

    • retryAttemptSeconds

      public final Long retryAttemptSeconds()

      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, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.

      Returns:
      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, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.

    • arn

      public final String arn()

      Amazon Resource Name (ARN) of remediation configuration.

      Returns:
      Amazon Resource Name (ARN) of remediation configuration.

    • createdByService

      public final String createdByService()

      Name of the service that owns the service-linked rule, if applicable.

      Returns:
      Name of the service that owns the service-linked rule, if applicable.

    • toBuilder

      public RemediationConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RemediationConfiguration.Builder,RemediationConfiguration>
      Returns:
      a builder for type T

    • builder

      public static RemediationConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RemediationConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.