Class: Aws::WAFRegional::Types::ByteMatchSet

Inherits:

Struct

• Object
• Struct
• Aws::WAFRegional::Types::ByteMatchSet

Defined in:

(unknown)

Overview

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.

In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

A complex type that contains ByteMatchTuple objects, 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 ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

Returned by:

• CreateByteMatchSetResponse#byte_match_set
• GetByteMatchSetResponse#byte_match_set

See Also:

• AWS API Documentation

Instance Attribute Summary

• #byte_match_set_id ⇒ String

  The ByteMatchSetId for a ByteMatchSet.

• #byte_match_tuples ⇒ Array<Types::ByteMatchTuple>

  Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

• #name ⇒ String

  A friendly name or description of the ByteMatchSet.

Instance Attribute Details

#byte_match_set_id ⇒ String

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Returns:

• (String) —

  The ByteMatchSetId for a ByteMatchSet.

#byte_match_tuples ⇒ Array<Types::ByteMatchTuple>

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

Returns:

• (Array<Types::ByteMatchTuple>) —

  Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

#name ⇒ String

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

Returns:

• (String) —

  A friendly name or description of the ByteMatchSet.