Class: Aws::WAFV2::Types::Statement

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

Overview

The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.

For example specifications, see the examples section of CreateWebACL.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#and_statement ⇒ Types::AndStatement

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the ‘AndStatement`.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#byte_match_statement ⇒ Types::ByteMatchStatement

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#geo_match_statement ⇒ Types::GeoMatchStatement

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

  • To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the ‘CountryCodes` array.

  • Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ‘ForwardedIPConfig`.

If you use the web request origin, the label formats are ‘awswaf:clientip:geo:region:<ISO country code>-<ISO region code>` and `awswaf:clientip:geo:country:<ISO country code>`.

If you use a forwarded IP address, the label formats are ‘awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>` and `awswaf:forwardedip:geo:country:<ISO country code>`.

For additional details, see [Geographic match rule statement] in the [WAF Developer Guide].

[1]: docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#ip_set_reference_statement ⇒ Types::IPSetReferenceStatement

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#label_match_statement ⇒ Types::LabelMatchStatement

A rule statement to match 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.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#managed_rule_group_statement ⇒ Types::ManagedRuleGroupStatement

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

You cannot nest a ‘ManagedRuleGroupStatement`, for example for use inside a `NotStatement` or `OrStatement`. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.

<note markdown=“1”> You are charged additional fees when you use the WAF Bot Control managed rule group ‘AWSManagedRulesBotControlRuleSet`, the WAF Fraud Control account takeover prevention (ATP) managed rule group `AWSManagedRulesATPRuleSet`, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group `AWSManagedRulesACFPRuleSet`. For more information, see [WAF Pricing].

</note>

[1]: aws.amazon.com/waf/pricing/

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#not_statement ⇒ Types::NotStatement

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the ‘NotStatement`.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#or_statement ⇒ Types::OrStatement

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the ‘OrStatement`.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#rate_based_statement ⇒ Types::RateBasedStatement

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

<note markdown=“1”> If you change any of these settings in a rule that’s currently in use, the change resets the rule’s rate limiting counts. This can pause the rule’s rate limiting activities for up to a minute.

</note>

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

  • IP address 10.1.1.1, HTTP method POST

  • IP address 10.1.1.1, HTTP method GET

  • IP address 127.0.0.0, HTTP method POST

  • IP address 10.1.1.1, HTTP method GET

The rule would create different aggregation instances according to your aggregation criteria, for example:

  • If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:

    • IP address 10.1.1.1: count 3

    • IP address 127.0.0.0: count 1

  • If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:

    • HTTP method POST: count 2

    • HTTP method GET: count 2

  • If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:

    • IP address 10.1.1.1, HTTP method POST: count 1

    • IP address 10.1.1.1, HTTP method GET: count 2

    • IP address 127.0.0.0, HTTP method POST: count 1

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

You cannot nest a ‘RateBasedStatement` inside another statement, for example inside a `NotStatement` or `OrStatement`. You can define a `RateBasedStatement` inside a web ACL and inside a rule group.

For additional information about the options, see [Rate limiting web requests using rate-based rules] in the *WAF Developer Guide*.

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call ‘GetRateBasedStatementManagedKeys`. This option is not available for other aggregation configurations.

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

[1]: docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#regex_match_statement ⇒ Types::RegexMatchStatement

A rule statement used to search web request components for a match against a single regular expression.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#regex_pattern_set_reference_statement ⇒ Types::RegexPatternSetReferenceStatement

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_reference_statement ⇒ Types::RuleGroupReferenceStatement

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

You cannot nest a ‘RuleGroupReferenceStatement`, for example for use inside a `NotStatement` or `OrStatement`. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#size_constraint_statement ⇒ Types::SizeConstraintStatement

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (&gt;) or less than (&lt;). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see ‘Body` and `JsonBody` settings for the `FieldToMatch` data type.

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI ‘/logo.jpg` is nine characters long.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#sqli_match_statement ⇒ Types::SqliMatchStatement

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end

#xss_match_statement ⇒ Types::XssMatchStatement

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

Returns:



8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
 
# File 'lib/aws-sdk-wafv2/types.rb', line 8504

class Statement < Struct.new(
  :byte_match_statement,
  :sqli_match_statement,
  :xss_match_statement,
  :size_constraint_statement,
  :geo_match_statement,
  :rule_group_reference_statement,
  :ip_set_reference_statement,
  :regex_pattern_set_reference_statement,
  :rate_based_statement,
  :and_statement,
  :or_statement,
  :not_statement,
  :managed_rule_group_statement,
  :label_match_statement,
  :regex_match_statement)
  SENSITIVE = []
  include Aws::Structure
end