Class: Aws::WAF::Types::ByteMatchSetUpdate

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-waf/types.rb

Overview

Note:

When making an API call, you may pass ByteMatchSetUpdate data as a hash:

{
  action: "INSERT", # required, accepts INSERT, DELETE
  byte_match_tuple: { # required
    field_to_match: { # required
      type: "URI", # required, accepts URI, QUERY_STRING, HEADER, METHOD, BODY, SINGLE_QUERY_ARG, ALL_QUERY_ARGS
      data: "MatchFieldData",
    },
    target_string: "data", # required
    text_transformation: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE
    positional_constraint: "EXACTLY", # required, accepts EXACTLY, STARTS_WITH, ENDS_WITH, CONTAINS, CONTAINS_WORD
  },
}

<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see

AWS WAF Classic][1

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.

</note>

In an UpdateByteMatchSet request, `ByteMatchSetUpdate` specifies whether to insert or delete a ByteMatchTuple and includes the settings for the `ByteMatchTuple`.

[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

Specifies whether to insert or delete a ByteMatchTuple.

Returns:

  • (String)

329
330
331
332
333
334
# File 'lib/aws-sdk-waf/types.rb', line 329

class ByteMatchSetUpdate < Struct.new(
  :action,
  :byte_match_tuple)
  SENSITIVE = []
  include Aws::Structure
end

#byte_match_tupleTypes::ByteMatchTuple

Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify `DELETE` for the value of `Action`, the `ByteMatchTuple` values must exactly match the values in the `ByteMatchTuple` that you want to delete from the `ByteMatchSet`.


329
330
331
332
333
334
# File 'lib/aws-sdk-waf/types.rb', line 329

class ByteMatchSetUpdate < Struct.new(
  :action,
  :byte_match_tuple)
  SENSITIVE = []
  include Aws::Structure
end