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 aRule
that you want to insert or delete, the priority of theRule
in theWebACL
, and the action that you want AWS WAF to take when a web request matches theRule
(ALLOW
,BLOCK
, orCOUNT
).To specify whether to insert or delete a
Rule
, use theAction
parameter in the WebACLUpdate data type.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ActivatedRule()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActivatedRule
clone()
boolean
equals(Object obj)
WafAction
getAction()
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in theRule
.Integer
getPriority()
Specifies the order in which theRules
in aWebACL
are evaluated.String
getRuleId()
TheRuleId
for aRule
.int
hashCode()
void
setAction(WafAction action)
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in theRule
.void
setPriority(Integer priority)
Specifies the order in which theRules
in aWebACL
are evaluated.void
setRuleId(String ruleId)
TheRuleId
for aRule
.String
toString()
Returns a string representation of this object; useful for testing and debugging.ActivatedRule
withAction(WafAction action)
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in theRule
.ActivatedRule
withPriority(Integer priority)
Specifies the order in which theRules
in aWebACL
are evaluated.ActivatedRule
withRuleId(String ruleId)
TheRuleId
for aRule
.
-
-
-
Method Detail
-
setPriority
public void setPriority(Integer priority)
Specifies the order in which the
Rules
in aWebACL
are evaluated. Rules with a lower value forPriority
are evaluated beforeRules
with a higher value. The value must be a unique integer. If you add multipleRules
to aWebACL
, the values don't need to be consecutive.- Parameters:
priority
- Specifies the order in which theRules
in aWebACL
are evaluated. Rules with a lower value forPriority
are evaluated beforeRules
with a higher value. The value must be a unique integer. If you add multipleRules
to aWebACL
, the values don't need to be consecutive.
-
getPriority
public Integer getPriority()
Specifies the order in which the
Rules
in aWebACL
are evaluated. Rules with a lower value forPriority
are evaluated beforeRules
with a higher value. The value must be a unique integer. If you add multipleRules
to aWebACL
, the values don't need to be consecutive.- Returns:
- Specifies the order in which the
Rules
in aWebACL
are evaluated. Rules with a lower value forPriority
are evaluated beforeRules
with a higher value. The value must be a unique integer. If you add multipleRules
to aWebACL
, the values don't need to be consecutive.
-
withPriority
public ActivatedRule withPriority(Integer priority)
Specifies the order in which the
Rules
in aWebACL
are evaluated. Rules with a lower value forPriority
are evaluated beforeRules
with a higher value. The value must be a unique integer. If you add multipleRules
to aWebACL
, the values don't need to be consecutive.- Parameters:
priority
- Specifies the order in which theRules
in aWebACL
are evaluated. Rules with a lower value forPriority
are evaluated beforeRules
with a higher value. The value must be a unique integer. If you add multipleRules
to aWebACL
, 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 aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.- Parameters:
ruleId
- TheRuleId
for aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.
-
getRuleId
public String getRuleId()
The
RuleId
for aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.- Returns:
- The
RuleId
for aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.
-
withRuleId
public ActivatedRule withRuleId(String ruleId)
The
RuleId
for aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.- Parameters:
ruleId
- TheRuleId
for aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
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 forAction
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 theRule
. Valid values forAction
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 forAction
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 forAction
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 forAction
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 theRule
. Valid values forAction
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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ActivatedRule clone()
-
-