@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-wafv2-rulegroup.d.ts

@@ -0,0 +1,1496 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type WAFv2RuleGroup = ResourceDefinitionWithAttributes<"AWS::WAFv2::RuleGroup", WAFv2RuleGroupProps, WAFv2RuleGroupAttribs>;
+/**
+ * > This is the latest version of *AWS WAF* , named AWS WAF V2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the [AWS WAF developer guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) .
+ *
+ * Use an `RuleGroup` to define a collection of rules for inspecting and controlling web requests. You use a rule group in an `WebACL` by providing its Amazon Resource Name (ARN) to the rule statement `RuleGroupReferenceStatement` , when you add rules to the web ACL.
+ *
+ * When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
+ */
+export type WAFv2RuleGroupProps = {
+    /**
+     * The web ACL capacity units (WCUs) required for this rule group.
+     *
+     * When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit.
+     *
+     * AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
+     * @min 0
+     */
+    Capacity: number;
+    /**
+     * The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a `LabelMatchStatement` specification, in the `Statement` definition of a rule.
+     */
+    ConsumedLabels?: LabelSummary[] | undefined;
+    /**
+     * A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
+     *
+     * For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the *AWS WAF Developer Guide* .
+     *
+     * For information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the *AWS WAF Developer Guide* .
+     */
+    CustomResponseBodies?: Record<string, CustomResponseBody> | undefined;
+    /**
+     * A description of the rule group that helps with identification.
+     */
+    Description?: string | undefined;
+    /**
+     * The name of the rule group. You cannot change the name of a rule group after you create it.
+     */
+    Name?: string | undefined;
+    /**
+     * The rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
+     */
+    Rules?: Rule[] | undefined;
+    /**
+     * Specifies whether this is for an Amazon CloudFront distribution or for a regional application. For an AWS Amplify application, use `CLOUDFRONT` . A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are `CLOUDFRONT` and `REGIONAL` .
+     *
+     * > For `CLOUDFRONT` , you must create your WAFv2 resources in the US East (N. Virginia) Region, `us-east-1` .
+     */
+    Scope: Scope;
+    /**
+     * Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
+     *
+     * > To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * Defines and enables Amazon CloudWatch metrics and web request sample collection.
+     */
+    VisibilityConfig: VisibilityConfig;
+};
+export type WAFv2RuleGroupAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the rule group.
+     */
+    Arn: string;
+    /**
+     * The ID of the rule group.
+     */
+    Id: string;
+    /**
+     * The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
+     *
+     * The syntax for the label namespace prefix for a rule group is the following: `awswaf:<account ID>:rule group:<rule group name>:`
+     *
+     * When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon.
+     */
+    LabelNamespace: string;
+};
+/**
+ * Allow traffic towards application.
+ */
+export type AllowAction = {
+    CustomRequestHandling?: CustomRequestHandling | undefined;
+};
+/**
+ * A logical rule statement used to combine other rule statements with AND logic. You provide more than one `Statement` within the `AndStatement` .
+ */
+export type AndStatement = {
+    /**
+     * The statements to combine with AND logic. You can use any statements that can be nested.
+     */
+    Statements: Statement[];
+};
+/**
+ * Block traffic towards application.
+ */
+export type BlockAction = {
+    CustomResponse?: CustomResponse | undefined;
+};
+/**
+ * Inspect the body of the web request. The body immediately follows the request headers.
+ *
+ * This is used to indicate the web request component to inspect, in the `FieldToMatch` specification.
+ */
+export type Body = {
+    /**
+     * What AWS WAF should do if the body is larger than AWS WAF can inspect.
+     *
+     * AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
+     *
+     * - For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
+     * - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL `AssociationConfig` , for additional processing fees.
+     * - For AWS Amplify , use the CloudFront limit.
+     *
+     * The options for oversize handling are the following:
+     *
+     * - `CONTINUE` - Inspect the available body contents normally, according to the rule inspection criteria.
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     *
+     * You can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
+     *
+     * Default: `CONTINUE`
+     */
+    OversizeHandling?: OversizeHandling | undefined;
+};
+/**
+ * The inspection behavior to fall back to if the JSON in the request body is invalid.
+ */
+export type BodyParsingFallbackBehavior = "MATCH" | "NO_MATCH" | "EVALUATE_AS_STRING";
+/**
+ * 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 called a string match statement.
+ */
+export type ByteMatchStatement = {
+    /**
+     * The part of the web request that you want AWS WAF to inspect.
+     */
+    FieldToMatch: FieldToMatch;
+    /**
+     * The area within the portion of the web request that you want AWS WAF to search for `SearchString` . Valid values include the following:
+     *
+     * *CONTAINS*
+     *
+     * The specified part of the web request must include the value of `SearchString` , but the location doesn't matter.
+     *
+     * *CONTAINS_WORD*
+     *
+     * The specified part of the web request must include the value of `SearchString` , and `SearchString` must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, `SearchString` must be a word, which means that both of the following are true:
+     *
+     * - `SearchString` is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and `;BadBot` .
+     * - `SearchString` is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, `BadBot;` and `-BadBot;` .
+     *
+     * *EXACTLY*
+     *
+     * The value of the specified part of the web request must exactly match the value of `SearchString` .
+     *
+     * *STARTS_WITH*
+     *
+     * The value of `SearchString` must appear at the beginning of the specified part of the web request.
+     *
+     * *ENDS_WITH*
+     *
+     * The value of `SearchString` must appear at the end of the specified part of the web request.
+     */
+    PositionalConstraint: PositionalConstraint;
+    /**
+     * A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch` . The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.
+     *
+     * Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.
+     *
+     * For example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent` . If you want to search the `User-Agent` header for the value `BadBot` , you provide the string `BadBot` in the value of `SearchString` .
+     *
+     * You must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement` .
+     */
+    SearchString?: string | undefined;
+    /**
+     * String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in `SearchString` instead.
+     *
+     * You must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement` .
+     */
+    SearchStringBase64?: string | undefined;
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * Checks valid token exists with request.
+ */
+export type CaptchaAction = {
+    CustomRequestHandling?: CustomRequestHandling | undefined;
+};
+/**
+ * Specifies how AWS WAF should handle `CAPTCHA` evaluations. This is available at the web ACL level and in each rule.
+ */
+export type CaptchaConfig = {
+    /**
+     * Determines how long a `CAPTCHA` timestamp in the token remains valid after the client successfully solves a `CAPTCHA` puzzle.
+     */
+    ImmunityTimeProperty?: ImmunityTimeProperty | undefined;
+};
+/**
+ * Checks that the request has a valid token with an unexpired challenge timestamp and, if not, returns a browser challenge to the client.
+ */
+export type ChallengeAction = {
+    CustomRequestHandling?: CustomRequestHandling | undefined;
+};
+/**
+ * Specifies how AWS WAF should handle `Challenge` evaluations. This is available at the web ACL level and in each rule.
+ */
+export type ChallengeConfig = {
+    /**
+     * Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
+     */
+    ImmunityTimeProperty?: ImmunityTimeProperty | undefined;
+};
+/**
+ * The filter to use to identify the subset of cookies to inspect in a web request.
+ *
+ * You must specify exactly one setting: either `All` , `IncludedCookies` , or `ExcludedCookies` .
+ *
+ * Example JSON: `"MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }`
+ */
+export type CookieMatchPattern = {
+    /**
+     * Inspect all cookies.
+     */
+    All?: Record<string, unknown> | undefined;
+    /**
+     * Inspect only the cookies whose keys don't match any of the strings specified here.
+     */
+    ExcludedCookies?: string[] | undefined;
+    /**
+     * Inspect only the cookies that have a key that matches one of the strings specified here.
+     */
+    IncludedCookies?: string[] | undefined;
+};
+/**
+ * Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys.
+ *
+ * This is used to indicate the web request component to inspect, in the `FieldToMatch` specification.
+ *
+ * Example JSON: `"Cookies": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }`
+ */
+export type Cookies = {
+    /**
+     * The filter to use to identify the subset of cookies to inspect in a web request.
+     *
+     * You must specify exactly one setting: either `All` , `IncludedCookies` , or `ExcludedCookies` .
+     *
+     * Example JSON: `"MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }`
+     */
+    MatchPattern: CookieMatchPattern;
+    /**
+     * The parts of the cookies to inspect with the rule inspection criteria. If you specify `ALL` , AWS WAF inspects both keys and values.
+     *
+     * `All` does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical `AND` statement to combine two match rules, one that inspects the keys and another that inspects the values.
+     */
+    MatchScope: MapMatchScope;
+    /**
+     * What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF .
+     *
+     * The options for oversize handling are the following:
+     *
+     * - `CONTINUE` - Inspect the available cookies normally, according to the rule inspection criteria.
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     */
+    OversizeHandling: OversizeHandling;
+};
+/**
+ * Count traffic towards application.
+ */
+export type CountAction = {
+    CustomRequestHandling?: CustomRequestHandling | undefined;
+};
+/**
+ * A custom header for custom request and response handling. This is used in `CustomResponse` and `CustomRequestHandling`
+ */
+export type CustomHTTPHeader = {
+    /**
+     * The name of the custom header.
+     *
+     * For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name `x-amzn-waf-` , to avoid confusion with the headers that are already in the request. For example, for the header name `sample` , AWS WAF inserts the header `x-amzn-waf-sample` .
+     */
+    Name: string;
+    /**
+     * The value of the custom header.
+     */
+    Value: string;
+};
+/**
+ * Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for AWS WAF to use when the rule action doesn't block the request. For example, `CaptchaAction` for requests with valid t okens, and `AllowAction` .
+ *
+ * For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the *AWS WAF Developer Guide* .
+ */
+export type CustomRequestHandling = {
+    /**
+     * The HTTP headers to insert into the request. Duplicate header names are not allowed.
+     *
+     * For information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the *AWS WAF Developer Guide* .
+     */
+    InsertHeaders: CustomHTTPHeader[];
+};
+/**
+ * A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to `Block` .
+ *
+ * For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF developer guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) .
+ */
+export type CustomResponse = {
+    /**
+     * References the response body that you want AWS WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the `CustomResponseBodies` setting for the `WebACL` or `RuleGroup` where you want to use it. Then, in the rule action or web ACL default action `BlockAction` setting, you reference the response body using this key.
+     * @pattern ^[\w\-]+$
+     */
+    CustomResponseBodyKey?: string | undefined;
+    /**
+     * The HTTP status code to return to the client.
+     *
+     * For a list of status codes that you can use in your custom responses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the *AWS WAF Developer Guide* .
+     */
+    ResponseCode: number;
+    /**
+     * The HTTP headers to use in the response. You can specify any header name except for `content-type` . Duplicate header names are not allowed.
+     *
+     * For information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the *AWS WAF Developer Guide* .
+     */
+    ResponseHeaders?: CustomHTTPHeader[] | undefined;
+};
+/**
+ * The response body to use in a custom response to a web request. This is referenced by key from `CustomResponse` `CustomResponseBodyKey` .
+ */
+export type CustomResponseBody = {
+    /**
+     * The payload of the custom response.
+     *
+     * You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the `ContentType` setting.
+     *
+     * For information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the *AWS WAF Developer Guide* .
+     */
+    Content: string;
+    /**
+     * The type of content in the payload that you are defining in the `Content` string.
+     */
+    ContentType: ResponseContentType;
+};
+export type EvaluationWindowSec = 60 | 120 | 300 | 600;
+/**
+ * Specifies a web request component to be used in a rule match statement or in a logging configuration.
+ *
+ * - In a rule statement, this is the part of the web request that you want AWS WAF to inspect. Include the single `FieldToMatch` type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in `FieldToMatch` for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.
+ *
+ * Example JSON for a `QueryString` field to match:
+ *
+ * `"FieldToMatch": { "QueryString": {} }`
+ *
+ * Example JSON for a `Method` field to match specification:
+ *
+ * `"FieldToMatch": { "Method": { "Name": "DELETE" } }`
+ * - In a logging configuration, this is used in the `RedactedFields` property to specify a field to redact from the logging records. For this use case, note the following:
+ *
+ * - Even though all `FieldToMatch` settings are available, the only valid settings for field redaction are `UriPath` , `QueryString` , `SingleHeader` , and `Method` .
+ * - In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, but for field redaction, you are specifying the component type to redact from the logs.
+ * - If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.
+ */
+export type FieldToMatch = {
+    /**
+     * Inspect all query arguments.
+     */
+    AllQueryArguments?: Record<string, unknown> | undefined;
+    /**
+     * Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
+     *
+     * AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
+     *
+     * - For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
+     * - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL `AssociationConfig` , for additional processing fees.
+     * - For AWS Amplify , use the CloudFront limit.
+     *
+     * For information about how to handle oversized request bodies, see the `Body` object configuration.
+     */
+    Body?: Body | undefined;
+    /**
+     * Inspect the request cookies. You must configure scope and pattern matching filters in the `Cookies` object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.
+     *
+     * Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the `Cookies` object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.
+     */
+    Cookies?: Cookies | undefined;
+    /**
+     * Inspect the request headers. You must configure scope and pattern matching filters in the `Headers` object, to define the set of headers to and the parts of the headers that AWS WAF inspects.
+     *
+     * Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the `Headers` object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.
+     */
+    Headers?: Headers | undefined;
+    /**
+     * Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
+     *
+     * > You can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to `EXACTLY` .
+     *
+     * You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide* .
+     *
+     * Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
+     */
+    JA3Fingerprint?: JA3Fingerprint | undefined;
+    /**
+     * Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
+     *
+     * > You can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to `EXACTLY` .
+     *
+     * You can obtain the JA4 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide* .
+     *
+     * Provide the JA4 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
+     */
+    JA4Fingerprint?: JA4Fingerprint | undefined;
+    /**
+     * Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
+     *
+     * AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
+     *
+     * - For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
+     * - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL `AssociationConfig` , for additional processing fees.
+     * - For AWS Amplify , use the CloudFront limit.
+     *
+     * For information about how to handle oversized request bodies, see the `JsonBody` object configuration.
+     */
+    JsonBody?: JsonBody | undefined;
+    /**
+     * Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
+     */
+    Method?: Record<string, unknown> | undefined;
+    /**
+     * Inspect the query string. This is the part of a URL that appears after a `?` character, if any.
+     */
+    QueryString?: Record<string, unknown> | undefined;
+    /**
+     * Inspect a single header. Provide the name of the header to inspect, for example, `User-Agent` or `Referer` . This setting isn't case sensitive.
+     *
+     * Example JSON: `"SingleHeader": { "Name": "haystack" }`
+     *
+     * Alternately, you can filter and inspect all headers with the `Headers` `FieldToMatch` setting.
+     */
+    SingleHeader?: {
+        Name: string;
+    } | undefined;
+    /**
+     * Inspect a single query argument. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion* . The name can be up to 30 characters long and isn't case sensitive.
+     *
+     * Example JSON: `"SingleQueryArgument": { "Name": "myArgument" }`
+     */
+    SingleQueryArgument?: {
+        Name: string;
+    } | undefined;
+    /**
+     * Inspect fragments of the request URI. You must configure scope and pattern matching filters in the `UriFragment` object, to define the fragment of a URI that AWS WAF inspects.
+     *
+     * Only the first 8 KB (8192 bytes) of a request's URI fragments and only the first 200 URI fragments are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize URI fragment content in the `UriFragment` object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.
+     */
+    UriFragment?: UriFragment | undefined;
+    /**
+     * Inspect the request URI path. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg` .
+     */
+    UriPath?: Record<string, unknown> | undefined;
+};
+/**
+ * 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 configuration is used for `GeoMatchStatement` and `RateBasedStatement` . For `IPSetReferenceStatement` , use `IPSetForwardedIPConfig` instead.
+ *
+ * AWS WAF only evaluates the first IP address found in the specified HTTP header.
+ */
+export type ForwardedIPConfiguration = {
+    /**
+     * The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
+     *
+     * > If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
+     *
+     * You can specify the following fallback behaviors:
+     *
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     */
+    FallbackBehavior: "MATCH" | "NO_MATCH";
+    /**
+     * The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to `X-Forwarded-For` .
+     *
+     * > If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
+     * @pattern ^[a-zA-Z0-9-]+{1,255}$
+     */
+    HeaderName: string;
+};
+/**
+ * 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.
+ *
+ * AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) .
+ */
+export type GeoMatchStatement = {
+    /**
+     * An array of two-character country codes that you want to match against, for example, `[ "US", "CN" ]` , from the alpha-2 country ISO codes of the ISO 3166 international standard.
+     *
+     * When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
+     */
+    CountryCodes?: string[] | undefined;
+    /**
+     * 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.
+     */
+    ForwardedIPConfig?: ForwardedIPConfiguration | undefined;
+};
+/**
+ * The filter to use to identify the subset of headers to inspect in a web request.
+ *
+ * You must specify exactly one setting: either `All` , `IncludedHeaders` , or `ExcludedHeaders` .
+ *
+ * Example JSON: `"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }`
+ */
+export type HeaderMatchPattern = {
+    /**
+     * Inspect all headers.
+     */
+    All?: Record<string, unknown> | undefined;
+    /**
+     * Inspect only the headers whose keys don't match any of the strings specified here.
+     */
+    ExcludedHeaders?: string[] | undefined;
+    /**
+     * Inspect only the headers that have a key that matches one of the strings specified here.
+     */
+    IncludedHeaders?: string[] | undefined;
+};
+/**
+ * Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.
+ *
+ * This is used to indicate the web request component to inspect, in the `FieldToMatch` specification.
+ *
+ * If you want to inspect just the value of a single header, use the `SingleHeader` `FieldToMatch` setting instead.
+ *
+ * Example JSON: `"Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }`
+ */
+export type Headers = {
+    /**
+     * The filter to use to identify the subset of headers to inspect in a web request.
+     *
+     * You must specify exactly one setting: either `All` , `IncludedHeaders` , or `ExcludedHeaders` .
+     *
+     * Example JSON: `"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }`
+     */
+    MatchPattern: HeaderMatchPattern;
+    /**
+     * The parts of the headers to match with the rule inspection criteria. If you specify `ALL` , AWS WAF inspects both keys and values.
+     *
+     * `All` does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical `AND` statement to combine two match rules, one that inspects the keys and another that inspects the values.
+     */
+    MatchScope: MapMatchScope;
+    /**
+     * What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF .
+     *
+     * The options for oversize handling are the following:
+     *
+     * - `CONTINUE` - Inspect the available headers normally, according to the rule inspection criteria.
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     */
+    OversizeHandling: OversizeHandling;
+};
+/**
+ * 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 configuration is used only for `IPSetReferenceStatement` . For `GeoMatchStatement` and `RateBasedStatement` , use `ForwardedIPConfig` instead.
+ */
+export type IPSetForwardedIPConfiguration = {
+    /**
+     * The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
+     *
+     * > If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
+     *
+     * You can specify the following fallback behaviors:
+     *
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     */
+    FallbackBehavior: "MATCH" | "NO_MATCH";
+    /**
+     * The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to `X-Forwarded-For` .
+     *
+     * > If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
+     * @pattern ^[a-zA-Z0-9-]+{1,255}$
+     */
+    HeaderName: string;
+    /**
+     * The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be `10.1.1.1, 127.0.0.0, 10.10.10.10` where the first IP address identifies the original client and the rest identify proxies that the request went through.
+     *
+     * The options for this setting are the following:
+     *
+     * - FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
+     * - LAST - Inspect the last IP address in the list of IP addresses in the header.
+     * - ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.
+     */
+    Position: "FIRST" | "LAST" | "ANY";
+};
+/**
+ * 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.
+ *
+ * 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.
+ */
+export type IPSetReferenceStatement = {
+    /**
+     * The Amazon Resource Name (ARN) of the `IPSet` that this statement references.
+     */
+    Arn: string;
+    /**
+     * 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.
+     */
+    IPSetForwardedIPConfig?: IPSetForwardedIPConfiguration | undefined;
+};
+/**
+ * Used for CAPTCHA and challenge token settings. Determines how long a `CAPTCHA` or challenge timestamp remains valid after AWS WAF updates it for a successful `CAPTCHA` or challenge response.
+ */
+export type ImmunityTimeProperty = {
+    /**
+     * The amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF . The default setting is 300.
+     *
+     * For the Challenge action, the minimum setting is 300.
+     * @min 60
+     * @max 259200
+     */
+    ImmunityTime: number;
+};
+/**
+ * Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
+ *
+ * > You can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to `EXACTLY` .
+ *
+ * You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide* .
+ *
+ * Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
+ */
+export type JA3Fingerprint = {
+    /**
+     * The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
+     *
+     * You can specify the following fallback behaviors:
+     *
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     */
+    FallbackBehavior: "MATCH" | "NO_MATCH";
+};
+/**
+ * Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
+ *
+ * > You can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to `EXACTLY` .
+ *
+ * You can obtain the JA4 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the *AWS WAF Developer Guide* .
+ *
+ * Provide the JA4 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
+ */
+export type JA4Fingerprint = {
+    /**
+     * The match status to assign to the web request if the request doesn't have a JA4 fingerprint.
+     *
+     * You can specify the following fallback behaviors:
+     *
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     */
+    FallbackBehavior: "MATCH" | "NO_MATCH";
+};
+/**
+ * Inspect the body of the web request as JSON. The body immediately follows the request headers.
+ *
+ * This is used to indicate the web request component to inspect, in the `FieldToMatch` specification.
+ *
+ * Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. AWS WAF inspects only the parts of the JSON that result from the matches that you indicate.
+ *
+ * Example JSON: `"JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" }`
+ *
+ * For additional information about this request component option, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body) in the *AWS WAF Developer Guide* .
+ */
+export type JsonBody = {
+    /**
+     * What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:
+     *
+     * - `EVALUATE_AS_STRING` - Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     *
+     * If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
+     *
+     * > AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body) in the *AWS WAF Developer Guide* .
+     */
+    InvalidFallbackBehavior?: BodyParsingFallbackBehavior | undefined;
+    /**
+     * The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
+     */
+    MatchPattern: JsonMatchPattern;
+    /**
+     * The parts of the JSON to match against using the `MatchPattern` . If you specify `ALL` , AWS WAF matches against keys and values.
+     *
+     * `All` does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical `AND` statement to combine two match rules, one that inspects the keys and another that inspects the values.
+     */
+    MatchScope: JsonMatchScope;
+    /**
+     * What AWS WAF should do if the body is larger than AWS WAF can inspect.
+     *
+     * AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
+     *
+     * - For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
+     * - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL `AssociationConfig` , for additional processing fees.
+     * - For AWS Amplify , use the CloudFront limit.
+     *
+     * The options for oversize handling are the following:
+     *
+     * - `CONTINUE` - Inspect the available body contents normally, according to the rule inspection criteria.
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     *
+     * You can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
+     *
+     * Default: `CONTINUE`
+     */
+    OversizeHandling?: OversizeHandling | undefined;
+};
+/**
+ * The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the `FieldToMatch` option `JsonBody` .
+ */
+export type JsonMatchPattern = {
+    /**
+     * Match all of the elements. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification.
+     *
+     * You must specify either this setting or the `IncludedPaths` setting, but not both.
+     */
+    All?: Record<string, unknown> | undefined;
+    /**
+     * Match only the specified include paths. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification.
+     *
+     * Provide the include paths using JSON Pointer syntax. For example, `"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]` . For information about this syntax, see the Internet Engineering Task Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6901) .
+     *
+     * You must specify either this setting or the `All` setting, but not both.
+     *
+     * > Don't use this option to include all paths. Instead, use the `All` setting.
+     */
+    IncludedPaths?: string[] | undefined;
+};
+/**
+ * The parts of the JSON to match against using the MatchPattern.
+ */
+export type JsonMatchScope = "ALL" | "KEY" | "VALUE";
+/**
+ * A single label container. This is used as an element of a label array in `RuleLabels` inside a rule.
+ */
+export type Label = {
+    /**
+     * The label string.
+     */
+    Name: string;
+};
+export type LabelMatchScope = "LABEL" | "NAMESPACE";
+/**
+ * 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, AWS WAF performs the search for labels that were added in the same context as the label match statement.
+ */
+export type LabelMatchStatement = {
+    /**
+     * The string to match against. The setting you provide for this depends on the match statement's `Scope` setting:
+     *
+     * - If the `Scope` indicates `LABEL` , then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.
+     * - If the `Scope` indicates `NAMESPACE` , then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
+     *
+     * Labels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name` .
+     */
+    Key: string;
+    /**
+     * Specify whether you want to match using the label name or just the namespace.
+     */
+    Scope: LabelMatchScope;
+};
+/**
+ * List of labels used by one or more of the rules of a `RuleGroup` . This summary object is used for the following rule group lists:
+ *
+ * - `AvailableLabels` - Labels that rules add to matching requests. These labels are defined in the `RuleLabels` for a rule.
+ * - `ConsumedLabels` - Labels that rules match against. These labels are defined in a `LabelMatchStatement` specification, in the `Statement` definition of a rule.
+ */
+export type LabelSummary = {
+    /**
+     * An individual label specification.
+     */
+    Name?: string | undefined;
+};
+/**
+ * The parts of the request to match against using the MatchPattern.
+ */
+export type MapMatchScope = "ALL" | "KEY" | "VALUE";
+/**
+ * A logical rule statement used to negate the results of another rule statement. You provide one `Statement` within the `NotStatement` .
+ */
+export type NotStatement = {
+    /**
+     * The statement to negate. You can use any statement that can be nested.
+     */
+    Statement: Statement;
+};
+/**
+ * A logical rule statement used to combine other rule statements with OR logic. You provide more than one `Statement` within the `OrStatement` .
+ */
+export type OrStatement = {
+    /**
+     * The statements to combine with OR logic. You can use any statements that can be nested.
+     */
+    Statements: Statement[];
+};
+/**
+ * Handling of requests containing oversize fields
+ */
+export type OversizeHandling = "CONTINUE" | "MATCH" | "NO_MATCH";
+/**
+ * Position of the evaluation in the FieldToMatch of request.
+ */
+export type PositionalConstraint = "EXACTLY" | "STARTS_WITH" | "ENDS_WITH" | "CONTAINS" | "CONTAINS_WORD";
+/**
+ * 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 AWS 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 AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html) in the *AWS 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 AWS WAF is currently rate limiting for a rule through the API call `GetRateBasedStatementManagedKeys` . This option is not available for other aggregation configurations.
+ *
+ * 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 .
+ */
+export type RateBasedStatement = {
+    /**
+     * Setting that indicates how to aggregate the request counts.
+     *
+     * > Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
+     *
+     * - `CONSTANT` - Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement.
+     *
+     * With this option, you must configure the `ScopeDownStatement` property.
+     * - `CUSTOM_KEYS` - Aggregate the request counts using one or more web request components as the aggregate keys.
+     *
+     * With this option, you must specify the aggregate keys in the `CustomKeys` property.
+     *
+     * To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to `IP` or `FORWARDED_IP` .
+     * - `FORWARDED_IP` - Aggregate the request counts on the first IP address in an HTTP header.
+     *
+     * With this option, you must specify the header to use in the `ForwardedIPConfig` property.
+     *
+     * To aggregate on a combination of the forwarded IP address with other aggregate keys, use `CUSTOM_KEYS` .
+     * - `IP` - Aggregate the request counts on the IP address from the web request origin.
+     *
+     * To aggregate on a combination of the IP address with other aggregate keys, use `CUSTOM_KEYS` .
+     */
+    AggregateKeyType: "IP" | "FORWARDED_IP" | "CONSTANT" | "CUSTOM_KEYS";
+    /**
+     * Specifies the aggregate keys to use in a rate-base rule.
+     */
+    CustomKeys?: RateBasedStatementCustomKey[] | undefined;
+    /**
+     * The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.
+     *
+     * This setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate about every 10 seconds.
+     *
+     * Default: `300` (5 minutes)
+     */
+    EvaluationWindowSec?: EvaluationWindowSec | undefined;
+    /**
+     * 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.
+     */
+    ForwardedIPConfig?: ForwardedIPConfiguration | undefined;
+    /**
+     * The limit on requests during the specified evaluation window for a single aggregation instance for the rate-based rule. If the rate-based statement includes a `ScopeDownStatement` , this limit is applied only to the requests that match the statement.
+     *
+     * Examples:
+     *
+     * - If you aggregate on just the IP address, this is the limit on requests from any single IP address.
+     * - If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.
+     */
+    Limit: number;
+    /**
+     * An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that 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.
+     */
+    ScopeDownStatement?: Statement | undefined;
+};
+/**
+ * Specifies a single custom aggregate key for a rate-base rule.
+ *
+ * > Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
+ */
+export type RateBasedStatementCustomKey = {
+    /**
+     * Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
+     */
+    Cookie?: RateLimitCookie | undefined;
+    /**
+     * Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.
+     *
+     * When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying `FORWARDED_IP` in your rate-based statement's `AggregateKeyType` .
+     *
+     * With this option, you must specify the header to use in the rate-based rule's `ForwardedIPConfig` property.
+     */
+    ForwardedIP?: Record<string, unknown> | undefined;
+    /**
+     * Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
+     */
+    HTTPMethod?: Record<string, unknown> | undefined;
+    /**
+     * Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
+     */
+    Header?: RateLimitHeader | undefined;
+    /**
+     * Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.
+     *
+     * When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying `IP` in your rate-based statement's `AggregateKeyType` .
+     */
+    IP?: Record<string, unknown> | undefined;
+    /**
+     * Use the request's JA3 fingerprint as an aggregate key. If you use a single JA3 fingerprint as your custom key, then each value fully defines an aggregation instance.
+     */
+    JA3Fingerprint?: RateLimitJA3Fingerprint | undefined;
+    /**
+     * Use the request's JA4 fingerprint as an aggregate key. If you use a single JA4 fingerprint as your custom key, then each value fully defines an aggregation instance.
+     */
+    JA4Fingerprint?: RateLimitJA4Fingerprint | undefined;
+    /**
+     * Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
+     *
+     * This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
+     *
+     * For information about label namespaces and names, see [Label syntax and naming requirements](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) in the *AWS WAF Developer Guide* .
+     */
+    LabelNamespace?: RateLimitLabelNamespace | undefined;
+    /**
+     * Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
+     */
+    QueryArgument?: RateLimitQueryArgument | undefined;
+    /**
+     * Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
+     */
+    QueryString?: RateLimitQueryString | undefined;
+    /**
+     * Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
+     */
+    UriPath?: RateLimitUriPath | undefined;
+};
+/**
+ * Specifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
+ */
+export type RateLimitCookie = {
+    /**
+     * The name of the cookie to use.
+     * @minLength 1
+     * @maxLength 64
+     * @pattern .*\S.*
+     */
+    Name: string;
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
+ */
+export type RateLimitHeader = {
+    /**
+     * The name of the header to use.
+     * @minLength 1
+     * @maxLength 64
+     * @pattern .*\S.*
+     */
+    Name: string;
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * Use the request's JA3 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single JA3 fingerprint as your custom key, then each value fully defines an aggregation instance.
+ */
+export type RateLimitJA3Fingerprint = {
+    /**
+     * The match status to assign to the web request if there is insufficient TSL Client Hello information to compute the JA3 fingerprint.
+     *
+     * You can specify the following fallback behaviors:
+     *
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     */
+    FallbackBehavior: "MATCH" | "NO_MATCH";
+};
+/**
+ * Use the request's JA4 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single JA4 fingerprint as your custom key, then each value fully defines an aggregation instance.
+ */
+export type RateLimitJA4Fingerprint = {
+    /**
+     * The match status to assign to the web request if there is insufficient TSL Client Hello information to compute the JA4 fingerprint.
+     *
+     * You can specify the following fallback behaviors:
+     *
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     */
+    FallbackBehavior: "MATCH" | "NO_MATCH";
+};
+/**
+ * Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
+ *
+ * This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
+ *
+ * For information about label namespaces and names, see [Label syntax and naming requirements](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) in the *AWS WAF Developer Guide* .
+ */
+export type RateLimitLabelNamespace = {
+    /**
+     * The namespace to use for aggregation.
+     * @pattern ^[0-9A-Za-z_:-]{1,1024}$
+     */
+    Namespace: string;
+};
+/**
+ * Specifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
+ */
+export type RateLimitQueryArgument = {
+    /**
+     * The name of the query argument to use.
+     * @minLength 1
+     * @maxLength 64
+     * @pattern .*\S.*
+     */
+    Name: string;
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * Specifies the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
+ */
+export type RateLimitQueryString = {
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * Specifies the request's URI path as an aggregate key for a rate-based rule. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
+ */
+export type RateLimitUriPath = {
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the `FieldToMatch` request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * A rule statement used to search web request components for a match against a single regular expression.
+ */
+export type RegexMatchStatement = {
+    /**
+     * The part of the web request that you want AWS WAF to inspect.
+     */
+    FieldToMatch: FieldToMatch;
+    /**
+     * The string representing the regular expression.
+     * @minLength 1
+     * @maxLength 512
+     */
+    RegexString: string;
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * 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.
+ *
+ * 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.
+ */
+export type RegexPatternSetReferenceStatement = {
+    /**
+     * The Amazon Resource Name (ARN) of the `RegexPatternSet` that this statement references.
+     */
+    Arn: string;
+    /**
+     * The part of the web request that you want AWS WAF to inspect.
+     */
+    FieldToMatch: FieldToMatch;
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * Valid values are TEXT_PLAIN, TEXT_HTML, and APPLICATION_JSON.
+ */
+export type ResponseContentType = "TEXT_PLAIN" | "TEXT_HTML" | "APPLICATION_JSON";
+/**
+ * A single rule, which you can use in a `WebACL` or `RuleGroup` to identify web requests that you want to manage in some way. Each rule includes one top-level `Statement` that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
+ */
+export type Rule = {
+    /**
+     * The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
+     */
+    Action?: RuleAction | undefined;
+    /**
+     * Specifies how AWS WAF should handle `CAPTCHA` evaluations. If you don't specify this, AWS WAF uses the `CAPTCHA` configuration that's defined for the web ACL.
+     */
+    CaptchaConfig?: CaptchaConfig | undefined;
+    /**
+     * Specifies how AWS WAF should handle `Challenge` evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL.
+     */
+    ChallengeConfig?: ChallengeConfig | undefined;
+    /**
+     * The name of the rule.
+     *
+     * If you change the name of a `Rule` after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule's `VisibilityConfig` settings. AWS WAF doesn't automatically update the metric name when you update the rule name.
+     */
+    Name: string;
+    /**
+     * If you define more than one `Rule` in a `WebACL` , AWS WAF evaluates each request against the `Rules` in order based on the value of `Priority` . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
+     */
+    Priority: number;
+    /**
+     * Labels to apply to web requests that match the rule match statement. AWS WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
+     *
+     * > Any rule that isn't a rule group reference statement or managed rule group statement can add labels to matching web requests.
+     *
+     * Rules that run after this rule in the web ACL can match against these labels using a `LabelMatchStatement` .
+     *
+     * For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
+     *
+     * - Separate each component of the label with a colon.
+     * - Each namespace or name can have up to 128 characters.
+     * - You can specify up to 5 namespaces in a label.
+     * - Don't use the following reserved words in your label specification: `aws` , `waf` , `managed` , `rulegroup` , `webacl` , `regexpatternset` , or `ipset` .
+     *
+     * For example, `myLabelName` or `nameSpace1:nameSpace2:myLabelName` .
+     */
+    RuleLabels?: Label[] | undefined;
+    /**
+     * The AWS WAF processing statement for the rule, for example `ByteMatchStatement` or `SizeConstraintStatement` .
+     */
+    Statement: Statement;
+    /**
+     * Defines and enables Amazon CloudWatch metrics and web request sample collection.
+     *
+     * If you change the name of a `Rule` after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.
+     */
+    VisibilityConfig: VisibilityConfig;
+};
+/**
+ * The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
+ */
+export type RuleAction = {
+    /**
+     * Instructs AWS WAF to allow the web request.
+     */
+    Allow?: AllowAction | undefined;
+    /**
+     * Instructs AWS WAF to block the web request.
+     */
+    Block?: BlockAction | undefined;
+    /**
+     * Specifies that AWS WAF should run a `CAPTCHA` check against the request:
+     *
+     * - If the request includes a valid, unexpired `CAPTCHA` token, AWS WAF allows the web request inspection to proceed to the next rule, similar to a `CountAction` .
+     * - If the request doesn't include a valid, unexpired `CAPTCHA` token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
+     *
+     * AWS WAF generates a response that it sends back to the client, which includes the following:
+     *
+     * - The header `x-amzn-waf-action` with a value of `captcha` .
+     * - The HTTP status code `405 Method Not Allowed` .
+     * - If the request contains an `Accept` header with a value of `text/html` , the response includes a `CAPTCHA` challenge.
+     *
+     * You can configure the expiration time in the `CaptchaConfig` `ImmunityTimeProperty` setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
+     *
+     * This action option is available for rules. It isn't available for web ACL default actions.
+     */
+    Captcha?: CaptchaAction | undefined;
+    /**
+     * Instructs AWS WAF to run a `Challenge` check against the web request.
+     */
+    Challenge?: ChallengeAction | undefined;
+    /**
+     * Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
+     */
+    Count?: CountAction | undefined;
+};
+/**
+ * Use CLOUDFRONT for CloudFront RuleGroup, use REGIONAL for Application Load Balancer and API Gateway.
+ */
+export type Scope = "CLOUDFRONT" | "REGIONAL";
+/**
+ * Sensitivity Level current only used for sqli match statements.
+ */
+export type SensitivityLevel = "LOW" | "HIGH";
+/**
+ * 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 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.
+ */
+export type SizeConstraintStatement = {
+    /**
+     * The operator to use to compare the request part to the size setting.
+     */
+    ComparisonOperator: "EQ" | "NE" | "LE" | "LT" | "GE" | "GT";
+    /**
+     * The part of the web request that you want AWS WAF to inspect.
+     */
+    FieldToMatch: FieldToMatch;
+    /**
+     * The size, in byte, to compare to the request part, after any transformations.
+     * @min 0
+     * @max 21474836480
+     */
+    Size: number;
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * 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.
+ */
+export type SqliMatchStatement = {
+    /**
+     * The part of the web request that you want AWS WAF to inspect.
+     */
+    FieldToMatch: FieldToMatch;
+    /**
+     * The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks.
+     *
+     * `HIGH` detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see [Testing and tuning](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the *AWS WAF Developer Guide* .
+     *
+     * `LOW` is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.
+     *
+     * Default: `LOW`
+     */
+    SensitivityLevel?: SensitivityLevel | undefined;
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match.
+     */
+    TextTransformations: TextTransformation[];
+};
+/**
+ * The processing guidance for a rule, used by AWS WAF to determine whether a web request matches the rule.
+ */
+export type Statement = {
+    /**
+     * A logical rule statement used to combine other rule statements with AND logic. You provide more than one `Statement` within the `AndStatement` .
+     */
+    AndStatement?: AndStatement | undefined;
+    /**
+     * 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 called a string match statement.
+     */
+    ByteMatchStatement?: ByteMatchStatement | undefined;
+    /**
+     * 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.
+     *
+     * AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) .
+     */
+    GeoMatchStatement?: GeoMatchStatement | undefined;
+    /**
+     * 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.
+     *
+     * 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.
+     */
+    IPSetReferenceStatement?: IPSetReferenceStatement | undefined;
+    /**
+     * 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, AWS WAF performs the search for labels that were added in the same context as the label match statement.
+     */
+    LabelMatchStatement?: LabelMatchStatement | undefined;
+    /**
+     * A logical rule statement used to negate the results of another rule statement. You provide one `Statement` within the `NotStatement` .
+     */
+    NotStatement?: NotStatement | undefined;
+    /**
+     * A logical rule statement used to combine other rule statements with OR logic. You provide more than one `Statement` within the `OrStatement` .
+     */
+    OrStatement?: OrStatement | undefined;
+    /**
+     * 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 AWS 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 AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html) in the *AWS 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 AWS WAF is currently rate limiting for a rule through the API call `GetRateBasedStatementManagedKeys` . This option is not available for other aggregation configurations.
+     *
+     * 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 .
+     */
+    RateBasedStatement?: RateBasedStatement | undefined;
+    /**
+     * A rule statement used to search web request components for a match against a single regular expression.
+     */
+    RegexMatchStatement?: RegexMatchStatement | undefined;
+    /**
+     * 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.
+     *
+     * 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.
+     */
+    RegexPatternSetReferenceStatement?: RegexPatternSetReferenceStatement | undefined;
+    /**
+     * 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 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.
+     */
+    SizeConstraintStatement?: SizeConstraintStatement | undefined;
+    /**
+     * 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.
+     */
+    SqliMatchStatement?: SqliMatchStatement | undefined;
+    /**
+     * 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.
+     */
+    XssMatchStatement?: XssMatchStatement | undefined;
+};
+/**
+ * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
+ */
+export type TextTransformation = {
+    /**
+     * Sets the relative processing order for multiple transformations. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
+     */
+    Priority: number;
+    /**
+     * For detailed descriptions of each of the transformation types, see [Text transformations](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-transformation.html) in the *AWS WAF Developer Guide* .
+     */
+    Type: TextTransformationType;
+};
+/**
+ * Type of text transformation.
+ */
+export type TextTransformationType = "NONE" | "COMPRESS_WHITE_SPACE" | "HTML_ENTITY_DECODE" | "LOWERCASE" | "CMD_LINE" | "URL_DECODE" | "BASE64_DECODE" | "HEX_DECODE" | "MD5" | "REPLACE_COMMENTS" | "ESCAPE_SEQ_DECODE" | "SQL_HEX_DECODE" | "CSS_DECODE" | "JS_DECODE" | "NORMALIZE_PATH" | "NORMALIZE_PATH_WIN" | "REMOVE_NULLS" | "REPLACE_NULLS" | "BASE64_DECODE_EXT" | "URL_DECODE_UNI" | "UTF8_TO_UNICODE";
+/**
+ * Inspect fragments of the request URI. You can specify the parts of the URI fragment to inspect and you can narrow the set of URI fragments to inspect by including or excluding specific keys.
+ *
+ * This is used to indicate the web request component to inspect, in the `FieldToMatch` specification.
+ *
+ * Example JSON: `"UriFragment": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }`
+ */
+export type UriFragment = {
+    /**
+     * What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:
+     *
+     * - `EVALUATE_AS_STRING` - Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
+     * - `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+     * - `NO_MATCH` - Treat the web request as not matching the rule statement.
+     *
+     * If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
+     *
+     * Example JSON: `{ "UriFragment": { "FallbackBehavior": "MATCH"} }`
+     *
+     * > AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body) in the *AWS WAF Developer Guide* .
+     */
+    FallbackBehavior?: "MATCH" | "NO_MATCH" | undefined;
+};
+/**
+ * Defines and enables Amazon CloudWatch metrics and web request sample collection.
+ */
+export type VisibilityConfig = {
+    /**
+     * Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see [AWS WAF Metrics](https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics) in the *AWS WAF Developer Guide* .
+     *
+     * For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information,
+     * see [The web ACL default action](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html) in the *AWS WAF Developer Guide* .
+     */
+    CloudWatchMetricsEnabled: boolean;
+    /**
+     * A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF , for example `All` and `Default_Action` .
+     * @minLength 1
+     * @maxLength 128
+     */
+    MetricName: string;
+    /**
+     * Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
+     *
+     * If you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data.
+     *
+     * > Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.
+     */
+    SampledRequestsEnabled: boolean;
+};
+/**
+ * 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.
+ */
+export type XssMatchStatement = {
+    /**
+     * The part of the web request that you want AWS WAF to inspect.
+     */
+    FieldToMatch: FieldToMatch;
+    /**
+     * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match.
+     */
+    TextTransformations: TextTransformation[];
+};
+//# sourceMappingURL=aws-wafv2-rulegroup.d.ts.map