RemediationConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.config.model.RemediationConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RemediationConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RemediationConfiguration()

Constructors
Constructor and Description
`RemediationConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RemediationConfiguration`	`addParametersEntry(String key, RemediationParameterValue value)` Add a single Parameters entry
`RemediationConfiguration`	`clearParametersEntries()` Removes all the entries added into Parameters.
`RemediationConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Amazon Resource Name (ARN) of remediation configuration.
`Boolean`	`getAutomatic()` The remediation is triggered automatically.
`String`	`getConfigRuleName()` The name of the AWS Config rule.
`String`	`getCreatedByService()` Name of the service that owns the service linked rule, if applicable.
`ExecutionControls`	`getExecutionControls()` An ExecutionControls object.
`Integer`	`getMaximumAutomaticAttempts()` The maximum number of failed attempts for auto-remediation.
`Map<String,RemediationParameterValue>`	`getParameters()` An object of the RemediationParameterValue.
`String`	`getResourceType()` The type of a resource.
`Long`	`getRetryAttemptSeconds()` Maximum time in seconds that AWS Config runs auto-remediation.
`String`	`getTargetId()` Target ID is the name of the public document.
`String`	`getTargetType()` The type of the target.
`String`	`getTargetVersion()` Version of the target.
`int`	`hashCode()`
`Boolean`	`isAutomatic()` The remediation is triggered automatically.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` Amazon Resource Name (ARN) of remediation configuration.
`void`	`setAutomatic(Boolean automatic)` The remediation is triggered automatically.
`void`	`setConfigRuleName(String configRuleName)` The name of the AWS Config rule.
`void`	`setCreatedByService(String createdByService)` Name of the service that owns the service linked rule, if applicable.
`void`	`setExecutionControls(ExecutionControls executionControls)` An ExecutionControls object.
`void`	`setMaximumAutomaticAttempts(Integer maximumAutomaticAttempts)` The maximum number of failed attempts for auto-remediation.
`void`	`setParameters(Map<String,RemediationParameterValue> parameters)` An object of the RemediationParameterValue.
`void`	`setResourceType(String resourceType)` The type of a resource.
`void`	`setRetryAttemptSeconds(Long retryAttemptSeconds)` Maximum time in seconds that AWS Config runs auto-remediation.
`void`	`setTargetId(String targetId)` Target ID is the name of the public document.
`void`	`setTargetType(String targetType)` The type of the target.
`void`	`setTargetVersion(String targetVersion)` Version of the target.
`String`	`toString()` Returns a string representation of this object.
`RemediationConfiguration`	`withArn(String arn)` Amazon Resource Name (ARN) of remediation configuration.
`RemediationConfiguration`	`withAutomatic(Boolean automatic)` The remediation is triggered automatically.
`RemediationConfiguration`	`withConfigRuleName(String configRuleName)` The name of the AWS Config rule.
`RemediationConfiguration`	`withCreatedByService(String createdByService)` Name of the service that owns the service linked rule, if applicable.
`RemediationConfiguration`	`withExecutionControls(ExecutionControls executionControls)` An ExecutionControls object.
`RemediationConfiguration`	`withMaximumAutomaticAttempts(Integer maximumAutomaticAttempts)` The maximum number of failed attempts for auto-remediation.
`RemediationConfiguration`	`withParameters(Map<String,RemediationParameterValue> parameters)` An object of the RemediationParameterValue.
`RemediationConfiguration`	`withResourceType(String resourceType)` The type of a resource.
`RemediationConfiguration`	`withRetryAttemptSeconds(Long retryAttemptSeconds)` Maximum time in seconds that AWS Config runs auto-remediation.
`RemediationConfiguration`	`withTargetId(String targetId)` Target ID is the name of the public document.
`RemediationConfiguration`	`withTargetType(RemediationTargetType targetType)` The type of the target.
`RemediationConfiguration`	`withTargetType(String targetType)` The type of the target.
`RemediationConfiguration`	`withTargetVersion(String targetVersion)` Version of the target.

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

