@Generated(value="software.amazon.awssdk:codegen") public final class ActivatedRule extends Object implements StructuredPojo, ToCopyableBuilder<ActivatedRule.Builder,ActivatedRule>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
ActivatedRule.Builder |
Modifier and Type | Method and Description |
---|---|
WafAction |
action()
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the
Rule . |
static ActivatedRule.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Integer |
priority()
Specifies the order in which the
Rules in a WebACL are evaluated. |
String |
ruleId()
The
RuleId for a Rule . |
static Class<? extends ActivatedRule.Builder> |
serializableBuilderClass() |
ActivatedRule.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
WafRuleType |
type()
|
String |
typeAsString()
|
copy
public 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.
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.public 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.
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.
public 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.
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.
public WafRuleType type()
The rule type, either REGULAR
, as defined by Rule, or RATE_BASED
, as defined by
RateBasedRule. The default is REGULAR. Although this field is optional, be aware that if you try to add a
RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the
request tries to add a REGULAR rule with the specified ID, which does not exist.
If the service returns an enum value that is not available in the current SDK version, type
will return
WafRuleType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
REGULAR
, as defined by Rule, or RATE_BASED
, as
defined by RateBasedRule. The default is REGULAR. Although this field is optional, be aware that
if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL
request will fail because the request tries to add a REGULAR rule with the specified ID, which does not
exist.WafRuleType
public String typeAsString()
The rule type, either REGULAR
, as defined by Rule, or RATE_BASED
, as defined by
RateBasedRule. The default is REGULAR. Although this field is optional, be aware that if you try to add a
RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the
request tries to add a REGULAR rule with the specified ID, which does not exist.
If the service returns an enum value that is not available in the current SDK version, type
will return
WafRuleType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
REGULAR
, as defined by Rule, or RATE_BASED
, as
defined by RateBasedRule. The default is REGULAR. Although this field is optional, be aware that
if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL
request will fail because the request tries to add a REGULAR rule with the specified ID, which does not
exist.WafRuleType
public ActivatedRule.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ActivatedRule.Builder,ActivatedRule>
public static ActivatedRule.Builder builder()
public static Class<? extends ActivatedRule.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.