Class: Aws::WAFRegional::Types::Predicate

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/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
}

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.

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)


4365
4366
4367
4368
4369
4370
4371
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4365

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)


4365
4366
4367
4368
4369
4370
4371
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4365

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)


4365
4366
4367
4368
4369
4370
4371
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4365

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