- Constructor Detail
  - RemediationConfiguration
```
public RemediationConfiguration()
```
- Method Detail
  - setConfigRuleName
```
public void setConfigRuleName(String configRuleName)
```
    The name of the AWS Config rule.
    
    Parameters:
    
    configRuleName - The name of the AWS Config rule.
  - getConfigRuleName
```
public String getConfigRuleName()
```
    The name of the AWS Config rule.
    
    Returns:
    
    The name of the AWS Config rule.
  - withConfigRuleName
```
public RemediationConfiguration withConfigRuleName(String configRuleName)
```
    The name of the AWS Config rule.
    
    Parameters:
    
    configRuleName - The name of the AWS Config rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetType
```
public void setTargetType(String targetType)
```
    The type of the target. Target executes remediation. For example, SSM document.
    
    Parameters:
    
    targetType - The type of the target. Target executes remediation. For example, SSM document.
    
    See Also:
    
    RemediationTargetType
  - getTargetType
```
public String getTargetType()
```
    The type of the target. Target executes remediation. For example, SSM document.
    
    Returns:
    
    The type of the target. Target executes remediation. For example, SSM document.
    
    See Also:
    
    RemediationTargetType
  - withTargetType
```
public RemediationConfiguration withTargetType(String targetType)
```
    The type of the target. Target executes remediation. For example, SSM document.
    
    Parameters:
    
    targetType - The type of the target. Target executes remediation. For example, SSM document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RemediationTargetType
  - withTargetType
```
public RemediationConfiguration withTargetType(RemediationTargetType targetType)
```
    The type of the target. Target executes remediation. For example, SSM document.
    
    Parameters:
    
    targetType - The type of the target. Target executes remediation. For example, SSM document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RemediationTargetType
  - setTargetId
```
public void setTargetId(String targetId)
```
    Target ID is the name of the public document.
    
    Parameters:
    
    targetId - Target ID is the name of the public document.
  - getTargetId
```
public String getTargetId()
```
    Target ID is the name of the public document.
    
    Returns:
    
    Target ID is the name of the public document.
  - withTargetId
```
public RemediationConfiguration withTargetId(String targetId)
```
    Target ID is the name of the public document.
    
    Parameters:
    
    targetId - Target ID is the name of the public document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetVersion
```
public void setTargetVersion(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.
    
    Parameters:
    
    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.
  - getTargetVersion
```
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.
    
    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.
  - withTargetVersion
```
public RemediationConfiguration withTargetVersion(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,RemediationParameterValue> getParameters()
```
    An object of the RemediationParameterValue.
    
    Returns:
    
    An object of the RemediationParameterValue.
  - setParameters
```
public void setParameters(Map<String,RemediationParameterValue> parameters)
```
    An object of the RemediationParameterValue.
    
    Parameters:
    
    parameters - An object of the RemediationParameterValue.
  - withParameters
```
public RemediationConfiguration withParameters(Map<String,RemediationParameterValue> parameters)
```
    An object of the RemediationParameterValue.
    
    Parameters:
    
    parameters - An object of the RemediationParameterValue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public RemediationConfiguration addParametersEntry(String key,
                                                   RemediationParameterValue value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, com.amazonaws.services.config.model.RemediationParameterValue>)
  - clearParametersEntries
