Package software.amazon.awssdk.services.wafv2.model

Interface Statement.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Statement.Builder,Statement>, SdkBuilder<Statement.Builder,Statement>, SdkPojo
Enclosing class:
Statement
public static interface Statement.Builder extends SdkPojo, CopyableBuilder<Statement.Builder,Statement>

  • Method Details

    • byteMatchStatement

      Statement.Builder byteMatchStatement(ByteMatchStatement 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • byteMatchStatement

      default Statement.Builder byteMatchStatement(Consumer<ByteMatchStatement.Builder> 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.

      This is a convenience method that creates an instance of the ByteMatchStatement.Builder avoiding the need to create one manually via ByteMatchStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to byteMatchStatement(ByteMatchStatement).

      Parameters:
      byteMatchStatement - a consumer that will call methods on ByteMatchStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sqliMatchStatement

      Statement.Builder sqliMatchStatement(SqliMatchStatement 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • sqliMatchStatement

      default Statement.Builder sqliMatchStatement(Consumer<SqliMatchStatement.Builder> 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.

      This is a convenience method that creates an instance of the SqliMatchStatement.Builder avoiding the need to create one manually via SqliMatchStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sqliMatchStatement(SqliMatchStatement).

      Parameters:
      sqliMatchStatement - a consumer that will call methods on SqliMatchStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • xssMatchStatement

      Statement.Builder xssMatchStatement(XssMatchStatement 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • xssMatchStatement

      default Statement.Builder xssMatchStatement(Consumer<XssMatchStatement.Builder> 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.

      This is a convenience method that creates an instance of the XssMatchStatement.Builder avoiding the need to create one manually via XssMatchStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to xssMatchStatement(XssMatchStatement).

      Parameters:
      xssMatchStatement - a consumer that will call methods on XssMatchStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sizeConstraintStatement

      Statement.Builder sizeConstraintStatement(SizeConstraintStatement 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 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.

      Parameters:
      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 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:
      Returns a reference to this object so that method calls can be chained together.

    • sizeConstraintStatement

      default Statement.Builder sizeConstraintStatement(Consumer<SizeConstraintStatement.Builder> 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 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.

      This is a convenience method that creates an instance of the SizeConstraintStatement.Builder avoiding the need to create one manually via SizeConstraintStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sizeConstraintStatement(SizeConstraintStatement).

      Parameters:
      sizeConstraintStatement - a consumer that will call methods on SizeConstraintStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • geoMatchStatement

      Statement.Builder geoMatchStatement(GeoMatchStatement 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • geoMatchStatement

      default Statement.Builder geoMatchStatement(Consumer<GeoMatchStatement.Builder> 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.

      This is a convenience method that creates an instance of the GeoMatchStatement.Builder avoiding the need to create one manually via GeoMatchStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to geoMatchStatement(GeoMatchStatement).

      Parameters:
      geoMatchStatement - a consumer that will call methods on GeoMatchStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ruleGroupReferenceStatement

      Statement.Builder ruleGroupReferenceStatement(RuleGroupReferenceStatement 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • ruleGroupReferenceStatement

      default Statement.Builder ruleGroupReferenceStatement(Consumer<RuleGroupReferenceStatement.Builder> 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.

      This is a convenience method that creates an instance of the RuleGroupReferenceStatement.Builder avoiding the need to create one manually via RuleGroupReferenceStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ruleGroupReferenceStatement(RuleGroupReferenceStatement).

      Parameters:
      ruleGroupReferenceStatement - a consumer that will call methods on RuleGroupReferenceStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipSetReferenceStatement

      Statement.Builder ipSetReferenceStatement(IPSetReferenceStatement 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • ipSetReferenceStatement

      default Statement.Builder ipSetReferenceStatement(Consumer<IPSetReferenceStatement.Builder> 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.

      This is a convenience method that creates an instance of the IPSetReferenceStatement.Builder avoiding the need to create one manually via IPSetReferenceStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ipSetReferenceStatement(IPSetReferenceStatement).

      Parameters:
      ipSetReferenceStatement - a consumer that will call methods on IPSetReferenceStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • regexPatternSetReferenceStatement

      Statement.Builder regexPatternSetReferenceStatement(RegexPatternSetReferenceStatement 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • regexPatternSetReferenceStatement

      default Statement.Builder regexPatternSetReferenceStatement(Consumer<RegexPatternSetReferenceStatement.Builder> 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.

      This is a convenience method that creates an instance of the RegexPatternSetReferenceStatement.Builder avoiding the need to create one manually via RegexPatternSetReferenceStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to regexPatternSetReferenceStatement(RegexPatternSetReferenceStatement).

      Parameters:
      regexPatternSetReferenceStatement - a consumer that will call methods on RegexPatternSetReferenceStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rateBasedStatement

      Statement.Builder rateBasedStatement(RateBasedStatement 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.

      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.

      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.

      Parameters:
      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.

      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.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rateBasedStatement

      default Statement.Builder rateBasedStatement(Consumer<RateBasedStatement.Builder> 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.

      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.

      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.

      This is a convenience method that creates an instance of the RateBasedStatement.Builder avoiding the need to create one manually via RateBasedStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rateBasedStatement(RateBasedStatement).

      Parameters:
      rateBasedStatement - a consumer that will call methods on RateBasedStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • andStatement

      Statement.Builder andStatement(AndStatement andStatement)

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

      Parameters:
      andStatement - A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • andStatement

      default Statement.Builder andStatement(Consumer<AndStatement.Builder> andStatement)

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

      This is a convenience method that creates an instance of the AndStatement.Builder avoiding the need to create one manually via AndStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to andStatement(AndStatement).

      Parameters:
      andStatement - a consumer that will call methods on AndStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • orStatement

      Statement.Builder orStatement(OrStatement orStatement)

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

      Parameters:
      orStatement - A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • orStatement

      default Statement.Builder orStatement(Consumer<OrStatement.Builder> orStatement)

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

      This is a convenience method that creates an instance of the OrStatement.Builder avoiding the need to create one manually via OrStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to orStatement(OrStatement).

      Parameters:
      orStatement - a consumer that will call methods on OrStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notStatement

      Statement.Builder notStatement(NotStatement notStatement)

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

      Parameters:
      notStatement - A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notStatement

      default Statement.Builder notStatement(Consumer<NotStatement.Builder> notStatement)

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

      This is a convenience method that creates an instance of the NotStatement.Builder avoiding the need to create one manually via NotStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notStatement(NotStatement).

      Parameters:
      notStatement - a consumer that will call methods on NotStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • managedRuleGroupStatement

      Statement.Builder managedRuleGroupStatement(ManagedRuleGroupStatement 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.

      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.

      Parameters:
      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.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedRuleGroupStatement

      default Statement.Builder managedRuleGroupStatement(Consumer<ManagedRuleGroupStatement.Builder> 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.

      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.

      This is a convenience method that creates an instance of the ManagedRuleGroupStatement.Builder avoiding the need to create one manually via ManagedRuleGroupStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to managedRuleGroupStatement(ManagedRuleGroupStatement).

      Parameters:
      managedRuleGroupStatement - a consumer that will call methods on ManagedRuleGroupStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • labelMatchStatement

      Statement.Builder labelMatchStatement(LabelMatchStatement 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • labelMatchStatement

      default Statement.Builder labelMatchStatement(Consumer<LabelMatchStatement.Builder> 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.

      This is a convenience method that creates an instance of the LabelMatchStatement.Builder avoiding the need to create one manually via LabelMatchStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to labelMatchStatement(LabelMatchStatement).

      Parameters:
      labelMatchStatement - a consumer that will call methods on LabelMatchStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • regexMatchStatement

      Statement.Builder regexMatchStatement(RegexMatchStatement regexMatchStatement)

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

      Parameters:
      regexMatchStatement - A rule statement used to search web request components for a match against a single regular expression.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regexMatchStatement

      default Statement.Builder regexMatchStatement(Consumer<RegexMatchStatement.Builder> regexMatchStatement)

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

      This is a convenience method that creates an instance of the RegexMatchStatement.Builder avoiding the need to create one manually via RegexMatchStatement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to regexMatchStatement(RegexMatchStatement).

      Parameters:
      regexMatchStatement - a consumer that will call methods on RegexMatchStatement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: