Package com.amazonaws.services.waf.model

Class WebACL

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

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

See Also:

  • Constructor Details

    • WebACL

      public WebACL()

  • Method Details

    • setWebACLId

      public void setWebACLId(String webACLId)

      A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

      WebACLId is returned by CreateWebACL and by ListWebACLs.

      Parameters:
      webACLId - A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

      WebACLId is returned by CreateWebACL and by ListWebACLs.

    • getWebACLId

      public String getWebACLId()

      A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

      WebACLId is returned by CreateWebACL and by ListWebACLs.

      Returns:
      A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

      WebACLId is returned by CreateWebACL and by ListWebACLs.

    • withWebACLId

      public WebACL withWebACLId(String webACLId)

      A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

      WebACLId is returned by CreateWebACL and by ListWebACLs.

      Parameters:
      webACLId - A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

      WebACLId is returned by CreateWebACL and by ListWebACLs.

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

    • setName

      public void setName(String name)

      A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

      Parameters:
      name - A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    • getName

      public String getName()

      A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

      Returns:
      A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    • withName

      public WebACL withName(String name)

      A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

      Parameters:
      name - A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setMetricName

      public void setMetricName(String metricName)
      Parameters:
      metricName -

    • getMetricName

      public String getMetricName()
      Returns:

    • withMetricName

      public WebACL withMetricName(String metricName)
      Parameters:
      metricName -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setDefaultAction

      public void setDefaultAction(WafAction defaultAction)

      The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

      Parameters:
      defaultAction - The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

    • getDefaultAction

      public WafAction getDefaultAction()

      The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

      Returns:
      The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

    • withDefaultAction

      public WebACL withDefaultAction(WafAction defaultAction)

      The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

      Parameters:
      defaultAction - The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getRules

      public List<ActivatedRule> getRules()

      An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

      Returns:
      An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

    • setRules

      public void setRules(Collection<ActivatedRule> rules)

      An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

      Parameters:
      rules - An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

    • withRules

      public WebACL withRules(ActivatedRule... rules)

      An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

      NOTE: This method appends the values to the existing list (if any). Use setRules(java.util.Collection) or withRules(java.util.Collection) if you want to override the existing values.

      Parameters:
      rules - An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withRules

      public WebACL withRules(Collection<ActivatedRule> rules)

      An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

      Parameters:
      rules - An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
      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 WebACL clone()
      Overrides:
      clone in class Object