class Aws::WAFV2::Types::LabelMatchStatement

A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

@note When making an API call, you may pass LabelMatchStatement

data as a hash:

    {
      scope: "LABEL", # required, accepts LABEL, NAMESPACE
      key: "LabelMatchKey", # required
    }

@!attribute [rw] scope

Specify whether you want to match using the label name or just the
namespace.
@return [String]

@!attribute [rw] key

The string to match against. The setting you provide for this
depends on the match statement's `Scope` setting:

* If the `Scope` indicates `LABEL`, then this specification must
  include the name and can include any number of preceding namespace
  specifications and prefix up to providing the fully qualified
  label name.

* If the `Scope` indicates `NAMESPACE`, then this specification can
  include any number of contiguous namespace strings, and can
  include the entire label namespace prefix from the rule group or
  web ACL where the label originates.

Labels are case sensitive and components of a label must be
separated by colon, for example `NS1:NS2:name`.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/LabelMatchStatement AWS API Documentation

Constants

SENSITIVE