Class RemediationConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
Amazon Resource Name (ARN) of remediation configuration.final Boolean
The remediation is triggered automatically.builder()
final String
The name of the Config rule.final String
Name of the service that owns the service-linked rule, if applicable.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExecutionControls
An ExecutionControls object.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Parameters property.final Integer
The maximum number of failed attempts for auto-remediation.final Map
<String, RemediationParameterValue> An object of the RemediationParameterValue.final String
The type of a resource.final Long
Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.static Class
<? extends RemediationConfiguration.Builder> final String
targetId()
Target ID is the name of the SSM document.final RemediationTargetType
The type of the target.final String
The type of the target.final String
Version of the target.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
configRuleName
The name of the Config rule.
- Returns:
- The name of the Config rule.
-
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 returnRemediationTargetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetTypeAsString()
.- Returns:
- The type of the target. Target executes remediation. For example, SSM document.
- See Also:
-
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 returnRemediationTargetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetTypeAsString()
.- Returns:
- The type of the target. Target executes remediation. For example, SSM document.
- See Also:
-
targetId
Target ID is the name of the SSM document.
- Returns:
- Target ID is the name of the SSM document.
-
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 theisEmpty()
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
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
The type of a resource.
- Returns:
- The type of a resource.
-
automatic
The remediation is triggered automatically.
- Returns:
- The remediation is triggered automatically.
-
executionControls
An ExecutionControls object.
- Returns:
- An ExecutionControls object.
-
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
Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If
MaximumAutomaticAttempts
remediation attempts have been made underRetryAttemptSeconds
, 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 andMaximumAutomaticAttempts
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 underRetryAttemptSeconds
, 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 andMaximumAutomaticAttempts
as 5, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.
-
arn
Amazon Resource Name (ARN) of remediation configuration.
- Returns:
- Amazon Resource Name (ARN) of remediation configuration.
-
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
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 interfaceToCopyableBuilder<RemediationConfiguration.Builder,
RemediationConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-