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

Class: Aws::WAF::Types::Predicate

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Predicate as input to an Aws::Client method, you can use a vanilla Hash:

{
  negated: false, # required
  type: "IPMatch", # required, accepts IPMatch, ByteMatch, SqlInjectionMatch, GeoMatch, SizeConstraint, XssMatch, RegexMatch
  data_id: "ResourceId", # required
}

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.

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#data_id ⇒ String

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Returns:

  • (String) —

    A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId.

#negated ⇒ Boolean

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

Returns:

#type ⇒ String

The type of predicate in a Rule, such as ByteMatch or IPSet.

Possible values:

  • IPMatch
  • ByteMatch
  • SqlInjectionMatch
  • GeoMatch
  • SizeConstraint
  • XssMatch
  • RegexMatch

Returns:

  • (String) —

    The type of predicate in a Rule, such as ByteMatch or IPSet.