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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-waf/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, SizeConstraint, XssMatch
  data_id: "ResourceId", # required
}

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, 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.

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)


2407
2408
2409
2410
2411
2412
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 2407

class Predicate < Struct.new(
  :negated,
  :type,
  :data_id)
  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, 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, 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)


2407
2408
2409
2410
2411
2412
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 2407

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

#typeString

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

Returns:

  • (String)


2407
2408
2409
2410
2411
2412
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 2407

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