AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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.
Creates a RegexMatchSet . You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent
header or the query string. For example, you can create a RegexMatchSet
that contains a RegexMatchTuple
that looks for any requests with User-Agent
headers that match a RegexPatternSet
with pattern B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
To create and configure a RegexMatchSet
, perform the following steps:
ChangeToken
parameter of a CreateRegexMatchSet
request.CreateRegexMatchSet
request.GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexMatchSet
request.RegexPatternSet
, that you want AWS WAF to watch for.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide .
See also: AWS API Documentation
create-regex-match-set
--name <value>
--change-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--name
(string)
A friendly name or description of the RegexMatchSet . You can't changeName
after you create aRegexMatchSet
.
--change-token
(string)
The value returned by the most recent call to GetChangeToken .
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
RegexMatchSet -> (structure)
A RegexMatchSet that contains no
RegexMatchTuple
objects.RegexMatchSetId -> (string)
The
RegexMatchSetId
for aRegexMatchSet
. You useRegexMatchSetId
to get information about aRegexMatchSet
(see GetRegexMatchSet ), update aRegexMatchSet
(see UpdateRegexMatchSet ), insert aRegexMatchSet
into aRule
or delete one from aRule
(see UpdateRule ), and delete aRegexMatchSet
from AWS WAF (see DeleteRegexMatchSet ).RegexMatchSetId
is returned by CreateRegexMatchSet and by ListRegexMatchSets .Name -> (string)
A friendly name or description of the RegexMatchSet . You can't changeName
after you create aRegexMatchSet
.RegexMatchTuples -> (list)
Contains an array of RegexMatchTuple objects. Each
RegexMatchTuple
object 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-Agent
header.- 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.
(structure)
Note
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.The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each
RegexMatchTuple
object 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-Agent
header.- 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.
FieldToMatch -> (structure)
Specifies where in a web request to look for the
RegexPatternSet
.Type -> (string)
The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:
HEADER
: A specified request header, for example, the value of theUser-Agent
orReferer
header. If you chooseHEADER
for the type, specify the name of the header inData
.METHOD
: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods:DELETE
,GET
,HEAD
,OPTIONS
,PATCH
,POST
, andPUT
.QUERY_STRING
: A query string, which is the part of a URL that appears after a?
character, if any.URI
: The part of a web request that identifies a resource, for example,/images/daily-ad.jpg
.BODY
: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first8192
bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet .SINGLE_QUERY_ARG
: The parameter in the query string that you will inspect, such as UserName or SalesRegion . The maximum length forSINGLE_QUERY_ARG
is 30 characters.ALL_QUERY_ARGS
: Similar toSINGLE_QUERY_ARG
, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify inTargetString
.Data -> (string)
When the value of
Type
isHEADER
, enter the name of the header that you want AWS WAF to search, for example,User-Agent
orReferer
. The name of the header is not case sensitive.When the value of
Type
isSINGLE_QUERY_ARG
, enter the name of the parameter that you want AWS WAF to search, for example,UserName
orSalesRegion
. The parameter name is not case sensitive.If the value of
Type
is any other value, omitData
.TextTransformation -> (string)
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on
RegexPatternSet
before inspecting a request for a match.You can only specify a single type of TextTransformation.
CMD_LINEWhen you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
- Delete the following characters: " ' ^
- Delete spaces before the following characters: / (
- Replace the following characters with a space: , ;
- Replace multiple spaces with one space
- Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACEUse this option to replace the following characters with a space character (decimal 32):
- f, formfeed, decimal 12
- t, tab, decimal 9
- n, newline, decimal 10
- r, carriage return, decimal 13
- v, vertical tab, decimal 11
- non-breaking space, decimal 160
COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters.
HTML_ENTITY_DECODE
performs the following operations:
- Replaces
(ampersand)quot;
with"
- Replaces
(ampersand)nbsp;
with a non-breaking space, decimal 160- Replaces
(ampersand)lt;
with a "less than" symbol- Replaces
(ampersand)gt;
with>
- Replaces characters that are represented in hexadecimal format,
(ampersand)#xhhhh;
, with the corresponding characters- Replaces characters that are represented in decimal format,
(ampersand)#nnnn;
, with the corresponding charactersLOWERCASEUse this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODEUse this option to decode a URL-encoded value.
NONESpecify
NONE
if you don't want to perform any text transformations.RegexPatternSetId -> (string)
The
RegexPatternSetId
for aRegexPatternSet
. You useRegexPatternSetId
to get information about aRegexPatternSet
(see GetRegexPatternSet ), update aRegexPatternSet
(see UpdateRegexPatternSet ), insert aRegexPatternSet
into aRegexMatchSet
or delete one from aRegexMatchSet
(see UpdateRegexMatchSet ), and delete anRegexPatternSet
from AWS WAF (see DeleteRegexPatternSet ).RegexPatternSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets .
ChangeToken -> (string)
TheChangeToken
that you used to submit theCreateRegexMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .