com.amazonaws.services.wafv2.model.Rule Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2015-2020 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.wafv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
*
* This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including
* how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
*
*
*
* A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to
* allow, block, or count. Each rule includes one top-level Statement that AWS WAF uses to identify matching web
* requests, and parameters that govern how AWS WAF handles them.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Rule implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the rule. You can't change the name of a Rule after you create it.
*
*/
private String name;
/**
*
* If you define more than one Rule in a WebACL, AWS WAF evaluates each request against
* the Rules in order based on the value of Priority. AWS WAF processes rules with lower
* priority first. The priorities don't need to be consecutive, but they must all be different.
*
*/
private Integer priority;
/**
*
* The AWS WAF processing statement for the rule, for example ByteMatchStatement or
* SizeConstraintStatement.
*
*/
private Statement statement;
/**
*
* The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL
* level can override the rule action setting.
*
*
* This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule
* group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* You must specify either this Action setting or the rule OverrideAction setting, but not
* both:
*
*
* -
*
* If the rule statement does not reference a rule group, use this rule action setting and not the rule override
* action setting.
*
*
* -
*
* If the rule statement references a rule group, use the override action setting and not this action setting.
*
*
*
*/
private RuleAction action;
/**
*
* The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule
* group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* Set the override action to none to leave the rule actions in effect. Set it to count to only count matches,
* regardless of the rule action settings.
*
*
* In a Rule, you must specify either this OverrideAction setting or the rule
* Action setting, but not both:
*
*
* -
*
* If the rule statement references a rule group, use this override action setting and not the action setting.
*
*
* -
*
* If the rule statement does not reference a rule group, use the rule action setting and not this rule override
* action setting.
*
*
*
*/
private OverrideAction overrideAction;
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*/
private VisibilityConfig visibilityConfig;
/**
*
* The name of the rule. You can't change the name of a Rule after you create it.
*
*
* @param name
* The name of the rule. You can't change the name of a Rule after you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the rule. You can't change the name of a Rule after you create it.
*
*
* @return The name of the rule. You can't change the name of a Rule after you create it.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the rule. You can't change the name of a Rule after you create it.
*
*
* @param name
* The name of the rule. You can't change the name of a Rule after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withName(String name) {
setName(name);
return this;
}
/**
*
* If you define more than one Rule in a WebACL, AWS WAF evaluates each request against
* the Rules in order based on the value of Priority. AWS WAF processes rules with lower
* priority first. The priorities don't need to be consecutive, but they must all be different.
*
*
* @param priority
* If you define more than one Rule in a WebACL, AWS WAF evaluates each request
* against the Rules in order based on the value of Priority. AWS WAF processes
* rules with lower priority first. The priorities don't need to be consecutive, but they must all be
* different.
*/
public void setPriority(Integer priority) {
this.priority = priority;
}
/**
*
* If you define more than one Rule in a WebACL, AWS WAF evaluates each request against
* the Rules in order based on the value of Priority. AWS WAF processes rules with lower
* priority first. The priorities don't need to be consecutive, but they must all be different.
*
*
* @return If you define more than one Rule in a WebACL, AWS WAF evaluates each request
* against the Rules in order based on the value of Priority. AWS WAF processes
* rules with lower priority first. The priorities don't need to be consecutive, but they must all be
* different.
*/
public Integer getPriority() {
return this.priority;
}
/**
*
* If you define more than one Rule in a WebACL, AWS WAF evaluates each request against
* the Rules in order based on the value of Priority. AWS WAF processes rules with lower
* priority first. The priorities don't need to be consecutive, but they must all be different.
*
*
* @param priority
* If you define more than one Rule in a WebACL, AWS WAF evaluates each request
* against the Rules in order based on the value of Priority. AWS WAF processes
* rules with lower priority first. The priorities don't need to be consecutive, but they must all be
* different.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withPriority(Integer priority) {
setPriority(priority);
return this;
}
/**
*
* The AWS WAF processing statement for the rule, for example ByteMatchStatement or
* SizeConstraintStatement.
*
*
* @param statement
* The AWS WAF processing statement for the rule, for example ByteMatchStatement or
* SizeConstraintStatement.
*/
public void setStatement(Statement statement) {
this.statement = statement;
}
/**
*
* The AWS WAF processing statement for the rule, for example ByteMatchStatement or
* SizeConstraintStatement.
*
*
* @return The AWS WAF processing statement for the rule, for example ByteMatchStatement or
* SizeConstraintStatement.
*/
public Statement getStatement() {
return this.statement;
}
/**
*
* The AWS WAF processing statement for the rule, for example ByteMatchStatement or
* SizeConstraintStatement.
*
*
* @param statement
* The AWS WAF processing statement for the rule, for example ByteMatchStatement or
* SizeConstraintStatement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withStatement(Statement statement) {
setStatement(statement);
return this;
}
/**
*
* The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL
* level can override the rule action setting.
*
*
* This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule
* group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* You must specify either this Action setting or the rule OverrideAction setting, but not
* both:
*
*
* -
*
* If the rule statement does not reference a rule group, use this rule action setting and not the rule override
* action setting.
*
*
* -
*
* If the rule statement references a rule group, use the override action setting and not this action setting.
*
*
*
*
* @param action
* The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the
* web ACL level can override the rule action setting.
*
* This is used only for rules whose statements do not reference a rule group. Rule statements that reference
* a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* You must specify either this Action setting or the rule OverrideAction setting,
* but not both:
*
*
* -
*
* If the rule statement does not reference a rule group, use this rule action setting and not the rule
* override action setting.
*
*
* -
*
* If the rule statement references a rule group, use the override action setting and not this action
* setting.
*
*
*/
public void setAction(RuleAction action) {
this.action = action;
}
/**
*
* The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL
* level can override the rule action setting.
*
*
* This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule
* group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* You must specify either this Action setting or the rule OverrideAction setting, but not
* both:
*
*
* -
*
* If the rule statement does not reference a rule group, use this rule action setting and not the rule override
* action setting.
*
*
* -
*
* If the rule statement references a rule group, use the override action setting and not this action setting.
*
*
*
*
* @return The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the
* web ACL level can override the rule action setting.
*
* This is used only for rules whose statements do not reference a rule group. Rule statements that
* reference a rule group include RuleGroupReferenceStatement and
* ManagedRuleGroupStatement.
*
*
* You must specify either this Action setting or the rule OverrideAction setting,
* but not both:
*
*
* -
*
* If the rule statement does not reference a rule group, use this rule action setting and not the rule
* override action setting.
*
*
* -
*
* If the rule statement references a rule group, use the override action setting and not this action
* setting.
*
*
*/
public RuleAction getAction() {
return this.action;
}
/**
*
* The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL
* level can override the rule action setting.
*
*
* This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule
* group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* You must specify either this Action setting or the rule OverrideAction setting, but not
* both:
*
*
* -
*
* If the rule statement does not reference a rule group, use this rule action setting and not the rule override
* action setting.
*
*
* -
*
* If the rule statement references a rule group, use the override action setting and not this action setting.
*
*
*
*
* @param action
* The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the
* web ACL level can override the rule action setting.
*
* This is used only for rules whose statements do not reference a rule group. Rule statements that reference
* a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* You must specify either this Action setting or the rule OverrideAction setting,
* but not both:
*
*
* -
*
* If the rule statement does not reference a rule group, use this rule action setting and not the rule
* override action setting.
*
*
* -
*
* If the rule statement references a rule group, use the override action setting and not this action
* setting.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withAction(RuleAction action) {
setAction(action);
return this;
}
/**
*
* The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule
* group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* Set the override action to none to leave the rule actions in effect. Set it to count to only count matches,
* regardless of the rule action settings.
*
*
* In a Rule, you must specify either this OverrideAction setting or the rule
* Action setting, but not both:
*
*
* -
*
* If the rule statement references a rule group, use this override action setting and not the action setting.
*
*
* -
*
* If the rule statement does not reference a rule group, use the rule action setting and not this rule override
* action setting.
*
*
*
*
* @param overrideAction
* The override action to apply to the rules in a rule group. Used only for rule statements that reference a
* rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
* Set the override action to none to leave the rule actions in effect. Set it to count to only count
* matches, regardless of the rule action settings.
*
*
* In a Rule, you must specify either this OverrideAction setting or the rule
* Action setting, but not both:
*
*
* -
*
* If the rule statement references a rule group, use this override action setting and not the action
* setting.
*
*
* -
*
* If the rule statement does not reference a rule group, use the rule action setting and not this rule
* override action setting.
*
*
*/
public void setOverrideAction(OverrideAction overrideAction) {
this.overrideAction = overrideAction;
}
/**
*
* The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule
* group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* Set the override action to none to leave the rule actions in effect. Set it to count to only count matches,
* regardless of the rule action settings.
*
*
* In a Rule, you must specify either this OverrideAction setting or the rule
* Action setting, but not both:
*
*
* -
*
* If the rule statement references a rule group, use this override action setting and not the action setting.
*
*
* -
*
* If the rule statement does not reference a rule group, use the rule action setting and not this rule override
* action setting.
*
*
*
*
* @return The override action to apply to the rules in a rule group. Used only for rule statements that reference a
* rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* Set the override action to none to leave the rule actions in effect. Set it to count to only count
* matches, regardless of the rule action settings.
*
*
* In a Rule, you must specify either this OverrideAction setting or the rule
* Action setting, but not both:
*
*
* -
*
* If the rule statement references a rule group, use this override action setting and not the action
* setting.
*
*
* -
*
* If the rule statement does not reference a rule group, use the rule action setting and not this rule
* override action setting.
*
*
*/
public OverrideAction getOverrideAction() {
return this.overrideAction;
}
/**
*
* The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule
* group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
*
* Set the override action to none to leave the rule actions in effect. Set it to count to only count matches,
* regardless of the rule action settings.
*
*
* In a Rule, you must specify either this OverrideAction setting or the rule
* Action setting, but not both:
*
*
* -
*
* If the rule statement references a rule group, use this override action setting and not the action setting.
*
*
* -
*
* If the rule statement does not reference a rule group, use the rule action setting and not this rule override
* action setting.
*
*
*
*
* @param overrideAction
* The override action to apply to the rules in a rule group. Used only for rule statements that reference a
* rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
*
* Set the override action to none to leave the rule actions in effect. Set it to count to only count
* matches, regardless of the rule action settings.
*
*
* In a Rule, you must specify either this OverrideAction setting or the rule
* Action setting, but not both:
*
*
* -
*
* If the rule statement references a rule group, use this override action setting and not the action
* setting.
*
*
* -
*
* If the rule statement does not reference a rule group, use the rule action setting and not this rule
* override action setting.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withOverrideAction(OverrideAction overrideAction) {
setOverrideAction(overrideAction);
return this;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public void setVisibilityConfig(VisibilityConfig visibilityConfig) {
this.visibilityConfig = visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @return Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public VisibilityConfig getVisibilityConfig() {
return this.visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withVisibilityConfig(VisibilityConfig visibilityConfig) {
setVisibilityConfig(visibilityConfig);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getPriority() != null)
sb.append("Priority: ").append(getPriority()).append(",");
if (getStatement() != null)
sb.append("Statement: ").append(getStatement()).append(",");
if (getAction() != null)
sb.append("Action: ").append(getAction()).append(",");
if (getOverrideAction() != null)
sb.append("OverrideAction: ").append(getOverrideAction()).append(",");
if (getVisibilityConfig() != null)
sb.append("VisibilityConfig: ").append(getVisibilityConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Rule == false)
return false;
Rule other = (Rule) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getPriority() == null ^ this.getPriority() == null)
return false;
if (other.getPriority() != null && other.getPriority().equals(this.getPriority()) == false)
return false;
if (other.getStatement() == null ^ this.getStatement() == null)
return false;
if (other.getStatement() != null && other.getStatement().equals(this.getStatement()) == false)
return false;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == false)
return false;
if (other.getOverrideAction() == null ^ this.getOverrideAction() == null)
return false;
if (other.getOverrideAction() != null && other.getOverrideAction().equals(this.getOverrideAction()) == false)
return false;
if (other.getVisibilityConfig() == null ^ this.getVisibilityConfig() == null)
return false;
if (other.getVisibilityConfig() != null && other.getVisibilityConfig().equals(this.getVisibilityConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getPriority() == null) ? 0 : getPriority().hashCode());
hashCode = prime * hashCode + ((getStatement() == null) ? 0 : getStatement().hashCode());
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
hashCode = prime * hashCode + ((getOverrideAction() == null) ? 0 : getOverrideAction().hashCode());
hashCode = prime * hashCode + ((getVisibilityConfig() == null) ? 0 : getVisibilityConfig().hashCode());
return hashCode;
}
@Override
public Rule clone() {
try {
return (Rule) 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.wafv2.model.transform.RuleMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}