com.amazonaws.services.config.model.ConfigRule Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 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;
/**
*
* 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 to an AWS resource and at
* a periodic frequency that you choose (for example, every 24 hours).
*
*
*
* You can use the AWS CLI and AWS SDKs if you want to create a rule that
* triggers evaluations for your resources when AWS Config delivers the
* configuration snapshot. For more information, see
* ConfigSnapshotDeliveryProperties.
*
*
*
* For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS
* Config Developer Guide.
*
*/
public class ConfigRule implements Serializable, Cloneable {
/**
*
* The name that you assign to the AWS Config rule. The name is required if
* you are adding a new rule.
*
*/
private String configRuleName;
/**
*
* The Amazon Resource Name (ARN) of the AWS Config rule.
*
*/
private String configRuleArn;
/**
*
* The ID of the AWS Config rule.
*
*/
private String configRuleId;
/**
*
* The description that you provide for the AWS 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.
*
*/
private Scope scope;
/**
*
* Provides the rule owner (AWS or customer), the rule identifier, and the
* notifications that cause the function to evaluate your AWS resources.
*
*/
private Source source;
/**
*
* A string in JSON format that is passed to the AWS Config rule Lambda
* function.
*
*/
private String inputParameters;
/**
*
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
*
*
* If you want to create a rule that triggers evaluations for your resources
* when AWS Config delivers the configuration snapshot, see the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a configuration
* snapshot cannot run evaluations more frequently than AWS Config delivers
* the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater than the
* value of the deliveryFrequency key, which is part of
* ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
*
*/
private String maximumExecutionFrequency;
/**
*
* Indicates whether the AWS Config rule is active or is currently being
* deleted by AWS Config. It can also indicate the evaluation status for the
* Config rule.
*
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the StartConfigRulesEvaluation
* request to evaluate your resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING temporarily
* after you use the DeleteConfigRule request to delete the
* rule. After AWS Config deletes the rule, the rule and all of its
* evaluations are erased and are no longer available.
*
*/
private String configRuleState;
/**
*
* The name that you assign to the AWS Config rule. The name is required if
* you are adding a new rule.
*
*
* @param configRuleName
* The name that you assign to the AWS 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 AWS Config rule. The name is required if
* you are adding a new rule.
*
*
* @return The name that you assign to the AWS 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 AWS Config rule. The name is required if
* you are adding a new rule.
*
*
* @param configRuleName
* The name that you assign to the AWS 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 AWS Config rule.
*
*
* @param configRuleArn
* The Amazon Resource Name (ARN) of the AWS Config rule.
*/
public void setConfigRuleArn(String configRuleArn) {
this.configRuleArn = configRuleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the AWS Config rule.
*
*
* @return The Amazon Resource Name (ARN) of the AWS Config rule.
*/
public String getConfigRuleArn() {
return this.configRuleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the AWS Config rule.
*
*
* @param configRuleArn
* The Amazon Resource Name (ARN) of the AWS 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 AWS Config rule.
*
*
* @param configRuleId
* The ID of the AWS Config rule.
*/
public void setConfigRuleId(String configRuleId) {
this.configRuleId = configRuleId;
}
/**
*
* The ID of the AWS Config rule.
*
*
* @return The ID of the AWS Config rule.
*/
public String getConfigRuleId() {
return this.configRuleId;
}
/**
*
* The ID of the AWS Config rule.
*
*
* @param configRuleId
* The ID of the AWS 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 AWS Config rule.
*
*
* @param description
* The description that you provide for the AWS Config rule.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description that you provide for the AWS Config rule.
*
*
* @return The description that you provide for the AWS Config rule.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description that you provide for the AWS Config rule.
*
*
* @param description
* The description that you provide for the AWS 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.
*
*
* @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.
*/
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.
*
*
* @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.
*/
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.
*
*
* @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.
* @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 (AWS or customer), the rule identifier, and the
* notifications that cause the function to evaluate your AWS resources.
*
*
* @param source
* Provides the rule owner (AWS or customer), the rule identifier,
* and the notifications that cause the function to evaluate your AWS
* resources.
*/
public void setSource(Source source) {
this.source = source;
}
/**
*
* Provides the rule owner (AWS or customer), the rule identifier, and the
* notifications that cause the function to evaluate your AWS resources.
*
*
* @return Provides the rule owner (AWS or customer), the rule identifier,
* and the notifications that cause the function to evaluate your
* AWS resources.
*/
public Source getSource() {
return this.source;
}
/**
*
* Provides the rule owner (AWS or customer), the rule identifier, and the
* notifications that cause the function to evaluate your AWS resources.
*
*
* @param source
* Provides the rule owner (AWS or customer), the rule identifier,
* and the notifications that cause the function to evaluate your AWS
* 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 AWS Config rule Lambda
* function.
*
*
* @param inputParameters
* A string in JSON format that is passed to the AWS Config rule
* Lambda function.
*/
public void setInputParameters(String inputParameters) {
this.inputParameters = inputParameters;
}
/**
*
* A string in JSON format that is passed to the AWS Config rule Lambda
* function.
*
*
* @return A string in JSON format that is passed to the AWS Config rule
* Lambda function.
*/
public String getInputParameters() {
return this.inputParameters;
}
/**
*
* A string in JSON format that is passed to the AWS Config rule Lambda
* function.
*
*
* @param inputParameters
* A string in JSON format that is passed to the AWS 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;
}
/**
*
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
*
*
* If you want to create a rule that triggers evaluations for your resources
* when AWS Config delivers the configuration snapshot, see the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a configuration
* snapshot cannot run evaluations more frequently than AWS Config delivers
* the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater than the
* value of the deliveryFrequency key, which is part of
* ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
*
*
* @param maximumExecutionFrequency
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
* If you want to create a rule that triggers evaluations for your
* resources when AWS Config delivers the configuration snapshot, see
* the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a
* configuration snapshot cannot run evaluations more frequently than
* AWS Config delivers the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater
* than the value of the deliveryFrequency key, which is
* part of ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
* @see MaximumExecutionFrequency
*/
public void setMaximumExecutionFrequency(String maximumExecutionFrequency) {
this.maximumExecutionFrequency = maximumExecutionFrequency;
}
/**
*
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
*
*
* If you want to create a rule that triggers evaluations for your resources
* when AWS Config delivers the configuration snapshot, see the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a configuration
* snapshot cannot run evaluations more frequently than AWS Config delivers
* the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater than the
* value of the deliveryFrequency key, which is part of
* ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
*
*
* @return If you want to create a rule that evaluates at a frequency that
* is independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
* If you want to create a rule that triggers evaluations for your
* resources when AWS Config delivers the configuration snapshot,
* see the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a
* configuration snapshot cannot run evaluations more frequently
* than AWS Config delivers the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater
* than the value of the deliveryFrequency key, which
* is part of ConfigSnapshotDeliveryProperties.
*
*
* For more information, see
* ConfigSnapshotDeliveryProperties.
* @see MaximumExecutionFrequency
*/
public String getMaximumExecutionFrequency() {
return this.maximumExecutionFrequency;
}
/**
*
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
*
*
* If you want to create a rule that triggers evaluations for your resources
* when AWS Config delivers the configuration snapshot, see the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a configuration
* snapshot cannot run evaluations more frequently than AWS Config delivers
* the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater than the
* value of the deliveryFrequency key, which is part of
* ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
*
*
* @param maximumExecutionFrequency
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
* If you want to create a rule that triggers evaluations for your
* resources when AWS Config delivers the configuration snapshot, see
* the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a
* configuration snapshot cannot run evaluations more frequently than
* AWS Config delivers the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater
* than the value of the deliveryFrequency key, which is
* part of ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
* @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;
}
/**
*
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
*
*
* If you want to create a rule that triggers evaluations for your resources
* when AWS Config delivers the configuration snapshot, see the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a configuration
* snapshot cannot run evaluations more frequently than AWS Config delivers
* the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater than the
* value of the deliveryFrequency key, which is part of
* ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
*
*
* @param maximumExecutionFrequency
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
* If you want to create a rule that triggers evaluations for your
* resources when AWS Config delivers the configuration snapshot, see
* the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a
* configuration snapshot cannot run evaluations more frequently than
* AWS Config delivers the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater
* than the value of the deliveryFrequency key, which is
* part of ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
* @see MaximumExecutionFrequency
*/
public void setMaximumExecutionFrequency(
MaximumExecutionFrequency maximumExecutionFrequency) {
this.maximumExecutionFrequency = maximumExecutionFrequency.toString();
}
/**
*
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
*
*
* If you want to create a rule that triggers evaluations for your resources
* when AWS Config delivers the configuration snapshot, see the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a configuration
* snapshot cannot run evaluations more frequently than AWS Config delivers
* the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater than the
* value of the deliveryFrequency key, which is part of
* ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
*
*
* @param maximumExecutionFrequency
* If you want to create a rule that evaluates at a frequency that is
* independent of the configuration snapshot delivery, use the
* MaximumExecutionFrequency parameter in the
* SourceDetail object.
*
* If you want to create a rule that triggers evaluations for your
* resources when AWS Config delivers the configuration snapshot, see
* the following:
*
*
*
* A rule that runs an evaluation when AWS Config delivers a
* configuration snapshot cannot run evaluations more frequently than
* AWS Config delivers the snapshots. Set the value of the
* MaximumExecutionFrequency to be equal to or greater
* than the value of the deliveryFrequency key, which is
* part of ConfigSnapshotDeliveryProperties.
*
*
* For more information, see ConfigSnapshotDeliveryProperties.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see MaximumExecutionFrequency
*/
public ConfigRule withMaximumExecutionFrequency(
MaximumExecutionFrequency maximumExecutionFrequency) {
setMaximumExecutionFrequency(maximumExecutionFrequency);
return this;
}
/**
*
* Indicates whether the AWS Config rule is active or is currently being
* deleted by AWS Config. It can also indicate the evaluation status for the
* Config rule.
*
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the StartConfigRulesEvaluation
* request to evaluate your resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING temporarily
* after you use the DeleteConfigRule request to delete the
* rule. After AWS Config deletes the rule, the rule and all of its
* evaluations are erased and are no longer available.
*
*
* @param configRuleState
* Indicates whether the AWS Config rule is active or is currently
* being deleted by AWS Config. It can also indicate the evaluation
* status for the Config rule.
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the
* StartConfigRulesEvaluation request to evaluate your
* resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING
* temporarily after you use the DeleteConfigRule
* request to delete the rule. After AWS 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 AWS Config rule is active or is currently being
* deleted by AWS Config. It can also indicate the evaluation status for the
* Config rule.
*
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the StartConfigRulesEvaluation
* request to evaluate your resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING temporarily
* after you use the DeleteConfigRule request to delete the
* rule. After AWS Config deletes the rule, the rule and all of its
* evaluations are erased and are no longer available.
*
*
* @return Indicates whether the AWS Config rule is active or is currently
* being deleted by AWS Config. It can also indicate the evaluation
* status for the Config rule.
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the
* StartConfigRulesEvaluation request to evaluate your
* resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING
* temporarily after you use the DeleteConfigRule
* request to delete the rule. After AWS 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 AWS Config rule is active or is currently being
* deleted by AWS Config. It can also indicate the evaluation status for the
* Config rule.
*
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the StartConfigRulesEvaluation
* request to evaluate your resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING temporarily
* after you use the DeleteConfigRule request to delete the
* rule. After AWS Config deletes the rule, the rule and all of its
* evaluations are erased and are no longer available.
*
*
* @param configRuleState
* Indicates whether the AWS Config rule is active or is currently
* being deleted by AWS Config. It can also indicate the evaluation
* status for the Config rule.
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the
* StartConfigRulesEvaluation request to evaluate your
* resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING
* temporarily after you use the DeleteConfigRule
* request to delete the rule. After AWS 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 AWS Config rule is active or is currently being
* deleted by AWS Config. It can also indicate the evaluation status for the
* Config rule.
*
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the StartConfigRulesEvaluation
* request to evaluate your resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING temporarily
* after you use the DeleteConfigRule request to delete the
* rule. After AWS Config deletes the rule, the rule and all of its
* evaluations are erased and are no longer available.
*
*
* @param configRuleState
* Indicates whether the AWS Config rule is active or is currently
* being deleted by AWS Config. It can also indicate the evaluation
* status for the Config rule.
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the
* StartConfigRulesEvaluation request to evaluate your
* resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING
* temporarily after you use the DeleteConfigRule
* request to delete the rule. After AWS 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) {
this.configRuleState = configRuleState.toString();
}
/**
*
* Indicates whether the AWS Config rule is active or is currently being
* deleted by AWS Config. It can also indicate the evaluation status for the
* Config rule.
*
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the StartConfigRulesEvaluation
* request to evaluate your resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING temporarily
* after you use the DeleteConfigRule request to delete the
* rule. After AWS Config deletes the rule, the rule and all of its
* evaluations are erased and are no longer available.
*
*
* @param configRuleState
* Indicates whether the AWS Config rule is active or is currently
* being deleted by AWS Config. It can also indicate the evaluation
* status for the Config rule.
*
* AWS Config sets the state of the rule to EVALUATING
* temporarily after you use the
* StartConfigRulesEvaluation request to evaluate your
* resources against the Config rule.
*
*
* AWS 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.
*
*
* AWS Config sets the state of a rule to DELETING
* temporarily after you use the DeleteConfigRule
* request to delete the rule. After AWS 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) {
setConfigRuleState(configRuleState);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getConfigRuleName() + ",");
if (getConfigRuleArn() != null)
sb.append("ConfigRuleArn: " + getConfigRuleArn() + ",");
if (getConfigRuleId() != null)
sb.append("ConfigRuleId: " + getConfigRuleId() + ",");
if (getDescription() != null)
sb.append("Description: " + getDescription() + ",");
if (getScope() != null)
sb.append("Scope: " + getScope() + ",");
if (getSource() != null)
sb.append("Source: " + getSource() + ",");
if (getInputParameters() != null)
sb.append("InputParameters: " + getInputParameters() + ",");
if (getMaximumExecutionFrequency() != null)
sb.append("MaximumExecutionFrequency: "
+ getMaximumExecutionFrequency() + ",");
if (getConfigRuleState() != null)
sb.append("ConfigRuleState: " + getConfigRuleState());
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;
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());
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);
}
}
}