Class ActivatedRule

java.lang.Object
com.amazonaws.services.waf.model.ActivatedRule
All Implemented Interfaces:
Serializable, Cloneable
public class ActivatedRule extends Object implements Serializable, Cloneable

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule ( ALLOW, BLOCK, or COUNT).

To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.

See Also:

  • Constructor Details

    • ActivatedRule

      public ActivatedRule()

  • Method Details

    • setPriority

      public void setPriority(Integer priority)

      Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

      Parameters:
      priority - Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

    • getPriority

      public Integer getPriority()

      Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

      Returns:
      Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

    • withPriority

      public ActivatedRule withPriority(Integer priority)

      Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

      Parameters:
      priority - Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setRuleId

      public void setRuleId(String ruleId)

      The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

      RuleId is returned by CreateRule and by ListRules.

      Parameters:
      ruleId - The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

      RuleId is returned by CreateRule and by ListRules.

    • getRuleId

      public String getRuleId()

      The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

      RuleId is returned by CreateRule and by ListRules.

      Returns:
      The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

      RuleId is returned by CreateRule and by ListRules.

    • withRuleId

      public ActivatedRule withRuleId(String ruleId)

      The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

      RuleId is returned by CreateRule and by ListRules.

      Parameters:
      ruleId - The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

      RuleId is returned by CreateRule and by ListRules.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setAction

      public void setAction(WafAction action)

      Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

      • ALLOW: CloudFront responds with the requested object.
      • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
      • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
      Parameters:
      action - Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

      • ALLOW: CloudFront responds with the requested object.
      • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
      • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

    • getAction

      public WafAction getAction()

      Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

      • ALLOW: CloudFront responds with the requested object.
      • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
      • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
      Returns:
      Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

      • ALLOW: CloudFront responds with the requested object.
      • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
      • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

    • withAction

      public ActivatedRule withAction(WafAction action)

      Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

      • ALLOW: CloudFront responds with the requested object.
      • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
      • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
      Parameters:
      action - Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

      • ALLOW: CloudFront responds with the requested object.
      • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
      • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in 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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public ActivatedRule clone()
      Overrides:
      clone in class Object