You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WAF::Types::UpdateByteMatchSetRequest

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

Overview

Note:

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

{
  byte_match_set_id: "ResourceId", # required
  change_token: "ChangeToken", # required
  updates: [ # required
    {
      action: "INSERT", # required, accepts INSERT, DELETE
      byte_match_tuple: { # required
        field_to_match: { # required
          type: "URI", # required, accepts URI, QUERY_STRING, HEADER, METHOD, BODY
          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
      },
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#byte_match_set_idString

The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Returns:

  • (String)


3193
3194
3195
3196
3197
3198
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3193

class UpdateByteMatchSetRequest < Struct.new(
  :byte_match_set_id,
  :change_token,
  :updates)
  include Aws::Structure
end

#change_tokenString

The value returned by the most recent call to GetChangeToken.

Returns:

  • (String)


3193
3194
3195
3196
3197
3198
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3193

class UpdateByteMatchSetRequest < Struct.new(
  :byte_match_set_id,
  :change_token,
  :updates)
  include Aws::Structure
end

#updatesArray<Types::ByteMatchSetUpdate>

An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

  • ByteMatchSetUpdate: Contains Action and ByteMatchTuple

  • ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation

  • FieldToMatch: Contains Data and Type

Returns:



3193
3194
3195
3196
3197
3198
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3193

class UpdateByteMatchSetRequest < Struct.new(
  :byte_match_set_id,
  :change_token,
  :updates)
  include Aws::Structure
end