/*
* 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.securityhub.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateAutomationRule" target="_top">AWS
* API Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateAutomationRuleRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* <p>
* User-defined tags that help you label the purpose of a rule.
* </p>
*/
private java.util.Map<String, String> tags;
/**
* <p>
* Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use <a
* href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html">
* <code>BatchUpdateAutomationRules</code> </a>.
* </p>
*/
private String ruleStatus;
/**
* <p>
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
* Security Hub applies rules with lower values for this parameter first.
* </p>
*/
private Integer ruleOrder;
/**
* <p>
* The name of the rule.
* </p>
*/
private String ruleName;
/**
* <p>
* A description of the rule.
* </p>
*/
private String description;
/**
* <p>
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
* </p>
*/
private Boolean isTerminal;
/**
* <p>
* A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter
* findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub
* applies the rule action to the finding.
* </p>
*/
private AutomationRulesFindingFilters criteria;
/**
* <p>
* One or more actions to update finding fields if a finding matches the conditions specified in
* <code>Criteria</code>.
* </p>
*/
private java.util.List<AutomationRulesAction> actions;
/**
* <p>
* User-defined tags that help you label the purpose of a rule.
* </p>
*
* @return User-defined tags that help you label the purpose of a rule.
*/
public java.util.Map<String, String> getTags() {
return tags;
}
/**
* <p>
* User-defined tags that help you label the purpose of a rule.
* </p>
*
* @param tags
* User-defined tags that help you label the purpose of a rule.
*/
public void setTags(java.util.Map<String, String> tags) {
this.tags = tags;
}
/**
* <p>
* User-defined tags that help you label the purpose of a rule.
* </p>
*
* @param tags
* User-defined tags that help you label the purpose of a rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest withTags(java.util.Map<String, String> tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateAutomationRuleRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap<String, String>();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest clearTagsEntries() {
this.tags = null;
return this;
}
/**
* <p>
* Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use <a
* href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html">
* <code>BatchUpdateAutomationRules</code> </a>.
* </p>
*
* @param ruleStatus
* Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>,
* Security Hub starts applying the rule to findings and finding updates after the rule is created. To change
* the value of this parameter after creating a rule, use <a
* href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html">
* <code>BatchUpdateAutomationRules</code> </a>.
* @see RuleStatus
*/
public void setRuleStatus(String ruleStatus) {
this.ruleStatus = ruleStatus;
}
/**
* <p>
* Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use <a
* href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html">
* <code>BatchUpdateAutomationRules</code> </a>.
* </p>
*
* @return Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>,
* Security Hub starts applying the rule to findings and finding updates after the rule is created. To
* change the value of this parameter after creating a rule, use <a
* href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html">
* <code>BatchUpdateAutomationRules</code> </a>.
* @see RuleStatus
*/
public String getRuleStatus() {
return this.ruleStatus;
}
/**
* <p>
* Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use <a
* href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html">
* <code>BatchUpdateAutomationRules</code> </a>.
* </p>
*
* @param ruleStatus
* Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>,
* Security Hub starts applying the rule to findings and finding updates after the rule is created. To change
* the value of this parameter after creating a rule, use <a
* href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html">
* <code>BatchUpdateAutomationRules</code> </a>.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleStatus
*/
public CreateAutomationRuleRequest withRuleStatus(String ruleStatus) {
setRuleStatus(ruleStatus);
return this;
}
/**
* <p>
* Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use <a
* href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html">
* <code>BatchUpdateAutomationRules</code> </a>.
* </p>
*
* @param ruleStatus
* Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>,
* Security Hub starts applying the rule to findings and finding updates after the rule is created. To change
* the value of this parameter after creating a rule, use <a
* href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html">
* <code>BatchUpdateAutomationRules</code> </a>.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleStatus
*/
public CreateAutomationRuleRequest withRuleStatus(RuleStatus ruleStatus) {
this.ruleStatus = ruleStatus.toString();
return this;
}
/**
* <p>
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
* Security Hub applies rules with lower values for this parameter first.
* </p>
*
* @param ruleOrder
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to
* findings. Security Hub applies rules with lower values for this parameter first.
*/
public void setRuleOrder(Integer ruleOrder) {
this.ruleOrder = ruleOrder;
}
/**
* <p>
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
* Security Hub applies rules with lower values for this parameter first.
* </p>
*
* @return An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to
* findings. Security Hub applies rules with lower values for this parameter first.
*/
public Integer getRuleOrder() {
return this.ruleOrder;
}
/**
* <p>
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
* Security Hub applies rules with lower values for this parameter first.
* </p>
*
* @param ruleOrder
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to
* findings. Security Hub applies rules with lower values for this parameter first.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest withRuleOrder(Integer ruleOrder) {
setRuleOrder(ruleOrder);
return this;
}
/**
* <p>
* The name of the rule.
* </p>
*
* @param ruleName
* The name of the rule.
*/
public void setRuleName(String ruleName) {
this.ruleName = ruleName;
}
/**
* <p>
* The name of the rule.
* </p>
*
* @return The name of the rule.
*/
public String getRuleName() {
return this.ruleName;
}
/**
* <p>
* The name of the rule.
* </p>
*
* @param ruleName
* The name of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest withRuleName(String ruleName) {
setRuleName(ruleName);
return this;
}
/**
* <p>
* A description of the rule.
* </p>
*
* @param description
* A description of the rule.
*/
public void setDescription(String description) {
this.description = description;
}
/**
* <p>
* A description of the rule.
* </p>
*
* @return A description of the rule.
*/
public String getDescription() {
return this.description;
}
/**
* <p>
* A description of the rule.
* </p>
*
* @param description
* A description of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
* <p>
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
* </p>
*
* @param isTerminal
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule
* criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has
* different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
*/
public void setIsTerminal(Boolean isTerminal) {
this.isTerminal = isTerminal;
}
/**
* <p>
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
* </p>
*
* @return Specifies whether a rule is the last to be applied with respect to a finding that matches the rule
* criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has
* different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
*/
public Boolean getIsTerminal() {
return this.isTerminal;
}
/**
* <p>
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
* </p>
*
* @param isTerminal
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule
* criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has
* different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest withIsTerminal(Boolean isTerminal) {
setIsTerminal(isTerminal);
return this;
}
/**
* <p>
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
* </p>
*
* @return Specifies whether a rule is the last to be applied with respect to a finding that matches the rule
* criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has
* different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
*/
public Boolean isTerminal() {
return this.isTerminal;
}
/**
* <p>
* A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter
* findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub
* applies the rule action to the finding.
* </p>
*
* @param criteria
* A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter
* findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security
* Hub applies the rule action to the finding.
*/
public void setCriteria(AutomationRulesFindingFilters criteria) {
this.criteria = criteria;
}
/**
* <p>
* A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter
* findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub
* applies the rule action to the finding.
* </p>
*
* @return A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter
* findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security
* Hub applies the rule action to the finding.
*/
public AutomationRulesFindingFilters getCriteria() {
return this.criteria;
}
/**
* <p>
* A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter
* findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub
* applies the rule action to the finding.
* </p>
*
* @param criteria
* A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter
* findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security
* Hub applies the rule action to the finding.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest withCriteria(AutomationRulesFindingFilters criteria) {
setCriteria(criteria);
return this;
}
/**
* <p>
* One or more actions to update finding fields if a finding matches the conditions specified in
* <code>Criteria</code>.
* </p>
*
* @return One or more actions to update finding fields if a finding matches the conditions specified in
* <code>Criteria</code>.
*/
public java.util.List<AutomationRulesAction> getActions() {
return actions;
}
/**
* <p>
* One or more actions to update finding fields if a finding matches the conditions specified in
* <code>Criteria</code>.
* </p>
*
* @param actions
* One or more actions to update finding fields if a finding matches the conditions specified in
* <code>Criteria</code>.
*/
public void setActions(java.util.Collection<AutomationRulesAction> actions) {
if (actions == null) {
this.actions = null;
return;
}
this.actions = new java.util.ArrayList<AutomationRulesAction>(actions);
}
/**
* <p>
* One or more actions to update finding fields if a finding matches the conditions specified in
* <code>Criteria</code>.
* </p>
* <p>
* <b>NOTE:</b> This method appends the values to the existing list (if any). Use
* {@link #setActions(java.util.Collection)} or {@link #withActions(java.util.Collection)} if you want to override
* the existing values.
* </p>
*
* @param actions
* One or more actions to update finding fields if a finding matches the conditions specified in
* <code>Criteria</code>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest withActions(AutomationRulesAction... actions) {
if (this.actions == null) {
setActions(new java.util.ArrayList<AutomationRulesAction>(actions.length));
}
for (AutomationRulesAction ele : actions) {
this.actions.add(ele);
}
return this;
}
/**
* <p>
* One or more actions to update finding fields if a finding matches the conditions specified in
* <code>Criteria</code>.
* </p>
*
* @param actions
* One or more actions to update finding fields if a finding matches the conditions specified in
* <code>Criteria</code>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAutomationRuleRequest withActions(java.util.Collection<AutomationRulesAction> actions) {
setActions(actions);
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 (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getRuleStatus() != null)
sb.append("RuleStatus: ").append(getRuleStatus()).append(",");
if (getRuleOrder() != null)
sb.append("RuleOrder: ").append(getRuleOrder()).append(",");
if (getRuleName() != null)
sb.append("RuleName: ").append(getRuleName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getIsTerminal() != null)
sb.append("IsTerminal: ").append(getIsTerminal()).append(",");
if (getCriteria() != null)
sb.append("Criteria: ").append(getCriteria()).append(",");
if (getActions() != null)
sb.append("Actions: ").append(getActions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateAutomationRuleRequest == false)
return false;
CreateAutomationRuleRequest other = (CreateAutomationRuleRequest) obj;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getRuleStatus() == null ^ this.getRuleStatus() == null)
return false;
if (other.getRuleStatus() != null && other.getRuleStatus().equals(this.getRuleStatus()) == false)
return false;
if (other.getRuleOrder() == null ^ this.getRuleOrder() == null)
return false;
if (other.getRuleOrder() != null && other.getRuleOrder().equals(this.getRuleOrder()) == false)
return false;
if (other.getRuleName() == null ^ this.getRuleName() == null)
return false;
if (other.getRuleName() != null && other.getRuleName().equals(this.getRuleName()) == 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.getIsTerminal() == null ^ this.getIsTerminal() == null)
return false;
if (other.getIsTerminal() != null && other.getIsTerminal().equals(this.getIsTerminal()) == false)
return false;
if (other.getCriteria() == null ^ this.getCriteria() == null)
return false;
if (other.getCriteria() != null && other.getCriteria().equals(this.getCriteria()) == false)
return false;
if (other.getActions() == null ^ this.getActions() == null)
return false;
if (other.getActions() != null && other.getActions().equals(this.getActions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getRuleStatus() == null) ? 0 : getRuleStatus().hashCode());
hashCode = prime * hashCode + ((getRuleOrder() == null) ? 0 : getRuleOrder().hashCode());
hashCode = prime * hashCode + ((getRuleName() == null) ? 0 : getRuleName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getIsTerminal() == null) ? 0 : getIsTerminal().hashCode());
hashCode = prime * hashCode + ((getCriteria() == null) ? 0 : getCriteria().hashCode());
hashCode = prime * hashCode + ((getActions() == null) ? 0 : getActions().hashCode());
return hashCode;
}
@Override
public CreateAutomationRuleRequest clone() {
return (CreateAutomationRuleRequest) super.clone();
}
}