software.amazon.awscdk.services.config

Class CfnRemediationConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.config.CfnRemediationConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRemediationConfiguration>

Enclosing class:

CfnRemediationConfiguration

@Stability(value=Stable)
public static final class CfnRemediationConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRemediationConfiguration>

A fluent builder for CfnRemediationConfiguration.

Method Summary

Modifier and Type	Method and Description
CfnRemediationConfiguration.Builder	automatic(Boolean automatic) The remediation is triggered automatically.
CfnRemediationConfiguration.Builder	automatic(IResolvable automatic) The remediation is triggered automatically.
CfnRemediationConfiguration	build()
CfnRemediationConfiguration.Builder	configRuleName(String configRuleName) The name of the AWS Config rule.
static CfnRemediationConfiguration.Builder	create(software.constructs.Construct scope, String id)
CfnRemediationConfiguration.Builder	executionControls(CfnRemediationConfiguration.ExecutionControlsProperty executionControls) An ExecutionControls object.
CfnRemediationConfiguration.Builder	executionControls(IResolvable executionControls) An ExecutionControls object.
CfnRemediationConfiguration.Builder	maximumAutomaticAttempts(Number maximumAutomaticAttempts) The maximum number of failed attempts for auto-remediation.
CfnRemediationConfiguration.Builder	parameters(Object parameters) An object of the RemediationParameterValue.
CfnRemediationConfiguration.Builder	resourceType(String resourceType) The type of a resource.
CfnRemediationConfiguration.Builder	retryAttemptSeconds(Number retryAttemptSeconds) Maximum time in seconds that AWS Config runs auto-remediation.
CfnRemediationConfiguration.Builder	targetId(String targetId) Target ID is the name of the public document.
CfnRemediationConfiguration.Builder	targetType(String targetType) The type of the target.
CfnRemediationConfiguration.Builder	targetVersion(String targetVersion) Version of the target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnRemediationConfiguration.Builder create(software.constructs.Construct scope,
                                                                                  String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnRemediationConfiguration.ExecutionControlsProperty.Builder.

configRuleName

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder configRuleName(String configRuleName)

The name of the AWS Config rule.

Parameters:

configRuleName - The name of the AWS Config rule. This parameter is required.

Returns:

this

targetId

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder targetId(String targetId)

Target ID is the name of the public document.

Parameters:

targetId - Target ID is the name of the public document. This parameter is required.

Returns:

this

targetType

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder targetType(String targetType)

The type of the target.

Target executes remediation. For example, SSM document.

Parameters:

targetType - The type of the target. This parameter is required.

Returns:

this

automatic

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder automatic(Boolean automatic)

The remediation is triggered automatically.

Parameters:

automatic - The remediation is triggered automatically. This parameter is required.

Returns:

this

automatic

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder automatic(IResolvable automatic)

The remediation is triggered automatically.

Parameters:

automatic - The remediation is triggered automatically. This parameter is required.

Returns:

this

executionControls

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder executionControls(CfnRemediationConfiguration.ExecutionControlsProperty executionControls)

An ExecutionControls object.

Parameters:

executionControls - An ExecutionControls object. This parameter is required.

Returns:

this

executionControls

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder executionControls(IResolvable executionControls)

An ExecutionControls object.

Parameters:

executionControls - An ExecutionControls object. This parameter is required.

Returns:

this

maximumAutomaticAttempts

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder maximumAutomaticAttempts(Number 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. This parameter is required.

Returns:

this

parameters

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder parameters(Object parameters)

An object of the RemediationParameterValue.

The type is a map of strings to RemediationParameterValue.

Parameters:

parameters - An object of the RemediationParameterValue. This parameter is required.

Returns:

this

resourceType

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder resourceType(String resourceType)

The type of a resource.

Parameters:

resourceType - The type of a resource. This parameter is required.

Returns:

this

retryAttemptSeconds

@Stability(value=Stable)
public CfnRemediationConfiguration.Builder retryAttemptSeconds(Number 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. This parameter is required.

Returns:

this

targetVersion

@Stability(value=Stable)
public CfnRemediationConfiguration.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. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnRemediationConfiguration build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnRemediationConfiguration>