[ aws . waf-regional ]
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 an XssMatchSet , which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure an
XssMatchSet , perform the following steps:
ChangeTokenparameter of a
GetChangeTokento get the change token that you provide in the
ChangeTokenparameter of an UpdateXssMatchSet request.
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-xss-match-set --name <value> --change-token <value> [--cli-input-json | --cli-input-yaml] [--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>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
A friendly name or description for the XssMatchSet that you’re creating. You can’t change
Nameafter you create the
The value returned by the most recent call to GetChangeToken .
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with
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. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
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.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
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.
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.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
XssMatchSet -> (structure)
An XssMatchSet .
XssMatchSetId -> (string)
A unique identifier for an
XssMatchSet. You use
XssMatchSetIdto get information about an
XssMatchSet(see GetXssMatchSet ), update an
XssMatchSet(see UpdateXssMatchSet ), insert an
Ruleor delete one from a
Rule(see UpdateRule ), and delete an
XssMatchSetfrom AWS WAF (see DeleteXssMatchSet ).
XssMatchSetIdis returned by CreateXssMatchSet and by ListXssMatchSets .
Name -> (string)The name, if any, of the
XssMatchTuples -> (list)
Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
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 part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.
FieldToMatch -> (structure)
Specifies where in a web request to look for cross-site scripting attacks.
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 the
Refererheader. If you choose
HEADERfor the type, specify the name of the header in
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:
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,
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 first
8192bytes 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 for
SINGLE_QUERY_ARGis 30 characters.
ALL_QUERY_ARGS: Similar to
SINGLE_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 in
Data -> (string)
When the value of
HEADER, enter the name of the header that you want AWS WAF to search, for example,
Referer. The name of the header is not case sensitive.
When the value of
SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example,
SalesRegion. The parameter name is not case sensitive.
If the value of
Typeis any other value, omit
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
FieldToMatchbefore inspecting it for a match.
You can only specify a single type of TextTransformation.CMD_LINE
When you’re concerned that attackers are injecting an operating system command line 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_SPACE
Use 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_SPACEalso replaces multiple spaces with one space.
Use this option to replace HTML-encoded characters with unencoded characters.
HTML_ENTITY_DECODEperforms the following operations:
(ampersand)nbsp;with a non-breaking space, decimal 160
(ampersand)lt;with a “less than” symbol
- 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 charactersLOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).URL_DECODE
Use this option to decode a URL-encoded value.NONE
NONEif you don’t want to perform any text transformations.
ChangeToken -> (string)
ChangeTokenthat you used to submit the
CreateXssMatchSetrequest. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .