waf_update_size_constraint_set: Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet

Description

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

Usage

waf_update_size_constraint_set(SizeConstraintSetId, ChangeToken,
  Updates)

Arguments

SizeConstraintSetId

[required] The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

ChangeToken

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

Updates

[required] An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:

SizeConstraintSetUpdate: Contains Action and SizeConstraint
SizeConstraint: Contains FieldToMatch, TextTransformation, ComparisonOperator, and Size
FieldToMatch: Contains Data and Type

Request syntax

svc$update_size_constraint_set(
  SizeConstraintSetId = "string",
  ChangeToken = "string",
  Updates = list(
    list(
      Action = "INSERT"|"DELETE",
      SizeConstraint = list(
        FieldToMatch = list(
          Type = "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS",
          Data = "string"
        ),
        TextTransformation = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE",
        ComparisonOperator = "EQ"|"NE"|"LE"|"LT"|"GE"|"GT",
        Size = 123
      )
    )
  )
)

Details

Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.
Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

You can only specify a single type of TextTransformation.
A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.
The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

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

Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.
Submit an UpdateSizeConstraintSet 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.

Examples

Run this code

# NOT RUN {
# The following example deletes a SizeConstraint object (filters) in a
# size constraint set with the ID
# example1ds3t-46da-4fdb-b8d5-abc321j569j5.
svc$update_size_constraint_set(
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
  SizeConstraintSetId = "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
  Updates = list(
    list(
      Action = "DELETE",
      SizeConstraint = list(
        ComparisonOperator = "GT",
        FieldToMatch = list(
          Type = "QUERY_STRING"
        ),
        Size = 0L,
        TextTransformation = "NONE"
      )
    )
  )
)
# }
# NOT RUN {
# }