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.
| Constructor and Description |
|---|
WebACL() |
| Modifier and Type | Method and Description |
|---|---|
WebACL |
clone() |
boolean |
equals(Object obj) |
WafAction |
getDefaultAction()
The action to perform if none of the
Rules contained in the
WebACL match. |
String |
getMetricName() |
String |
getName()
A friendly name or description of the
WebACL. |
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. |
String |
getWebACLId()
A unique identifier for a
WebACL. |
int |
hashCode() |
void |
setDefaultAction(WafAction defaultAction)
The action to perform if none of the
Rules contained in the
WebACL match. |
void |
setMetricName(String metricName) |
void |
setName(String name)
A friendly name or description of the
WebACL. |
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. |
void |
setWebACLId(String webACLId)
A unique identifier for a
WebACL. |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
WebACL |
withDefaultAction(WafAction defaultAction)
The action to perform if none of the
Rules contained in the
WebACL match. |
WebACL |
withMetricName(String metricName) |
WebACL |
withName(String name)
A friendly name or description of the
WebACL. |
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. |
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. |
WebACL |
withWebACLId(String webACLId)
A unique identifier for a
WebACL. |
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.
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.
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.
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.
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.
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.
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.
name - A friendly name or description of the WebACL. You
can't change the name of a WebACL after you create
it.public String getName()
A friendly name or description of the WebACL. You can't
change the name of a WebACL after you create it.
WebACL. You
can't change the name of a WebACL after you create
it.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.
name - A friendly name or description of the WebACL. You
can't change the name of a WebACL after you create
it.public void setMetricName(String metricName)
metricName - public String getMetricName()
public WebACL withMetricName(String metricName)
metricName - 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.
defaultAction - The action to perform if none of the Rules contained
in the WebACL match. The action is specified by the
WafAction object.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.
Rules contained
in the WebACL match. The action is specified by the
WafAction object.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.
defaultAction - The action to perform if none of the Rules contained
in the WebACL match. The action is specified by the
WafAction object.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.
Rule in a
WebACL, the priority of the Rule, and
the ID of the Rule.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.
rules - An array that contains the action for each Rule in a
WebACL, the priority of the Rule, and
the ID of the Rule.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.
rules - An array that contains the action for each Rule in a
WebACL, the priority of the Rule, and
the ID of the Rule.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.
rules - An array that contains the action for each Rule in a
WebACL, the priority of the Rule, and
the ID of the Rule.public String toString()
toString in class ObjectObject.toString()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.