RegexMatchSet
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.
In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and
Name of a RegexMatchSet, and the values that you specified when you updated the RegexMatchSet.
The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains more than one
RegexMatchTuple object, a request needs to match the settings in only one ByteMatchTuple
to be considered a match.
Contents
- Name
-
A friendly name or description of the RegexMatchSet. You can't change
Nameafter you create aRegexMatchSet.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: No
- RegexMatchSetId
-
The
RegexMatchSetIdfor aRegexMatchSet. You useRegexMatchSetIdto get information about aRegexMatchSet(see GetRegexMatchSet), update aRegexMatchSet(see UpdateRegexMatchSet), insert aRegexMatchSetinto aRuleor delete one from aRule(see UpdateRule), and delete aRegexMatchSetfrom AWS WAF (see DeleteRegexMatchSet).RegexMatchSetIdis returned by CreateRegexMatchSet and by ListRegexMatchSets.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: No
- RegexMatchTuples
-
Contains an array of RegexMatchTuple objects. Each
RegexMatchTupleobject contains:-
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agentheader. -
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
-
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
Type: Array of RegexMatchTuple objects
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
