/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.config.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* 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 AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ConfigRule implements Serializable, Cloneable, StructuredPojo { /** *

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

*/ private String configRuleName; /** *

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

*/ private String configRuleArn; /** *

* The ID of the Config rule. *

*/ private String configRuleId; /** *

* The description that you provide for the Config rule. *

*/ private String description; /** *

* 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. *

* */ private Scope scope; /** *

* 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. *

*/ private Source source; /** *

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

*/ private String inputParameters; /** *

* The maximum frequency with which Config runs evaluations for a rule. You can specify a value for * MaximumExecutionFrequency when: *

* * *

* By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid * value for the MaximumExecutionFrequency parameter. *

* */ private String maximumExecutionFrequency; /** *

* 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. *

*/ private String configRuleState; /** *

* 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. *

* */ private String createdBy; /** *

* The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is * Detective evaluation mode only. *

*/ private com.amazonaws.internal.SdkInternalList evaluationModes; /** *

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

* * @param configRuleName * The name that you assign to the Config rule. The name is required if you are adding a new rule. */ public void setConfigRuleName(String configRuleName) { this.configRuleName = configRuleName; } /** *

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

* * @return The name that you assign to the Config rule. The name is required if you are adding a new rule. */ public String getConfigRuleName() { return this.configRuleName; } /** *

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

* * @param configRuleName * The name that you assign to the Config rule. The name is required if you are adding a new rule. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withConfigRuleName(String configRuleName) { setConfigRuleName(configRuleName); return this; } /** *

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

* * @param configRuleArn * The Amazon Resource Name (ARN) of the Config rule. */ public void setConfigRuleArn(String configRuleArn) { this.configRuleArn = configRuleArn; } /** *

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

* * @return The Amazon Resource Name (ARN) of the Config rule. */ public String getConfigRuleArn() { return this.configRuleArn; } /** *

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

* * @param configRuleArn * The Amazon Resource Name (ARN) of the Config rule. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withConfigRuleArn(String configRuleArn) { setConfigRuleArn(configRuleArn); return this; } /** *

* The ID of the Config rule. *

* * @param configRuleId * The ID of the Config rule. */ public void setConfigRuleId(String configRuleId) { this.configRuleId = configRuleId; } /** *

* The ID of the Config rule. *

* * @return The ID of the Config rule. */ public String getConfigRuleId() { return this.configRuleId; } /** *

* The ID of the Config rule. *

* * @param configRuleId * The ID of the Config rule. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withConfigRuleId(String configRuleId) { setConfigRuleId(configRuleId); return this; } /** *

* The description that you provide for the Config rule. *

* * @param description * The description that you provide for the Config rule. */ public void setDescription(String description) { this.description = description; } /** *

* The description that you provide for the Config rule. *

* * @return The description that you provide for the Config rule. */ public String getDescription() { return this.description; } /** *

* The description that you provide for the Config rule. *

* * @param description * The description that you provide for the Config rule. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withDescription(String description) { setDescription(description); return this; } /** *

* 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. *

* * * @param 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. *

*/ public void setScope(Scope scope) { this.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. *

* * * @return 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. *

*/ public Scope getScope() { return this.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. *

* * * @param 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. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withScope(Scope scope) { setScope(scope); return this; } /** *

* 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. *

* * @param 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. */ public void setSource(Source source) { this.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. *

* * @return 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. */ public Source getSource() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withSource(Source source) { setSource(source); return this; } /** *

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

* * @param inputParameters * A string, in JSON format, that is passed to the Config rule Lambda function. */ public void setInputParameters(String inputParameters) { this.inputParameters = inputParameters; } /** *

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

* * @return A string, in JSON format, that is passed to the Config rule Lambda function. */ public String getInputParameters() { return this.inputParameters; } /** *

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

* * @param inputParameters * A string, in JSON format, that is passed to the Config rule Lambda function. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withInputParameters(String inputParameters) { setInputParameters(inputParameters); return this; } /** *

* 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. *

* * * @param 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 MaximumExecutionFrequency */ public void setMaximumExecutionFrequency(String maximumExecutionFrequency) { this.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. *

* * * @return 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 MaximumExecutionFrequency */ public String getMaximumExecutionFrequency() { return this.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. *

* * * @param 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. *

* @return Returns a reference to this object so that method calls can be chained together. * @see MaximumExecutionFrequency */ public ConfigRule withMaximumExecutionFrequency(String maximumExecutionFrequency) { setMaximumExecutionFrequency(maximumExecutionFrequency); return this; } /** *

* 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. *

* * * @param 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 MaximumExecutionFrequency */ public void setMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) { withMaximumExecutionFrequency(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. *

* * * @param 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. *

* @return Returns a reference to this object so that method calls can be chained together. * @see MaximumExecutionFrequency */ public ConfigRule withMaximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency) { this.maximumExecutionFrequency = maximumExecutionFrequency.toString(); return this; } /** *

* 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. *

* * @param 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 ConfigRuleState */ public void setConfigRuleState(String configRuleState) { this.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. *

* * @return 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 ConfigRuleState */ public String getConfigRuleState() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see ConfigRuleState */ public ConfigRule withConfigRuleState(String configRuleState) { setConfigRuleState(configRuleState); return this; } /** *

* 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. *

* * @param 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 ConfigRuleState */ public void setConfigRuleState(ConfigRuleState configRuleState) { withConfigRuleState(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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see ConfigRuleState */ public ConfigRule withConfigRuleState(ConfigRuleState configRuleState) { this.configRuleState = configRuleState.toString(); return this; } /** *

* 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. *

* * * @param 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. *

*/ public void setCreatedBy(String createdBy) { this.createdBy = 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. *

* * * @return 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. *

*/ public String getCreatedBy() { return this.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. *

* * * @param 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. *

* @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withCreatedBy(String createdBy) { setCreatedBy(createdBy); return this; } /** *

* The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is * Detective evaluation mode only. *

* * @return The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the * value is Detective evaluation mode only. */ public java.util.List getEvaluationModes() { if (evaluationModes == null) { evaluationModes = new com.amazonaws.internal.SdkInternalList(); } return 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. *

* * @param 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. */ public void setEvaluationModes(java.util.Collection evaluationModes) { if (evaluationModes == null) { this.evaluationModes = null; return; } this.evaluationModes = new com.amazonaws.internal.SdkInternalList(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 * {@link #setEvaluationModes(java.util.Collection)} or {@link #withEvaluationModes(java.util.Collection)} if you * want to override the existing values. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withEvaluationModes(EvaluationModeConfiguration... evaluationModes) { if (this.evaluationModes == null) { setEvaluationModes(new com.amazonaws.internal.SdkInternalList(evaluationModes.length)); } for (EvaluationModeConfiguration ele : evaluationModes) { this.evaluationModes.add(ele); } return this; } /** *

* The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is * Detective evaluation mode only. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ConfigRule withEvaluationModes(java.util.Collection evaluationModes) { setEvaluationModes(evaluationModes); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getConfigRuleName() != null) sb.append("ConfigRuleName: ").append(getConfigRuleName()).append(","); if (getConfigRuleArn() != null) sb.append("ConfigRuleArn: ").append(getConfigRuleArn()).append(","); if (getConfigRuleId() != null) sb.append("ConfigRuleId: ").append(getConfigRuleId()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getScope() != null) sb.append("Scope: ").append(getScope()).append(","); if (getSource() != null) sb.append("Source: ").append(getSource()).append(","); if (getInputParameters() != null) sb.append("InputParameters: ").append(getInputParameters()).append(","); if (getMaximumExecutionFrequency() != null) sb.append("MaximumExecutionFrequency: ").append(getMaximumExecutionFrequency()).append(","); if (getConfigRuleState() != null) sb.append("ConfigRuleState: ").append(getConfigRuleState()).append(","); if (getCreatedBy() != null) sb.append("CreatedBy: ").append(getCreatedBy()).append(","); if (getEvaluationModes() != null) sb.append("EvaluationModes: ").append(getEvaluationModes()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ConfigRule == false) return false; ConfigRule other = (ConfigRule) obj; if (other.getConfigRuleName() == null ^ this.getConfigRuleName() == null) return false; if (other.getConfigRuleName() != null && other.getConfigRuleName().equals(this.getConfigRuleName()) == false) return false; if (other.getConfigRuleArn() == null ^ this.getConfigRuleArn() == null) return false; if (other.getConfigRuleArn() != null && other.getConfigRuleArn().equals(this.getConfigRuleArn()) == false) return false; if (other.getConfigRuleId() == null ^ this.getConfigRuleId() == null) return false; if (other.getConfigRuleId() != null && other.getConfigRuleId().equals(this.getConfigRuleId()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getScope() == null ^ this.getScope() == null) return false; if (other.getScope() != null && other.getScope().equals(this.getScope()) == false) return false; if (other.getSource() == null ^ this.getSource() == null) return false; if (other.getSource() != null && other.getSource().equals(this.getSource()) == false) return false; if (other.getInputParameters() == null ^ this.getInputParameters() == null) return false; if (other.getInputParameters() != null && other.getInputParameters().equals(this.getInputParameters()) == false) return false; if (other.getMaximumExecutionFrequency() == null ^ this.getMaximumExecutionFrequency() == null) return false; if (other.getMaximumExecutionFrequency() != null && other.getMaximumExecutionFrequency().equals(this.getMaximumExecutionFrequency()) == false) return false; if (other.getConfigRuleState() == null ^ this.getConfigRuleState() == null) return false; if (other.getConfigRuleState() != null && other.getConfigRuleState().equals(this.getConfigRuleState()) == false) return false; if (other.getCreatedBy() == null ^ this.getCreatedBy() == null) return false; if (other.getCreatedBy() != null && other.getCreatedBy().equals(this.getCreatedBy()) == false) return false; if (other.getEvaluationModes() == null ^ this.getEvaluationModes() == null) return false; if (other.getEvaluationModes() != null && other.getEvaluationModes().equals(this.getEvaluationModes()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getConfigRuleName() == null) ? 0 : getConfigRuleName().hashCode()); hashCode = prime * hashCode + ((getConfigRuleArn() == null) ? 0 : getConfigRuleArn().hashCode()); hashCode = prime * hashCode + ((getConfigRuleId() == null) ? 0 : getConfigRuleId().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode()); hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode()); hashCode = prime * hashCode + ((getInputParameters() == null) ? 0 : getInputParameters().hashCode()); hashCode = prime * hashCode + ((getMaximumExecutionFrequency() == null) ? 0 : getMaximumExecutionFrequency().hashCode()); hashCode = prime * hashCode + ((getConfigRuleState() == null) ? 0 : getConfigRuleState().hashCode()); hashCode = prime * hashCode + ((getCreatedBy() == null) ? 0 : getCreatedBy().hashCode()); hashCode = prime * hashCode + ((getEvaluationModes() == null) ? 0 : getEvaluationModes().hashCode()); return hashCode; } @Override public ConfigRule clone() { try { return (ConfigRule) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.config.model.transform.ConfigRuleMarshaller.getInstance().marshall(this, protocolMarshaller); } }