Rule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.Rule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Rule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rule`	`clone()`
`boolean`	`equals(Object obj)`
`RuleAction`	`getAction()` The action that WAF should take on a web request when it matches the rule statement.
`CaptchaConfig`	`getCaptchaConfig()` Specifies how WAF should handle `CAPTCHA` evaluations.
`String`	`getName()` The name of the rule.
`OverrideAction`	`getOverrideAction()` The action to use in the place of the action that results from the rule group evaluation.
`Integer`	`getPriority()` If you define more than one `Rule` in a `WebACL`, WAF evaluates each request against the `Rules` in order based on the value of `Priority`.
`List<Label>`	`getRuleLabels()` Labels to apply to web requests that match the rule match statement.
`Statement`	`getStatement()` The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
`VisibilityConfig`	`getVisibilityConfig()` Defines and enables Amazon CloudWatch metrics and web request sample collection.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(RuleAction action)` The action that WAF should take on a web request when it matches the rule statement.
`void`	`setCaptchaConfig(CaptchaConfig captchaConfig)` Specifies how WAF should handle `CAPTCHA` evaluations.
`void`	`setName(String name)` The name of the rule.
`void`	`setOverrideAction(OverrideAction overrideAction)` The action to use in the place of the action that results from the rule group evaluation.
`void`	`setPriority(Integer priority)` If you define more than one `Rule` in a `WebACL`, WAF evaluates each request against the `Rules` in order based on the value of `Priority`.
`void`	`setRuleLabels(Collection<Label> ruleLabels)` Labels to apply to web requests that match the rule match statement.
`void`	`setStatement(Statement statement)` The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
`void`	`setVisibilityConfig(VisibilityConfig visibilityConfig)` Defines and enables Amazon CloudWatch metrics and web request sample collection.
`String`	`toString()` Returns a string representation of this object.
`Rule`	`withAction(RuleAction action)` The action that WAF should take on a web request when it matches the rule statement.
`Rule`	`withCaptchaConfig(CaptchaConfig captchaConfig)` Specifies how WAF should handle `CAPTCHA` evaluations.
`Rule`	`withName(String name)` The name of the rule.
`Rule`	`withOverrideAction(OverrideAction overrideAction)` The action to use in the place of the action that results from the rule group evaluation.
`Rule`	`withPriority(Integer priority)` If you define more than one `Rule` in a `WebACL`, WAF evaluates each request against the `Rules` in order based on the value of `Priority`.
`Rule`	`withRuleLabels(Collection<Label> ruleLabels)` Labels to apply to web requests that match the rule match statement.
`Rule`	`withRuleLabels(Label... ruleLabels)` Labels to apply to web requests that match the rule match statement.
`Rule`	`withStatement(Statement statement)` The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
`Rule`	`withVisibilityConfig(VisibilityConfig visibilityConfig)` Defines and enables Amazon CloudWatch metrics and web request sample collection.

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

- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the rule. You can't change the name of a Rule after you create it.
    
    Parameters:
    
    name - The name of the rule. You can't change the name of a Rule after you create it.
  - getName
```
public String getName()
```
    The name of the rule. You can't change the name of a Rule after you create it.
    
    Returns:
    
    The name of the rule. You can't change the name of a Rule after you create it.
  - withName
```
public Rule withName(String name)
```
    The name of the rule. You can't change the name of a Rule after you create it.
    
    Parameters:
    
    name - The name of the rule. You can't change the name of a Rule after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
    
    Parameters:
    
    priority - If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
  - getPriority
```
public Integer getPriority()
```
    If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
    
    Returns:
    
    If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
  - withPriority
```
public Rule withPriority(Integer priority)
```
    If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
    
    Parameters:
    
    priority - If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatement
```
public void setStatement(Statement statement)
```
    The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
    
    Parameters:
    
    statement - The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
  - getStatement
```
public Statement getStatement()
```
    The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
    
    Returns:
    
    The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
  - withStatement
```
public Rule withStatement(Statement statement)
```
    The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
    
    Parameters:
    
    statement - The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAction
```
public void setAction(RuleAction action)
```
    The action that 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.
    Parameters:
    action - The action that 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.
  - getAction
```
public RuleAction getAction()
```
    The action that 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.
    Returns:
    The action that 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.
  - withAction
