com.amazonaws.services.config.model

Class ConfigRule

java.lang.Object

com.amazonaws.services.config.model.ConfigRule

All Implemented Interfaces:

Serializable, Cloneable

public class ConfigRule
extends Object
implements Serializable, Cloneable

An AWS Lambda function that evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change or delivers a configuration snapshot. This function can evaluate any resource in the recording group. To define which of these are evaluated, specify a value for the Scope key.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigRule()

Method Summary

Methods

Modifier and Type	Method and Description
ConfigRule	clone()
boolean	equals(Object obj)
String	getConfigRuleArn() The Amazon Resource Name (ARN) of the AWS Config rule.
String	getConfigRuleId() The ID of the AWS Config rule.
String	getConfigRuleName() The name that you assign to the AWS Config rule.
String	getConfigRuleState() Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
String	getDescription() The description that you provide for the AWS Config rule.
String	getInputParameters() A string in JSON format that is passed to the AWS Config rule Lambda function.
String	getMaximumExecutionFrequency() The maximum frequency at which the AWS Config rule runs evaluations.
Scope	getScope() Defines which resources the AWS Config rule evaluates.
Source	getSource() Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
int	hashCode()
void	setConfigRuleArn(String configRuleArn) The Amazon Resource Name (ARN) of the AWS Config rule.
void	setConfigRuleId(String configRuleId) The ID of the AWS Config rule.
void	setConfigRuleName(String configRuleName) The name that you assign to the AWS Config rule.
void	setConfigRuleState(ConfigRuleState configRuleState) Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
void	setConfigRuleState(String configRuleState) Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
void	setDescription(String description) The description that you provide for the AWS Config rule.
void	setInputParameters(String inputParameters) A string in JSON format that is passed to the AWS Config rule Lambda function.
void	setMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.
void	setMaximumExecutionFrequency(String maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.
void	setScope(Scope scope) Defines which resources the AWS Config rule evaluates.
void	setSource(Source source) Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ConfigRule	withConfigRuleArn(String configRuleArn) The Amazon Resource Name (ARN) of the AWS Config rule.
ConfigRule	withConfigRuleId(String configRuleId) The ID of the AWS Config rule.
ConfigRule	withConfigRuleName(String configRuleName) The name that you assign to the AWS Config rule.
ConfigRule	withConfigRuleState(ConfigRuleState configRuleState) Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
ConfigRule	withConfigRuleState(String configRuleState) Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
ConfigRule	withDescription(String description) The description that you provide for the AWS Config rule.
ConfigRule	withInputParameters(String inputParameters) A string in JSON format that is passed to the AWS Config rule Lambda function.
ConfigRule	withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.
ConfigRule	withMaximumExecutionFrequency(String maximumExecutionFrequency) The maximum frequency at which the AWS Config rule runs evaluations.
ConfigRule	withScope(Scope scope) Defines which resources the AWS Config rule evaluates.
ConfigRule	withSource(Source source) Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigRule

public ConfigRule()

Method Detail

getConfigRuleName

public String getConfigRuleName()

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

Constraints:
Length: 1 - 64

Returns:

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

setConfigRuleName

public void setConfigRuleName(String configRuleName)

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

Constraints:
Length: 1 - 64

Parameters:

configRuleName - The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

withConfigRuleName

public ConfigRule withConfigRuleName(String configRuleName)

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

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

Constraints:
Length: 1 - 64

Parameters:

configRuleName - The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

Returns:

A reference to this updated object so that method calls can be chained together.

getConfigRuleArn

public String getConfigRuleArn()

The Amazon Resource Name (ARN) of the AWS Config rule.

Returns:

The Amazon Resource Name (ARN) of the AWS Config rule.

setConfigRuleArn

public void setConfigRuleArn(String configRuleArn)

The Amazon Resource Name (ARN) of the AWS Config rule.

Parameters:

configRuleArn - The Amazon Resource Name (ARN) of the AWS Config rule.

withConfigRuleArn

public ConfigRule withConfigRuleArn(String configRuleArn)

The Amazon Resource Name (ARN) of the AWS Config rule.

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

Parameters:

configRuleArn - The Amazon Resource Name (ARN) of the AWS Config rule.

Returns:

A reference to this updated object so that method calls can be chained together.

getConfigRuleId

public String getConfigRuleId()

The ID of the AWS Config rule.

Returns:

The ID of the AWS Config rule.

setConfigRuleId

public void setConfigRuleId(String configRuleId)

The ID of the AWS Config rule.

Parameters:

configRuleId - The ID of the AWS Config rule.

withConfigRuleId

public ConfigRule withConfigRuleId(String configRuleId)

The ID of the AWS Config rule.

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

Parameters:

configRuleId - The ID of the AWS Config rule.

Returns:

A reference to this updated object so that method calls can be chained together.

getDescription

public String getDescription()

The description that you provide for the AWS Config rule.

Constraints:
Length: 0 - 256

Returns:

The description that you provide for the AWS Config rule.

setDescription

public void setDescription(String description)

The description that you provide for the AWS Config rule.

Constraints:
Length: 0 - 256

Parameters:

description - The description that you provide for the AWS Config rule.

withDescription

public ConfigRule withDescription(String description)

The description that you provide for the AWS Config rule.

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

Constraints:
Length: 0 - 256

Parameters:

description - The description that you provide for the AWS Config rule.

Returns:

A reference to this updated object so that method calls can be chained together.

getScope

public Scope getScope()

Defines which resources the AWS Config rule evaluates. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one or more resource IDs. Specify a scope to constrain the resources that are evaluated. If you do not specify a scope, the AWS Config Rule evaluates all resources in the recording group.

Returns:

Defines which resources the AWS Config rule evaluates. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one or more resource IDs. Specify a scope to constrain the resources that are evaluated. If you do not specify a scope, the AWS Config Rule evaluates all resources in the recording group.

setScope

public void setScope(Scope scope)

Defines which resources the AWS Config rule evaluates. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one or more resource IDs. Specify a scope to constrain the resources that are evaluated. If you do not specify a scope, the AWS Config Rule evaluates all resources in the recording group.

Parameters:

scope - Defines which resources the AWS Config rule evaluates. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one or more resource IDs. Specify a scope to constrain the resources that are evaluated. If you do not specify a scope, the AWS Config Rule evaluates all resources in the recording group.

withScope

public ConfigRule withScope(Scope scope)

Defines which resources the AWS Config rule evaluates. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one or more resource IDs. Specify a scope to constrain the resources that are evaluated. If you do not specify a scope, the AWS Config Rule evaluates all resources in the recording group.

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

Parameters:

scope - Defines which resources the AWS Config rule evaluates. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one or more resource IDs. Specify a scope to constrain the resources that are evaluated. If you do not specify a scope, the AWS Config Rule evaluates all resources in the recording group.

Returns:

A reference to this updated object so that method calls can be chained together.

getSource

public Source getSource()

Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.

Returns:

Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.

setSource

public void setSource(Source source)

Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.

Parameters:

source - Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.

withSource

public ConfigRule withSource(Source source)

Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.

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

Parameters:

source - Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.

Returns:

A reference to this updated object so that method calls can be chained together.

getInputParameters

public String getInputParameters()

A string in JSON format that is passed to the AWS Config rule Lambda function.

Constraints:
Length: 1 - 256

Returns:

A string in JSON format that is passed to the AWS Config rule Lambda function.

setInputParameters

public void setInputParameters(String inputParameters)

A string in JSON format that is passed to the AWS Config rule Lambda function.

Constraints:
Length: 1 - 256

Parameters:

inputParameters - A string in JSON format that is passed to the AWS Config rule Lambda function.

withInputParameters

public ConfigRule withInputParameters(String inputParameters)

A string in JSON format that is passed to the AWS Config rule Lambda function.

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

Constraints:
Length: 1 - 256

Parameters:

inputParameters - A string in JSON format that is passed to the AWS Config rule Lambda function.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaximumExecutionFrequency

public String getMaximumExecutionFrequency()

The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

Constraints:
Allowed Values: One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours

Returns:

The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

See Also:

MaximumExecutionFrequency

setMaximumExecutionFrequency

public void setMaximumExecutionFrequency(String maximumExecutionFrequency)

The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

Constraints:
Allowed Values: One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours

Parameters:

maximumExecutionFrequency - The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

See Also:

MaximumExecutionFrequency

withMaximumExecutionFrequency

public ConfigRule withMaximumExecutionFrequency(String maximumExecutionFrequency)

The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

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

Constraints:
Allowed Values: One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours

Parameters:

maximumExecutionFrequency - The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

MaximumExecutionFrequency

setMaximumExecutionFrequency

public void setMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)

The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

Constraints:
Allowed Values: One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours

Parameters:

maximumExecutionFrequency - The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

See Also:

MaximumExecutionFrequency

withMaximumExecutionFrequency

public ConfigRule withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)

The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

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

Constraints:
Allowed Values: One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours

Parameters:

maximumExecutionFrequency - The maximum frequency at which the AWS Config rule runs evaluations.

If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the MaximumExecutionFrequency key to be equal to or greater than the value of the deliveryFrequency key, which is part of ConfigSnapshotDeliveryProperties. To update the frequency with which AWS Config delivers your snapshots, use the PutDeliveryChannel action.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

MaximumExecutionFrequency

getConfigRuleState

public String getConfigRuleState()

Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

Constraints:
Allowed Values: ACTIVE, DELETING

Returns:

Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

See Also:

ConfigRuleState

setConfigRuleState

public void setConfigRuleState(String configRuleState)

Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

Constraints:
Allowed Values: ACTIVE, DELETING

Parameters:

configRuleState - Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

See Also:

ConfigRuleState

withConfigRuleState

public ConfigRule withConfigRuleState(String configRuleState)

Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

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

Constraints:
Allowed Values: ACTIVE, DELETING

Parameters:

configRuleState - Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ConfigRuleState

setConfigRuleState

public void setConfigRuleState(ConfigRuleState configRuleState)

Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

Constraints:
Allowed Values: ACTIVE, DELETING

Parameters:

configRuleState - Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

See Also:

ConfigRuleState

withConfigRuleState

public ConfigRule withConfigRuleState(ConfigRuleState configRuleState)

Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

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

Constraints:
Allowed Values: ACTIVE, DELETING

Parameters:

configRuleState - Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.

You cannot add a rule to AWS Config that has the state set to DELETING. If you want to delete a rule, you must use the DeleteConfigRule request.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ConfigRuleState

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ConfigRule clone()

Overrides:

clone in class Object