Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . waf ]

update-regex-match-set

Description

Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet . For each RegexMatchSetUpdate object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one.
  • The part of a web request that you want AWS WAF to inspectupdate, 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.

For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string 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:

  • Create a RegexMatchSet. For more information, see create-regex-match-set .
  • Use get-change-token to get the change token that you provide in the change-token parameter of an update-regex-match-set request.
  • Submit an update-regex-match-set request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters 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

Synopsis

  update-regex-match-set
--regex-match-set-id <value>
--updates <value>
--change-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--regex-match-set-id (string)

The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by create-regex-match-set and by list-regex-match-sets .

--updates (list)

An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet . For more information, see RegexMatchTuple .

Shorthand Syntax:

Action=string,RegexMatchTuple={FieldToMatch={Type=string,Data=string},TextTransformation=string,RegexPatternSetId=string} ...

JSON Syntax:

[
  {
    "Action": "INSERT"|"DELETE",
    "RegexMatchTuple": {
      "FieldToMatch": {
        "Type": "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY",
        "Data": "string"
      },
      "TextTransformation": "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE",
      "RegexPatternSetId": "string"
    }
  }
  ...
]

--change-token (string)

The value returned by the most recent call to get-change-token .

--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.

--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.

Output

ChangeToken -> (string)

The change-token that you used to submit the update-regex-match-set request. You can also use this value to query the status of the request. For more information, see get-change-token-status .