Create Byte Match Set

waf_create_byte_match_set

R Documentation

This is AWS WAF Classic documentation

Description

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 ByteMatchSet. You then use update_byte_match_set 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 ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

To create and configure a ByteMatchSet, perform the following steps:

1. Use get_change_token to get the change token that you provide in the ChangeToken parameter of a create_byte_match_set request.

2. Submit a create_byte_match_set request.

3. Use get_change_token to get the change token that you provide in the ChangeToken parameter of an update_byte_match_set request.

4. Submit an update_byte_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 value 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.

Usage

waf_create_byte_match_set(Name, ChangeToken)

Arguments

Name

[required] A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

ChangeToken

[required] The value returned by the most recent call to get_change_token.

Value

A list with the following syntax:

list(
  ByteMatchSet = list(
    ByteMatchSetId = "string",
    Name = "string",
    ByteMatchTuples = list(
      list(
        FieldToMatch = list(
          Type = "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS",
          Data = "string"
        ),
        TargetString = raw,
        TextTransformation = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE",
        PositionalConstraint = "EXACTLY"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CONTAINS_WORD"
      )
    )
  ),
  ChangeToken = "string"
)

Request syntax

svc$create_byte_match_set(
  Name = "string",
  ChangeToken = "string"
)