Class AwsWafWebAclRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsWafWebAclRule.Builder,
AwsWafWebAclRule>
Details for a rule in an WAF web ACL.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal WafAction
action()
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.static AwsWafWebAclRule.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<WafExcludedRule> Rules to exclude from a rule group.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExcludedRules property.final int
hashCode()
final WafOverrideAction
Use theOverrideAction
to test yourRuleGroup
.final Integer
priority()
Specifies the order in which the rules in a web ACL are evaluated.final String
ruleId()
The identifier for a rule.static Class
<? extends AwsWafWebAclRule.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
type()
The rule type.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
action
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
- Returns:
- Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
-
hasExcludedRules
public final boolean hasExcludedRules()For responses, this returns true if the service returned a value for the ExcludedRules property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
excludedRules
Rules to exclude from a rule group.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExcludedRules()
method.- Returns:
- Rules to exclude from a rule group.
-
overrideAction
Use the
OverrideAction
to test yourRuleGroup
.Any rule in a
RuleGroup
can potentially block a request. If you set theOverrideAction
toNone
, theRuleGroup
blocks a request if any individual rule in theRuleGroup
matches the request and is configured to block that request.However, if you first want to test the
RuleGroup
, set theOverrideAction
toCount
. TheRuleGroup
then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.ActivatedRule
|OverrideAction
applies only when updating or adding aRuleGroup
to a web ACL. In this case you do not useActivatedRule
Action
. For all other update requests,ActivatedRule
Action
is used instead ofActivatedRule
OverrideAction
.- Returns:
- Use the
OverrideAction
to test yourRuleGroup
.Any rule in a
RuleGroup
can potentially block a request. If you set theOverrideAction
toNone
, theRuleGroup
blocks a request if any individual rule in theRuleGroup
matches the request and is configured to block that request.However, if you first want to test the
RuleGroup
, set theOverrideAction
toCount
. TheRuleGroup
then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.ActivatedRule
|OverrideAction
applies only when updating or adding aRuleGroup
to a web ACL. In this case you do not useActivatedRule
Action
. For all other update requests,ActivatedRule
Action
is used instead ofActivatedRule
OverrideAction
.
-
priority
Specifies the order in which the rules in a web ACL 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 web ACL, the values do not need to be consecutive.- Returns:
- Specifies the order in which the rules in a web ACL 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 web ACL, the values do not need to be consecutive.
-
ruleId
The identifier for a rule.
- Returns:
- The identifier for a rule.
-
type
The rule type.
Valid values:
REGULAR
|RATE_BASED
|GROUP
The default is
REGULAR
.- Returns:
- The rule type.
Valid values:
REGULAR
|RATE_BASED
|GROUP
The default is
REGULAR
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AwsWafWebAclRule.Builder,
AwsWafWebAclRule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-