software.amazon.awscdk.services.config

Class CfnRemediationConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.config.CfnRemediationConfiguration

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.734Z")
 @Stability(value=Stable)
public class CfnRemediationConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Config::RemediationConfiguration`.

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 Object parameters;
 CfnRemediationConfiguration cfnRemediationConfiguration = CfnRemediationConfiguration.Builder.create(this, "MyCfnRemediationConfiguration")
         .configRuleName("configRuleName")
         .targetId("targetId")
         .targetType("targetType")
         // the properties below are optional
         .automatic(false)
         .executionControls(ExecutionControlsProperty.builder()
                 .ssmControls(SsmControlsProperty.builder()
                         .concurrentExecutionRatePercentage(123)
                         .errorPercentage(123)
                         .build())
                 .build())
         .maximumAutomaticAttempts(123)
         .parameters(parameters)
         .resourceType("resourceType")
         .retryAttemptSeconds(123)
         .targetVersion("targetVersion")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRemediationConfiguration.Builder A fluent builder for CfnRemediationConfiguration.
static interface	CfnRemediationConfiguration.ExecutionControlsProperty An ExecutionControls object.
static interface	CfnRemediationConfiguration.RemediationParameterValueProperty The value is either a dynamic (resource) value or a static value.
static interface	CfnRemediationConfiguration.ResourceValueProperty The dynamic value of the resource.
static interface	CfnRemediationConfiguration.SsmControlsProperty AWS Systems Manager (SSM) specific remediation controls.
static interface	CfnRemediationConfiguration.StaticValueProperty The static value of the resource.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRemediationConfiguration(software.constructs.Construct scope, String id, CfnRemediationConfigurationProps props) Create a new `AWS::Config::RemediationConfiguration`.
protected	CfnRemediationConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRemediationConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAutomatic() The remediation is triggered automatically.
protected Map<String,Object>	getCfnProperties()
String	getConfigRuleName() The name of the AWS Config rule.
Object	getExecutionControls() An ExecutionControls object.
Number	getMaximumAutomaticAttempts() The maximum number of failed attempts for auto-remediation.
Object	getParameters() An object of the RemediationParameterValue.
String	getResourceType() The type of a resource.
Number	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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutomatic(Boolean value) The remediation is triggered automatically.
void	setAutomatic(IResolvable value) The remediation is triggered automatically.
void	setConfigRuleName(String value) The name of the AWS Config rule.
void	setExecutionControls(CfnRemediationConfiguration.ExecutionControlsProperty value) An ExecutionControls object.
void	setExecutionControls(IResolvable value) An ExecutionControls object.
void	setMaximumAutomaticAttempts(Number value) The maximum number of failed attempts for auto-remediation.
void	setParameters(Object value) An object of the RemediationParameterValue.
void	setResourceType(String value) The type of a resource.
void	setRetryAttemptSeconds(Number value) Maximum time in seconds that AWS Config runs auto-remediation.
void	setTargetId(String value) Target ID is the name of the public document.
void	setTargetType(String value) The type of the target.
void	setTargetVersion(String value) Version of the target.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRemediationConfiguration

protected CfnRemediationConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

CfnRemediationConfiguration

protected CfnRemediationConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRemediationConfiguration

@Stability(value=Stable)
public CfnRemediationConfiguration(@NotNull
                                                            software.constructs.Construct scope,
                                                            @NotNull
                                                            String id,
                                                            @NotNull
                                                            CfnRemediationConfigurationProps props)

Create a new `AWS::Config::RemediationConfiguration`.

Parameters:

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

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

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfigRuleName

@Stability(value=Stable)
 @NotNull
public String getConfigRuleName()

The name of the AWS Config rule.

setConfigRuleName

@Stability(value=Stable)
public void setConfigRuleName(@NotNull
                                                       String value)

The name of the AWS Config rule.

getParameters

@Stability(value=Stable)
 @NotNull
public Object getParameters()

An object of the RemediationParameterValue.

The type is a map of strings to RemediationParameterValue.

setParameters

@Stability(value=Stable)
public void setParameters(@NotNull
                                                   Object value)

An object of the RemediationParameterValue.

The type is a map of strings to RemediationParameterValue.

getTargetId

@Stability(value=Stable)
 @NotNull
public String getTargetId()

Target ID is the name of the public document.

setTargetId

@Stability(value=Stable)
public void setTargetId(@NotNull
                                                 String value)

Target ID is the name of the public document.

getTargetType

@Stability(value=Stable)
 @NotNull
public String getTargetType()

The type of the target.

Target executes remediation. For example, SSM document.

setTargetType

@Stability(value=Stable)
public void setTargetType(@NotNull
                                                   String value)

The type of the target.

Target executes remediation. For example, SSM document.

getAutomatic

@Stability(value=Stable)
 @Nullable
public Object getAutomatic()

The remediation is triggered automatically.

setAutomatic

@Stability(value=Stable)
public void setAutomatic(@Nullable
                                                  Boolean value)

The remediation is triggered automatically.

setAutomatic

@Stability(value=Stable)
public void setAutomatic(@Nullable
                                                  IResolvable value)

The remediation is triggered automatically.

getExecutionControls

@Stability(value=Stable)
 @Nullable
public Object getExecutionControls()

An ExecutionControls object.

setExecutionControls

@Stability(value=Stable)
public void setExecutionControls(@Nullable
                                                          CfnRemediationConfiguration.ExecutionControlsProperty value)

An ExecutionControls object.

setExecutionControls

@Stability(value=Stable)
public void setExecutionControls(@Nullable
                                                          IResolvable value)

An ExecutionControls object.

getMaximumAutomaticAttempts

@Stability(value=Stable)
 @Nullable
public Number 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.

setMaximumAutomaticAttempts

@Stability(value=Stable)
public void setMaximumAutomaticAttempts(@Nullable
                                                                 Number value)

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.

getResourceType

@Stability(value=Stable)
 @Nullable
public String getResourceType()

The type of a resource.

setResourceType

@Stability(value=Stable)
public void setResourceType(@Nullable
                                                     String value)

The type of a resource.

getRetryAttemptSeconds

@Stability(value=Stable)
 @Nullable
public Number 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.

setRetryAttemptSeconds

@Stability(value=Stable)
public void setRetryAttemptSeconds(@Nullable
                                                            Number value)

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.

getTargetVersion

@Stability(value=Stable)
 @Nullable
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.

setTargetVersion

@Stability(value=Stable)
public void setTargetVersion(@Nullable
                                                      String value)

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.