Predicate
Note
AWS WAF Classic support will end on September 30, 2025.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects
that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do
NOT originate from the IP address 192.0.2.44.
Contents
- DataId
-
A unique identifier for a predicate in a
Rule, such asByteMatchSetIdorIPSetId. The ID is returned by the correspondingCreateorListcommand.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: Yes
- Negated
-
Set
NegatedtoFalseif you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if anIPSetincludes the IP address192.0.2.44, AWS WAF will allow or block requests based on that IP address.Set
NegatedtoTrueif you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if anIPSetincludes the IP address192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except192.0.2.44.Type: Boolean
Required: Yes
- Type
-
The type of predicate in a
Rule, such asByteMatchorIPSet.Type: String
Valid Values:
IPMatch | ByteMatch | SqlInjectionMatch | GeoMatch | SizeConstraint | XssMatch | RegexMatchRequired: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
