software.amazon.awssdk.services.config.model

Interface RemediationConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RemediationConfiguration.Builder,RemediationConfiguration>, SdkBuilder<RemediationConfiguration.Builder,RemediationConfiguration>, SdkPojo

Enclosing class:

RemediationConfiguration

public static interface RemediationConfiguration.Builder
extends SdkPojo, CopyableBuilder<RemediationConfiguration.Builder,RemediationConfiguration>

Method Summary

Modifier and Type	Method and Description
RemediationConfiguration.Builder	arn(String arn) Amazon Resource Name (ARN) of remediation configuration.
RemediationConfiguration.Builder	automatic(Boolean automatic) The remediation is triggered automatically.
RemediationConfiguration.Builder	configRuleName(String configRuleName) The name of the Config rule.
RemediationConfiguration.Builder	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.
RemediationConfiguration.Builder	executionControls(ExecutionControls executionControls) An ExecutionControls object.
RemediationConfiguration.Builder	maximumAutomaticAttempts(Integer maximumAutomaticAttempts) The maximum number of failed attempts for auto-remediation.
RemediationConfiguration.Builder	parameters(Map<String,RemediationParameterValue> parameters) An object of the RemediationParameterValue.
RemediationConfiguration.Builder	resourceType(String resourceType) The type of a resource.
RemediationConfiguration.Builder	retryAttemptSeconds(Long retryAttemptSeconds) Maximum time in seconds that Config runs auto-remediation.
RemediationConfiguration.Builder	targetId(String targetId) Target ID is the name of the SSM document.
RemediationConfiguration.Builder	targetType(RemediationTargetType targetType) The type of the target.
RemediationConfiguration.Builder	targetType(String targetType) The type of the target.
RemediationConfiguration.Builder	targetVersion(String targetVersion) Version of the target.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

configRuleName

RemediationConfiguration.Builder configRuleName(String 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

RemediationConfiguration.Builder targetType(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, RemediationTargetType

targetType

RemediationConfiguration.Builder targetType(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, RemediationTargetType

targetId

RemediationConfiguration.Builder targetId(String 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

RemediationConfiguration.Builder targetVersion(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.

parameters

RemediationConfiguration.Builder parameters(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.

resourceType

RemediationConfiguration.Builder resourceType(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.

automatic

RemediationConfiguration.Builder automatic(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.

executionControls

RemediationConfiguration.Builder executionControls(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.

executionControls

default RemediationConfiguration.Builder executionControls(Consumer<ExecutionControls.Builder> executionControls)

An ExecutionControls object.

This is a convenience method that creates an instance of the ExecutionControls.Builder avoiding the need to create one manually via ExecutionControls.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to executionControls(ExecutionControls).

Parameters:

executionControls - a consumer that will call methods on ExecutionControls.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

executionControls(ExecutionControls)

maximumAutomaticAttempts

RemediationConfiguration.Builder maximumAutomaticAttempts(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.

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

RemediationConfiguration.Builder retryAttemptSeconds(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

arn

RemediationConfiguration.Builder arn(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.

createdByService

RemediationConfiguration.Builder createdByService(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.