```
public RemediationConfiguration clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The type of a resource.
    
    Parameters:
    
    resourceType - The type of a resource.
  - getResourceType
```
public String getResourceType()
```
    The type of a resource.
    
    Returns:
    
    The type of a resource.
  - withResourceType
```
public RemediationConfiguration withResourceType(String resourceType)
```
    The type of a resource.
    
    Parameters:
    
    resourceType - The type of a resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutomatic
```
public void setAutomatic(Boolean automatic)
```
    The remediation is triggered automatically.
    
    Parameters:
    
    automatic - The remediation is triggered automatically.
  - getAutomatic
```
public Boolean getAutomatic()
```
    The remediation is triggered automatically.
    
    Returns:
    
    The remediation is triggered automatically.
  - withAutomatic
```
public RemediationConfiguration withAutomatic(Boolean automatic)
```
    The remediation is triggered automatically.
    
    Parameters:
    
    automatic - The remediation is triggered automatically.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAutomatic
```
public Boolean isAutomatic()
```
    The remediation is triggered automatically.
    
    Returns:
    
    The remediation is triggered automatically.
  - setExecutionControls
```
public void setExecutionControls(ExecutionControls executionControls)
```
    An ExecutionControls object.
    
    Parameters:
    
    executionControls - An ExecutionControls object.
  - getExecutionControls
```
public ExecutionControls getExecutionControls()
```
    An ExecutionControls object.
    
    Returns:
    
    An ExecutionControls object.
  - withExecutionControls
```
public RemediationConfiguration withExecutionControls(ExecutionControls executionControls)
```
    An ExecutionControls object.
    
    Parameters:
    
    executionControls - An ExecutionControls object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaximumAutomaticAttempts
```
public void setMaximumAutomaticAttempts(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, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
    
    Parameters:
    
    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, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
  - getMaximumAutomaticAttempts
```
public Integer 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.
    
    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, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
  - withMaximumAutomaticAttempts
```
public RemediationConfiguration withMaximumAutomaticAttempts(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, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
    
    Parameters:
    
    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, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetryAttemptSeconds
```
public void setRetryAttemptSeconds(Long retryAttemptSeconds)
```
    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.
    
    Parameters:
    
    retryAttemptSeconds - 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.
  - getRetryAttemptSeconds
```
public Long 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.
    
    Returns:
    
    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.
  - withRetryAttemptSeconds
```
public RemediationConfiguration withRetryAttemptSeconds(Long retryAttemptSeconds)
```
    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.
    
    Parameters:
    
    retryAttemptSeconds - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    Amazon Resource Name (ARN) of remediation configuration.
    
    Parameters:
    
    arn - Amazon Resource Name (ARN) of remediation configuration.
  - getArn
```
public String getArn()
```
    Amazon Resource Name (ARN) of remediation configuration.
    
    Returns:
    
    Amazon Resource Name (ARN) of remediation configuration.
  - withArn
```
public RemediationConfiguration withArn(String arn)
```
    Amazon Resource Name (ARN) of remediation configuration.
    
    Parameters:
    
    arn - Amazon Resource Name (ARN) of remediation configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedByService
```
public void setCreatedByService(String createdByService)
```
    Name of the service that owns the service linked rule, if applicable.
    
    Parameters:
    
    createdByService - Name of the service that owns the service linked rule, if applicable.
  - getCreatedByService
```
public String getCreatedByService()
```
    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.
  - withCreatedByService
```
public RemediationConfiguration withCreatedByService(String createdByService)
```
    Name of the service that owns the service linked rule, if applicable.
    
    Parameters:
    
    createdByService - Name of the service that owns the service linked rule, if applicable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RemediationConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class RemediationConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RemediationConfiguration

Method Detail

setConfigRuleName

getConfigRuleName

withConfigRuleName

setTargetType

getTargetType

withTargetType

withTargetType

setTargetId

getTargetId

withTargetId

setTargetVersion

getTargetVersion

withTargetVersion

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setResourceType

getResourceType

withResourceType

setAutomatic

getAutomatic

withAutomatic

isAutomatic

setExecutionControls

getExecutionControls

withExecutionControls

setMaximumAutomaticAttempts

getMaximumAutomaticAttempts

withMaximumAutomaticAttempts

setRetryAttemptSeconds

getRetryAttemptSeconds

withRetryAttemptSeconds

setArn

getArn

withArn

setCreatedByService

getCreatedByService

withCreatedByService

toString

equals

hashCode

clone

marshall