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

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

Overview

Note:

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

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

<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see

AWS WAF Classic][1

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.

</note>

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.

[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_idString

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)

4207
4208
4209
4210
4211
4212
4213
# File 'lib/aws-sdk-waf/types.rb', line 4207

class Predicate < Struct.new(
  :negated,
  :type,
  :data_id)
  SENSITIVE = []
  include Aws::Structure
end

#negatedBoolean

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:

  • (Boolean)

4207
4208
4209
4210
4211
4212
4213
# File 'lib/aws-sdk-waf/types.rb', line 4207

class Predicate < Struct.new(
  :negated,
  :type,
  :data_id)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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

Returns:

  • (String)

4207
4208
4209
4210
4211
4212
4213
# File 'lib/aws-sdk-waf/types.rb', line 4207

class Predicate < Struct.new(
  :negated,
  :type,
  :data_id)
  SENSITIVE = []
  include Aws::Structure
end