RemediationConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.config.model.RemediationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RemediationConfiguration.Builder,RemediationConfiguration>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RemediationConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RemediationConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` Amazon Resource Name (ARN) of remediation configuration.
`Boolean`	`automatic()` The remediation is triggered automatically.
`static RemediationConfiguration.Builder`	`builder()`
`String`	`configRuleName()` The name of the Config rule.
`String`	`createdByService()` Name of the service that owns the service-linked rule, if applicable.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ExecutionControls`	`executionControls()` An ExecutionControls object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParameters()` For responses, this returns true if the service returned a value for the Parameters property.
`Integer`	`maximumAutomaticAttempts()` The maximum number of failed attempts for auto-remediation.
`Map<String,RemediationParameterValue>`	`parameters()` An object of the RemediationParameterValue.
`String`	`resourceType()` The type of a resource.
`Long`	`retryAttemptSeconds()` Maximum time in seconds that Config runs auto-remediation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RemediationConfiguration.Builder>`	`serializableBuilderClass()`
`String`	`targetId()` Target ID is the name of the SSM document.
`RemediationTargetType`	`targetType()` The type of the target.
`String`	`targetTypeAsString()` The type of the target.
`String`	`targetVersion()` Version of the target.
`RemediationConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    RemediationTargetType
  - 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:
    
    RemediationTargetType
  - 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()
```
    Maximum time in seconds that 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, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.
    
    Returns:
    
    Maximum time in seconds that 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, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RemediationConfiguration.Builder,RemediationConfiguration>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class RemediationConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

configRuleName

targetType

targetTypeAsString

targetId

targetVersion

hasParameters

parameters

resourceType

automatic

executionControls

maximumAutomaticAttempts

retryAttemptSeconds

arn

createdByService

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields