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

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

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

Overview

Note:

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

{
  byte_match_statement: {
    search_string: "data", # required
    field_to_match: { # required
      single_header: {
        name: "FieldToMatchData", # required
      },
      single_query_argument: {
        name: "FieldToMatchData", # required
      },
      all_query_arguments: {
      },
      uri_path: {
      },
      query_string: {
      },
      body: {
      },
      method: {
      },
    },
    text_transformations: [ # required
      {
        priority: 1, # required
        type: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE
      },
    ],
    positional_constraint: "EXACTLY", # required, accepts EXACTLY, STARTS_WITH, ENDS_WITH, CONTAINS, CONTAINS_WORD
  },
  sqli_match_statement: {
    field_to_match: { # required
      single_header: {
        name: "FieldToMatchData", # required
      },
      single_query_argument: {
        name: "FieldToMatchData", # required
      },
      all_query_arguments: {
      },
      uri_path: {
      },
      query_string: {
      },
      body: {
      },
      method: {
      },
    },
    text_transformations: [ # required
      {
        priority: 1, # required
        type: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE
      },
    ],
  },
  xss_match_statement: {
    field_to_match: { # required
      single_header: {
        name: "FieldToMatchData", # required
      },
      single_query_argument: {
        name: "FieldToMatchData", # required
      },
      all_query_arguments: {
      },
      uri_path: {
      },
      query_string: {
      },
      body: {
      },
      method: {
      },
    },
    text_transformations: [ # required
      {
        priority: 1, # required
        type: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE
      },
    ],
  },
  size_constraint_statement: {
    field_to_match: { # required
      single_header: {
        name: "FieldToMatchData", # required
      },
      single_query_argument: {
        name: "FieldToMatchData", # required
      },
      all_query_arguments: {
      },
      uri_path: {
      },
      query_string: {
      },
      body: {
      },
      method: {
      },
    },
    comparison_operator: "EQ", # required, accepts EQ, NE, LE, LT, GE, GT
    size: 1, # required
    text_transformations: [ # required
      {
        priority: 1, # required
        type: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE
      },
    ],
  },
  geo_match_statement: {
    country_codes: ["AF"], # accepts AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
    forwarded_ip_config: {
      header_name: "ForwardedIPHeaderName", # required
      fallback_behavior: "MATCH", # required, accepts MATCH, NO_MATCH
    },
  },
  rule_group_reference_statement: {
    arn: "ResourceArn", # required
    excluded_rules: [
      {
        name: "EntityName", # required
      },
    ],
  },
  ip_set_reference_statement: {
    arn: "ResourceArn", # required
    ip_set_forwarded_ip_config: {
      header_name: "ForwardedIPHeaderName", # required
      fallback_behavior: "MATCH", # required, accepts MATCH, NO_MATCH
      position: "FIRST", # required, accepts FIRST, LAST, ANY
    },
  },
  regex_pattern_set_reference_statement: {
    arn: "ResourceArn", # required
    field_to_match: { # required
      single_header: {
        name: "FieldToMatchData", # required
      },
      single_query_argument: {
        name: "FieldToMatchData", # required
      },
      all_query_arguments: {
      },
      uri_path: {
      },
      query_string: {
      },
      body: {
      },
      method: {
      },
    },
    text_transformations: [ # required
      {
        priority: 1, # required
        type: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE
      },
    ],
  },
  rate_based_statement: {
    limit: 1, # required
    aggregate_key_type: "IP", # required, accepts IP, FORWARDED_IP
    scope_down_statement: {
      # recursive Statement
    },
    forwarded_ip_config: {
      header_name: "ForwardedIPHeaderName", # required
      fallback_behavior: "MATCH", # required, accepts MATCH, NO_MATCH
    },
  },
  and_statement: {
    statements: [ # required
      {
        # recursive Statement
      },
    ],
  },
  or_statement: {
    statements: [ # required
      {
        # recursive Statement
      },
    ],
  },
  not_statement: {
    statement: { # required
      # recursive Statement
    },
  },
  managed_rule_group_statement: {
    vendor_name: "VendorName", # required
    name: "EntityName", # required
    excluded_rules: [
      {
        name: "EntityName", # required
      },
    ],
  },
}

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

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

Returned by:

See Also:

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:

  • (Types::AndStatement) —

    A logical rule statement used to combine other rule statements with AND logic.

#byte_match_statement ⇒ Types::ByteMatchStatement

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

Returns:

#geo_match_statement ⇒ Types::GeoMatchStatement

A rule statement used to identify web requests based on country of origin.

Returns:

#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, AWS WAF automatically updates all rules that reference it.

Returns:

#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 can\'t nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

Returns:

#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:

  • (Types::NotStatement) —

    A logical rule statement used to negate the results of another rule statement.

#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:

  • (Types::OrStatement) —

    A logical rule statement used to combine other rule statements with OR logic.

#rate_based_statement ⇒ Types::RateBasedStatement

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

  • An IP match statement with an IP set that specified the address 192.0.2.44.

  • A string match statement that searches in the User-Agent header for the string BadBot.

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

Returns:

  • (Types::RateBasedStatement) —

    A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span.

#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, AWS WAF automatically updates all rules that reference it.

Returns:

#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. It can only be referenced as a top-level statement within a rule.

Returns:

#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 (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

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:

  • (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 (>) or less than (<).

#sqli_match_statement ⇒ Types::SqliMatchStatement

Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

Returns:

  • (Types::SqliMatchStatement) —

    Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database.

#xss_match_statement ⇒ Types::XssMatchStatement

A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

Returns:

  • (Types::XssMatchStatement) —

    A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests.