ConfigRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.config.model.ConfigRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConfigRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Config rules evaluate the configuration settings of your Amazon Web Services resources. A rule can run when Config detects a configuration change to an Amazon Web Services resource or at a periodic frequency that you choose (for example, every 24 hours). There are two types of rules: Config Managed Rules and Config Custom Rules.

Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules.

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.

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

You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConfigRule()

Constructors
Constructor and Description
`ConfigRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConfigRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getConfigRuleArn()` The Amazon Resource Name (ARN) of the Config rule.
`String`	`getConfigRuleId()` The ID of the Config rule.
`String`	`getConfigRuleName()` The name that you assign to the Config rule.
`String`	`getConfigRuleState()` Indicates whether the Config rule is active or is currently being deleted by Config.
`String`	`getCreatedBy()` Service principal name of the service that created the rule.
`String`	`getDescription()` The description that you provide for the Config rule.
`List<EvaluationModeConfiguration>`	`getEvaluationModes()` The modes the Config rule can be evaluated in.
`String`	`getInputParameters()` A string, in JSON format, that is passed to the Config rule Lambda function.
`String`	`getMaximumExecutionFrequency()` The maximum frequency with which Config runs evaluations for a rule.
`Scope`	`getScope()` Defines which resources can trigger an evaluation for the rule.
`Source`	`getSource()` Provides the rule owner (`Amazon Web Services` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setConfigRuleArn(String configRuleArn)` The Amazon Resource Name (ARN) of the Config rule.
`void`	`setConfigRuleId(String configRuleId)` The ID of the Config rule.
`void`	`setConfigRuleName(String configRuleName)` The name that you assign to the Config rule.
`void`	`setConfigRuleState(ConfigRuleState configRuleState)` Indicates whether the Config rule is active or is currently being deleted by Config.
`void`	`setConfigRuleState(String configRuleState)` Indicates whether the Config rule is active or is currently being deleted by Config.
`void`	`setCreatedBy(String createdBy)` Service principal name of the service that created the rule.
`void`	`setDescription(String description)` The description that you provide for the Config rule.
`void`	`setEvaluationModes(Collection<EvaluationModeConfiguration> evaluationModes)` The modes the Config rule can be evaluated in.
`void`	`setInputParameters(String inputParameters)` A string, in JSON format, that is passed to the Config rule Lambda function.
`void`	`setMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations for a rule.
`void`	`setMaximumExecutionFrequency(String maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations for a rule.
`void`	`setScope(Scope scope)` Defines which resources can trigger an evaluation for the rule.
`void`	`setSource(Source source)` Provides the rule owner (`Amazon Web Services` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
`String`	`toString()` Returns a string representation of this object.
`ConfigRule`	`withConfigRuleArn(String configRuleArn)` The Amazon Resource Name (ARN) of the Config rule.
`ConfigRule`	`withConfigRuleId(String configRuleId)` The ID of the Config rule.
`ConfigRule`	`withConfigRuleName(String configRuleName)` The name that you assign to the Config rule.
`ConfigRule`	`withConfigRuleState(ConfigRuleState configRuleState)` Indicates whether the Config rule is active or is currently being deleted by Config.
`ConfigRule`	`withConfigRuleState(String configRuleState)` Indicates whether the Config rule is active or is currently being deleted by Config.
`ConfigRule`	`withCreatedBy(String createdBy)` Service principal name of the service that created the rule.
`ConfigRule`	`withDescription(String description)` The description that you provide for the Config rule.
`ConfigRule`	`withEvaluationModes(Collection<EvaluationModeConfiguration> evaluationModes)` The modes the Config rule can be evaluated in.
`ConfigRule`	`withEvaluationModes(EvaluationModeConfiguration... evaluationModes)` The modes the Config rule can be evaluated in.
`ConfigRule`	`withInputParameters(String inputParameters)` A string, in JSON format, that is passed to the Config rule Lambda function.
`ConfigRule`	`withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations for a rule.
`ConfigRule`	`withMaximumExecutionFrequency(String maximumExecutionFrequency)` The maximum frequency with which Config runs evaluations for a rule.
`ConfigRule`	`withScope(Scope scope)` Defines which resources can trigger an evaluation for the rule.
`ConfigRule`	`withSource(Source source)` Provides the rule owner (`Amazon Web Services` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConfigRule
```
public ConfigRule()
```
- Method Detail
  - setConfigRuleName
```
public void setConfigRuleName(String configRuleName)
```
    The name that you assign to the Config rule. The name is required if you are adding a new rule.
    
    Parameters:
    
    configRuleName - The name that you assign to the Config rule. The name is required if you are adding a new rule.
  - getConfigRuleName
```
public String getConfigRuleName()
```
    The name that you assign to the Config rule. The name is required if you are adding a new rule.
    
    Returns:
    
    The name that you assign to the 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 Config rule. The name is required if you are adding a new rule.
    
    Parameters:
    
    configRuleName - The name that you assign to the Config rule. The name is required if you are adding a new rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfigRuleArn
```
public void setConfigRuleArn(String configRuleArn)
```
    The Amazon Resource Name (ARN) of the Config rule.
    
    Parameters:
    
    configRuleArn - The Amazon Resource Name (ARN) of the Config rule.
  - getConfigRuleArn
```
public String getConfigRuleArn()
```
    The Amazon Resource Name (ARN) of the Config rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Config rule.
  - withConfigRuleArn
```
public ConfigRule withConfigRuleArn(String configRuleArn)
```
    The Amazon Resource Name (ARN) of the Config rule.
    
    Parameters:
    
    configRuleArn - The Amazon Resource Name (ARN) of the Config rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfigRuleId
```
public void setConfigRuleId(String configRuleId)
```
    The ID of the Config rule.
    
    Parameters:
    
    configRuleId - The ID of the Config rule.
  - getConfigRuleId
```
public String getConfigRuleId()
```
    The ID of the Config rule.
    
    Returns:
    
    The ID of the Config rule.
  - withConfigRuleId
```
public ConfigRule withConfigRuleId(String configRuleId)
```
    The ID of the Config rule.
    
    Parameters:
    
    configRuleId - The ID of the Config rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description that you provide for the Config rule.
    
    Parameters:
    
    description - The description that you provide for the Config rule.
  - getDescription
```
public String getDescription()
```
    The description that you provide for the Config rule.
    
    Returns:
    
    The description that you provide for the Config rule.
  - withDescription
```
public ConfigRule withDescription(String description)
```
    The description that you provide for the Config rule.
    
    Parameters:
    
    description - The description that you provide for the Config rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScope
```
public void setScope(Scope scope)
```
    Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
    
    The scope can be empty.
    
    Parameters:
    
    scope - Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
    
    The scope can be empty.
  - getScope
```
public Scope getScope()
```
    Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
    
    The scope can be empty.
    
    Returns:
    
    Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
    
    The scope can be empty.
  - withScope
```
public ConfigRule withScope(Scope scope)
```
    Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
    
    The scope can be empty.
    
    Parameters:
    
    scope - Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
    
    The scope can be empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSource
```
public void setSource(Source source)
```
    Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
    
    Parameters:
    
    source - Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
  - getSource
```
public Source getSource()
```
    Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
    
    Returns:
    
    Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
  - withSource
```
public ConfigRule withSource(Source source)
```
    Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
    
    Parameters:
    
    source - Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputParameters
```
public void setInputParameters(String inputParameters)
```
    A string, in JSON format, that is passed to the Config rule Lambda function.
    
    Parameters:
    
    inputParameters - A string, in JSON format, that is passed to the Config rule Lambda function.
  - getInputParameters
```
public String getInputParameters()
```
    A string, in JSON format, that is passed to the Config rule Lambda function.
    
    Returns:
    
    A string, in JSON format, that is passed to the Config rule Lambda function.
  - withInputParameters
```
public ConfigRule withInputParameters(String inputParameters)
```
    A string, in JSON format, that is passed to the Config rule Lambda function.
    
    Parameters:
    
    inputParameters - A string, in JSON format, that is passed to the Config rule Lambda function.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaximumExecutionFrequency
```
public void setMaximumExecutionFrequency(String maximumExecutionFrequency)
```
    The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    - This is for an Config managed rule that is triggered at a periodic frequency.
    - Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    Parameters:
    maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    
    This is for an Config managed rule that is triggered at a periodic frequency.
    
    Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    See Also:
    
    MaximumExecutionFrequency
  - getMaximumExecutionFrequency
```
public String getMaximumExecutionFrequency()
```
    The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    - This is for an Config managed rule that is triggered at a periodic frequency.
    - Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    Returns:
    The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    
    This is for an Config managed rule that is triggered at a periodic frequency.
    
    Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    See Also:
    
    MaximumExecutionFrequency
  - withMaximumExecutionFrequency
```
public ConfigRule withMaximumExecutionFrequency(String maximumExecutionFrequency)
```
    The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    - This is for an Config managed rule that is triggered at a periodic frequency.
    - Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    Parameters:
    maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    
    This is for an Config managed rule that is triggered at a periodic frequency.
    
    Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaximumExecutionFrequency
  - setMaximumExecutionFrequency
```
public void setMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
```
    The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    - This is for an Config managed rule that is triggered at a periodic frequency.
    - Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    Parameters:
    maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    
    This is for an Config managed rule that is triggered at a periodic frequency.
    
    Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    See Also:
    
    MaximumExecutionFrequency
  - withMaximumExecutionFrequency
```
public ConfigRule withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)
```
    The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    - This is for an Config managed rule that is triggered at a periodic frequency.
    - Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    Parameters:
    maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
    
    This is for an Config managed rule that is triggered at a periodic frequency.
    
    Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
    
    By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaximumExecutionFrequency
  - setConfigRuleState
```
public void setConfigRuleState(String configRuleState)
```
    Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    Parameters:
    
    configRuleState - Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    See Also:
    
    ConfigRuleState
  - getConfigRuleState
```
public String getConfigRuleState()
```
    Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    Returns:
    
    Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    See Also:
    
    ConfigRuleState
  - withConfigRuleState
```
public ConfigRule withConfigRuleState(String configRuleState)
```
    Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    Parameters:
    
    configRuleState - Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfigRuleState
  - setConfigRuleState
```
public void setConfigRuleState(ConfigRuleState configRuleState)
```
    Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    Parameters:
    
    configRuleState - Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    See Also:
    
    ConfigRuleState
  - withConfigRuleState
```
public ConfigRule withConfigRuleState(ConfigRuleState configRuleState)
```
    Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    Parameters:
    
    configRuleState - Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
    
    Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
    
    Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
    
    Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfigRuleState
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    Service principal name of the service that created the rule.
    
    The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
    
    Parameters:
    
    createdBy - Service principal name of the service that created the rule.
    
    The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
  - getCreatedBy
```
public String getCreatedBy()
```
    Service principal name of the service that created the rule.
    
    The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
    
    Returns:
    
    Service principal name of the service that created the rule.
    
    The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
  - withCreatedBy
```
public ConfigRule withCreatedBy(String createdBy)
```
    Service principal name of the service that created the rule.
    
    The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
    
    Parameters:
    
    createdBy - Service principal name of the service that created the rule.
    
    The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEvaluationModes
```
public List<EvaluationModeConfiguration> getEvaluationModes()
```
    The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
    
    Returns:
    
    The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
  - setEvaluationModes
```
public void setEvaluationModes(Collection<EvaluationModeConfiguration> evaluationModes)
```
    The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
    
    Parameters:
    
    evaluationModes - The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
  - withEvaluationModes
```
public ConfigRule withEvaluationModes(EvaluationModeConfiguration... evaluationModes)
```
    The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
    
    NOTE: This method appends the values to the existing list (if any). Use setEvaluationModes(java.util.Collection) or withEvaluationModes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    evaluationModes - The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEvaluationModes
```
public ConfigRule withEvaluationModes(Collection<EvaluationModeConfiguration> evaluationModes)
```
    The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
    
    Parameters:
    
    evaluationModes - The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ConfigRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class ConfigRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigRule

Method Detail

setConfigRuleName

getConfigRuleName

withConfigRuleName

setConfigRuleArn

getConfigRuleArn

withConfigRuleArn

setConfigRuleId

getConfigRuleId

withConfigRuleId

setDescription

getDescription

withDescription

setScope

getScope

withScope

setSource

getSource

withSource

setInputParameters

getInputParameters

withInputParameters

setMaximumExecutionFrequency

getMaximumExecutionFrequency

withMaximumExecutionFrequency

setMaximumExecutionFrequency

withMaximumExecutionFrequency

setConfigRuleState

getConfigRuleState

withConfigRuleState

setConfigRuleState

withConfigRuleState

setCreatedBy

getCreatedBy

withCreatedBy

getEvaluationModes

setEvaluationModes

withEvaluationModes

withEvaluationModes

toString

equals

hashCode

clone

marshall