Interface RemediationConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<RemediationConfiguration.Builder,
,RemediationConfiguration> SdkBuilder<RemediationConfiguration.Builder,
,RemediationConfiguration> SdkPojo
- Enclosing class:
RemediationConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionAmazon Resource Name (ARN) of remediation configuration.The remediation is triggered automatically.configRuleName
(String configRuleName) The name of the Config rule.createdByService
(String createdByService) Name of the service that owns the service-linked rule, if applicable.default RemediationConfiguration.Builder
executionControls
(Consumer<ExecutionControls.Builder> executionControls) An ExecutionControls object.executionControls
(ExecutionControls executionControls) An ExecutionControls object.maximumAutomaticAttempts
(Integer maximumAutomaticAttempts) The maximum number of failed attempts for auto-remediation.parameters
(Map<String, RemediationParameterValue> parameters) An object of the RemediationParameterValue.resourceType
(String resourceType) The type of a resource.retryAttemptSeconds
(Long retryAttemptSeconds) Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.Target ID is the name of the SSM document.targetType
(String targetType) The type of the target.targetType
(RemediationTargetType targetType) The type of the target.targetVersion
(String targetVersion) Version of the target.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
configRuleName
The name of the Config rule.
- Parameters:
configRuleName
- The name of the Config rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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:
-
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:
-
targetId
Target ID is the name of the SSM document.
- Parameters:
targetId
- Target ID is the name of the SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
-
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.
-
executionControls
An ExecutionControls object.
- Parameters:
executionControls
- An ExecutionControls object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executionControls
default RemediationConfiguration.Builder executionControls(Consumer<ExecutionControls.Builder> executionControls) An ExecutionControls object.
This is a convenience method that creates an instance of theExecutionControls.Builder
avoiding the need to create one manually viaExecutionControls.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexecutionControls(ExecutionControls)
.- Parameters:
executionControls
- a consumer that will call methods onExecutionControls.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- 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, 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.
-
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.- Parameters:
retryAttemptSeconds
- Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. IfMaximumAutomaticAttempts
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-