```
public Rule withAction(RuleAction action)
```
    The action that 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.
    Parameters:
    action - The action that 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOverrideAction
```
public void setOverrideAction(OverrideAction overrideAction)
```
    The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
    
    You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
    
    This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
    
    Parameters:
    
    overrideAction - The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
    
    You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
    
    This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
  - getOverrideAction
```
public OverrideAction getOverrideAction()
```
    The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
    
    You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
    
    This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
    
    Returns:
    
    The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
    
    You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
    
    This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
  - withOverrideAction
```
public Rule withOverrideAction(OverrideAction overrideAction)
```
    The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
    
    You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
    
    This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
    
    Parameters:
    
    overrideAction - The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
    
    You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
    
    This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRuleLabels
```
public List<Label> getRuleLabels()
```
    Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
    
    For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
    - Separate each component of the label with a colon.
    - Each namespace or name can have up to 128 characters.
    - You can specify up to 5 namespaces in a label.
    - Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
    For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
    Returns:
    Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
    
    For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
    
    Separate each component of the label with a colon.
    
    Each namespace or name can have up to 128 characters.
    
    You can specify up to 5 namespaces in a label.
    
    Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
    
    For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
  - setRuleLabels
```
public void setRuleLabels(Collection<Label> ruleLabels)
```
    Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
    
    For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
    - Separate each component of the label with a colon.
    - Each namespace or name can have up to 128 characters.
    - You can specify up to 5 namespaces in a label.
    - Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
    For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
    Parameters:
    ruleLabels - Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
    
    For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
    
    Separate each component of the label with a colon.
    
    Each namespace or name can have up to 128 characters.
    
    You can specify up to 5 namespaces in a label.
    
    Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
    
    For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
  - withRuleLabels
```
public Rule withRuleLabels(Label... ruleLabels)
```
    Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
    
    For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
    - Separate each component of the label with a colon.
    - Each namespace or name can have up to 128 characters.
    - You can specify up to 5 namespaces in a label.
    - Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
    For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
    
    NOTE: This method appends the values to the existing list (if any). Use setRuleLabels(java.util.Collection) or withRuleLabels(java.util.Collection) if you want to override the existing values.
    Parameters:
    ruleLabels - Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
    
    For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
    
    Separate each component of the label with a colon.
    
    Each namespace or name can have up to 128 characters.
    
    You can specify up to 5 namespaces in a label.
    
    Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
    
    For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRuleLabels
```
public Rule withRuleLabels(Collection<Label> ruleLabels)
```
    Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
    
    For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
    - Separate each component of the label with a colon.
    - Each namespace or name can have up to 128 characters.
    - You can specify up to 5 namespaces in a label.
    - Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
    For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
    Parameters:
    ruleLabels - Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
    
    For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
    
    Separate each component of the label with a colon.
    
    Each namespace or name can have up to 128 characters.
    
    You can specify up to 5 namespaces in a label.
    
    Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
    
    For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVisibilityConfig
```
public void setVisibilityConfig(VisibilityConfig visibilityConfig)
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Parameters:
    
    visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.
  - getVisibilityConfig
```
public VisibilityConfig getVisibilityConfig()
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Returns:
    
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
  - withVisibilityConfig
```
public Rule withVisibilityConfig(VisibilityConfig visibilityConfig)
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Parameters:
    
    visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCaptchaConfig
```
public void setCaptchaConfig(CaptchaConfig captchaConfig)
```
    Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.
    
    Parameters:
    
    captchaConfig - Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.
  - getCaptchaConfig
```
public CaptchaConfig getCaptchaConfig()
```
    Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.
    
    Returns:
    
    Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.
  - withCaptchaConfig
```
public Rule withCaptchaConfig(CaptchaConfig captchaConfig)
```
    Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.
    
    Parameters:
    
    captchaConfig - Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Rule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Method Detail

setName

getName

withName

setPriority

getPriority

withPriority

setStatement

getStatement

withStatement

setAction

getAction

withAction

setOverrideAction

getOverrideAction

withOverrideAction

getRuleLabels

setRuleLabels

withRuleLabels

withRuleLabels

setVisibilityConfig

getVisibilityConfig

withVisibilityConfig

setCaptchaConfig

getCaptchaConfig

withCaptchaConfig

toString

equals

hashCode

clone

marshall