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

Class: Aws::WAF::Types::RegexMatchSet

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

Overview

In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that you specified when you updated the RegexMatchSet.

The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains more than one RegexMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

Returns:

  • (String)


3475
3476
3477
3478
3479
3480
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3475

class RegexMatchSet < Struct.new(
  :regex_match_set_id,
  :name,
  :regex_match_tuples)
  include Aws::Structure
end

#regex_match_set_idString

The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).

RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

Returns:

  • (String)


3475
3476
3477
3478
3479
3480
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3475

class RegexMatchSet < Struct.new(
  :regex_match_set_id,
  :name,
  :regex_match_tuples)
  include Aws::Structure
end

#regex_match_tuplesArray<Types::RegexMatchTuple>

Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:

  • The part of a web request that you want AWS WAF to inspect, 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.

Returns:



3475
3476
3477
3478
3479
3480
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3475

class RegexMatchSet < Struct.new(
  :regex_match_set_id,
  :name,
  :regex_match_tuples)
  include Aws::Structure
end