interface RateBasedStatementProperty

Language	Type name
.NET	Amazon.CDK.AWS.WAFv2.CfnWebACL.RateBasedStatementProperty
Java	software.amazon.awscdk.services.wafv2.CfnWebACL.RateBasedStatementProperty
Python	aws_cdk.aws_wafv2.CfnWebACL.RateBasedStatementProperty
TypeScript	@aws-cdk/aws-wafv2 » CfnWebACL » RateBasedStatementProperty

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.

AWS 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 AWS 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 AWS WAF .

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 specifies 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 the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this 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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as wafv2 from '@aws-cdk/aws-wafv2';

declare const all: any;
declare const allQueryArguments: any;
declare const method: any;
declare const queryString: any;
declare const singleHeader: any;
declare const singleQueryArgument: any;
declare const statementProperty_: wafv2.CfnWebACL.StatementProperty;
declare const uriPath: any;
const rateBasedStatementProperty: wafv2.CfnWebACL.RateBasedStatementProperty = {
  aggregateKeyType: 'aggregateKeyType',
  limit: 123,

  // the properties below are optional
  forwardedIpConfig: {
    fallbackBehavior: 'fallbackBehavior',
    headerName: 'headerName',
  },
  scopeDownStatement: {
    andStatement: {
      statements: [statementProperty_],
    },
    byteMatchStatement: {
      fieldToMatch: {
        allQueryArguments: allQueryArguments,
        body: {
          oversizeHandling: 'oversizeHandling',
        },
        cookies: {
          matchPattern: {
            all: all,
            excludedCookies: ['excludedCookies'],
            includedCookies: ['includedCookies'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        headers: {
          matchPattern: {
            all: all,
            excludedHeaders: ['excludedHeaders'],
            includedHeaders: ['includedHeaders'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        jsonBody: {
          matchPattern: {
            all: all,
            includedPaths: ['includedPaths'],
          },
          matchScope: 'matchScope',

          // the properties below are optional
          invalidFallbackBehavior: 'invalidFallbackBehavior',
          oversizeHandling: 'oversizeHandling',
        },
        method: method,
        queryString: queryString,
        singleHeader: singleHeader,
        singleQueryArgument: singleQueryArgument,
        uriPath: uriPath,
      },
      positionalConstraint: 'positionalConstraint',
      textTransformations: [{
        priority: 123,
        type: 'type',
      }],

      // the properties below are optional
      searchString: 'searchString',
      searchStringBase64: 'searchStringBase64',
    },
    geoMatchStatement: {
      countryCodes: ['countryCodes'],
      forwardedIpConfig: {
        fallbackBehavior: 'fallbackBehavior',
        headerName: 'headerName',
      },
    },
    ipSetReferenceStatement: {
      arn: 'arn',

      // the properties below are optional
      ipSetForwardedIpConfig: {
        fallbackBehavior: 'fallbackBehavior',
        headerName: 'headerName',
        position: 'position',
      },
    },
    labelMatchStatement: {
      key: 'key',
      scope: 'scope',
    },
    managedRuleGroupStatement: {
      name: 'name',
      vendorName: 'vendorName',

      // the properties below are optional
      excludedRules: [{
        name: 'name',
      }],
      managedRuleGroupConfigs: [{
        awsManagedRulesAtpRuleSet: {
          loginPath: 'loginPath',

          // the properties below are optional
          requestInspection: {
            passwordField: {
              identifier: 'identifier',
            },
            payloadType: 'payloadType',
            usernameField: {
              identifier: 'identifier',
            },
          },
          responseInspection: {
            bodyContains: {
              failureStrings: ['failureStrings'],
              successStrings: ['successStrings'],
            },
            header: {
              failureValues: ['failureValues'],
              name: 'name',
              successValues: ['successValues'],
            },
            json: {
              failureValues: ['failureValues'],
              identifier: 'identifier',
              successValues: ['successValues'],
            },
            statusCode: {
              failureCodes: [123],
              successCodes: [123],
            },
          },
        },
        awsManagedRulesBotControlRuleSet: {
          inspectionLevel: 'inspectionLevel',
        },
        loginPath: 'loginPath',
        passwordField: {
          identifier: 'identifier',
        },
        payloadType: 'payloadType',
        usernameField: {
          identifier: 'identifier',
        },
      }],
      ruleActionOverrides: [{
        actionToUse: {
          allow: {
            customRequestHandling: {
              insertHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
          block: {
            customResponse: {
              responseCode: 123,

              // the properties below are optional
              customResponseBodyKey: 'customResponseBodyKey',
              responseHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
          captcha: {
            customRequestHandling: {
              insertHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
          challenge: {
            customRequestHandling: {
              insertHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
          count: {
            customRequestHandling: {
              insertHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
        },
        name: 'name',
      }],
      scopeDownStatement: statementProperty_,
      version: 'version',
    },
    notStatement: {
      statement: statementProperty_,
    },
    orStatement: {
      statements: [statementProperty_],
    },
    rateBasedStatement: {
      aggregateKeyType: 'aggregateKeyType',
      limit: 123,

      // the properties below are optional
      forwardedIpConfig: {
        fallbackBehavior: 'fallbackBehavior',
        headerName: 'headerName',
      },
      scopeDownStatement: statementProperty_,
    },
    regexMatchStatement: {
      fieldToMatch: {
        allQueryArguments: allQueryArguments,
        body: {
          oversizeHandling: 'oversizeHandling',
        },
        cookies: {
          matchPattern: {
            all: all,
            excludedCookies: ['excludedCookies'],
            includedCookies: ['includedCookies'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        headers: {
          matchPattern: {
            all: all,
            excludedHeaders: ['excludedHeaders'],
            includedHeaders: ['includedHeaders'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        jsonBody: {
          matchPattern: {
            all: all,
            includedPaths: ['includedPaths'],
          },
          matchScope: 'matchScope',

          // the properties below are optional
          invalidFallbackBehavior: 'invalidFallbackBehavior',
          oversizeHandling: 'oversizeHandling',
        },
        method: method,
        queryString: queryString,
        singleHeader: singleHeader,
        singleQueryArgument: singleQueryArgument,
        uriPath: uriPath,
      },
      regexString: 'regexString',
      textTransformations: [{
        priority: 123,
        type: 'type',
      }],
    },
    regexPatternSetReferenceStatement: {
      arn: 'arn',
      fieldToMatch: {
        allQueryArguments: allQueryArguments,
        body: {
          oversizeHandling: 'oversizeHandling',
        },
        cookies: {
          matchPattern: {
            all: all,
            excludedCookies: ['excludedCookies'],
            includedCookies: ['includedCookies'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        headers: {
          matchPattern: {
            all: all,
            excludedHeaders: ['excludedHeaders'],
            includedHeaders: ['includedHeaders'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        jsonBody: {
          matchPattern: {
            all: all,
            includedPaths: ['includedPaths'],
          },
          matchScope: 'matchScope',

          // the properties below are optional
          invalidFallbackBehavior: 'invalidFallbackBehavior',
          oversizeHandling: 'oversizeHandling',
        },
        method: method,
        queryString: queryString,
        singleHeader: singleHeader,
        singleQueryArgument: singleQueryArgument,
        uriPath: uriPath,
      },
      textTransformations: [{
        priority: 123,
        type: 'type',
      }],
    },
    ruleGroupReferenceStatement: {
      arn: 'arn',

      // the properties below are optional
      excludedRules: [{
        name: 'name',
      }],
      ruleActionOverrides: [{
        actionToUse: {
          allow: {
            customRequestHandling: {
              insertHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
          block: {
            customResponse: {
              responseCode: 123,

              // the properties below are optional
              customResponseBodyKey: 'customResponseBodyKey',
              responseHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
          captcha: {
            customRequestHandling: {
              insertHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
          challenge: {
            customRequestHandling: {
              insertHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
          count: {
            customRequestHandling: {
              insertHeaders: [{
                name: 'name',
                value: 'value',
              }],
            },
          },
        },
        name: 'name',
      }],
    },
    sizeConstraintStatement: {
      comparisonOperator: 'comparisonOperator',
      fieldToMatch: {
        allQueryArguments: allQueryArguments,
        body: {
          oversizeHandling: 'oversizeHandling',
        },
        cookies: {
          matchPattern: {
            all: all,
            excludedCookies: ['excludedCookies'],
            includedCookies: ['includedCookies'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        headers: {
          matchPattern: {
            all: all,
            excludedHeaders: ['excludedHeaders'],
            includedHeaders: ['includedHeaders'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        jsonBody: {
          matchPattern: {
            all: all,
            includedPaths: ['includedPaths'],
          },
          matchScope: 'matchScope',

          // the properties below are optional
          invalidFallbackBehavior: 'invalidFallbackBehavior',
          oversizeHandling: 'oversizeHandling',
        },
        method: method,
        queryString: queryString,
        singleHeader: singleHeader,
        singleQueryArgument: singleQueryArgument,
        uriPath: uriPath,
      },
      size: 123,
      textTransformations: [{
        priority: 123,
        type: 'type',
      }],
    },
    sqliMatchStatement: {
      fieldToMatch: {
        allQueryArguments: allQueryArguments,
        body: {
          oversizeHandling: 'oversizeHandling',
        },
        cookies: {
          matchPattern: {
            all: all,
            excludedCookies: ['excludedCookies'],
            includedCookies: ['includedCookies'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        headers: {
          matchPattern: {
            all: all,
            excludedHeaders: ['excludedHeaders'],
            includedHeaders: ['includedHeaders'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        jsonBody: {
          matchPattern: {
            all: all,
            includedPaths: ['includedPaths'],
          },
          matchScope: 'matchScope',

          // the properties below are optional
          invalidFallbackBehavior: 'invalidFallbackBehavior',
          oversizeHandling: 'oversizeHandling',
        },
        method: method,
        queryString: queryString,
        singleHeader: singleHeader,
        singleQueryArgument: singleQueryArgument,
        uriPath: uriPath,
      },
      textTransformations: [{
        priority: 123,
        type: 'type',
      }],

      // the properties below are optional
      sensitivityLevel: 'sensitivityLevel',
    },
    xssMatchStatement: {
      fieldToMatch: {
        allQueryArguments: allQueryArguments,
        body: {
          oversizeHandling: 'oversizeHandling',
        },
        cookies: {
          matchPattern: {
            all: all,
            excludedCookies: ['excludedCookies'],
            includedCookies: ['includedCookies'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        headers: {
          matchPattern: {
            all: all,
            excludedHeaders: ['excludedHeaders'],
            includedHeaders: ['includedHeaders'],
          },
          matchScope: 'matchScope',
          oversizeHandling: 'oversizeHandling',
        },
        jsonBody: {
          matchPattern: {
            all: all,
            includedPaths: ['includedPaths'],
          },
          matchScope: 'matchScope',

          // the properties below are optional
          invalidFallbackBehavior: 'invalidFallbackBehavior',
          oversizeHandling: 'oversizeHandling',
        },
        method: method,
        queryString: queryString,
        singleHeader: singleHeader,
        singleQueryArgument: singleQueryArgument,
        uriPath: uriPath,
      },
      textTransformations: [{
        priority: 123,
        type: 'type',
      }],
    },
  },
};

Properties

Name	Type	Description
aggregateKeyType	string	Setting that indicates how to aggregate the request counts. The options are the following:.
limit	number	The limit on requests per 5-minute period for a single originating IP address.
forwardedIpConfig?	IResolvable | ForwardedIPConfigurationProperty	The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin.
scopeDownStatement?	IResolvable | StatementProperty	An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement.

---

aggregateKeyType

Type: string

Setting that indicates how to aggregate the request counts. The options are the following:.

• IP - Aggregate the request counts on the IP address from the web request origin.
• FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig , to specify the header to use.

You can only use the IP and FORWARDED_IP key types.

---

limit

Type: number

The limit on requests per 5-minute period for a single originating IP address.

If the statement includes a ScopeDownStatement , this limit is applied only to the requests that match the statement.

---

forwardedIpConfig?

Type: IResolvable | ForwardedIPConfigurationProperty (optional)

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin.

Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

This is required if you specify a forwarded IP in the rule's aggregate key settings.

---

scopeDownStatement?

Type: IResolvable | StatementProperty (optional)

An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement.

Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.