Class: AWS.WAFV2

var params = {
  Rules: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      Statement: { /* Statement */ /* required */
        AndStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        ByteMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          PositionalConstraint: EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD, /* required */
          SearchString: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        },
        GeoMatchStatement: {
          CountryCodes: [
            AF | AX | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BQ | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CD | CK | CR | CI | HR | CU | CW | CY | CZ | DK | DJ | DM | DO | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | JM | JP | JE | JO | KZ | KE | KI | KP | KR | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | NC | NZ | NI | NE | NG | NU | NF | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | BL | SH | KN | LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK | SI | SB | SO | ZA | GS | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW | TJ | TZ | TH | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | GB | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | ZM | ZW | XK,
            /* more items */
          ],
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          }
        },
        IPSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          IPSetForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE', /* required */
            Position: FIRST | LAST | ANY /* required */
          }
        },
        LabelMatchStatement: {
          Key: 'STRING_VALUE', /* required */
          Scope: LABEL | NAMESPACE /* required */
        },
        ManagedRuleGroupStatement: {
          Name: 'STRING_VALUE', /* required */
          VendorName: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          ManagedRuleGroupConfigs: [
            {
              AWSManagedRulesATPRuleSet: {
                LoginPath: 'STRING_VALUE', /* required */
                RequestInspection: {
                  PasswordField: { /* required */
                    Identifier: 'STRING_VALUE' /* required */
                  },
                  PayloadType: JSON | FORM_ENCODED, /* required */
                  UsernameField: { /* required */
                    Identifier: 'STRING_VALUE' /* required */
                  }
                },
                ResponseInspection: {
                  BodyContains: {
                    FailureStrings: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ],
                    SuccessStrings: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ]
                  },
                  Header: {
                    FailureValues: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ],
                    Name: 'STRING_VALUE', /* required */
                    SuccessValues: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ]
                  },
                  Json: {
                    FailureValues: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ],
                    Identifier: 'STRING_VALUE', /* required */
                    SuccessValues: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ]
                  },
                  StatusCode: {
                    FailureCodes: [ /* required */
                      'NUMBER_VALUE',
                      /* more items */
                    ],
                    SuccessCodes: [ /* required */
                      'NUMBER_VALUE',
                      /* more items */
                    ]
                  }
                }
              },
              AWSManagedRulesBotControlRuleSet: {
                InspectionLevel: COMMON | TARGETED /* required */
              },
              LoginPath: 'STRING_VALUE',
              PasswordField: {
                Identifier: 'STRING_VALUE' /* required */
              },
              PayloadType: JSON | FORM_ENCODED,
              UsernameField: {
                Identifier: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ],
          RuleActionOverrides: [
            {
              ActionToUse: { /* required */
                Allow: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Block: {
                  CustomResponse: {
                    ResponseCode: 'NUMBER_VALUE', /* required */
                    CustomResponseBodyKey: 'STRING_VALUE',
                    ResponseHeaders: [
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Captcha: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Challenge: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Count: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                }
              },
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          ScopeDownStatement: /* recursive Statement */,
          Version: 'STRING_VALUE'
        },
        NotStatement: {
          Statement: /* recursive Statement */
        },
        OrStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        RateBasedStatement: {
          AggregateKeyType: IP | FORWARDED_IP, /* required */
          Limit: 'NUMBER_VALUE', /* required */
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          },
          ScopeDownStatement: /* recursive Statement */
        },
        RegexMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          RegexString: 'STRING_VALUE', /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        },
        RegexPatternSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        },
        RuleGroupReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          RuleActionOverrides: [
            {
              ActionToUse: { /* required */
                Allow: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Block: {
                  CustomResponse: {
                    ResponseCode: 'NUMBER_VALUE', /* required */
                    CustomResponseBodyKey: 'STRING_VALUE',
                    ResponseHeaders: [
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Captcha: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Challenge: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Count: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                }
              },
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        SizeConstraintStatement: {
          ComparisonOperator: EQ | NE | LE | LT | GE | GT, /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          Size: 'NUMBER_VALUE', /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        },
        SqliMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ],
          SensitivityLevel: LOW | HIGH
        },
        XssMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        }
      },
      VisibilityConfig: { /* required */
        CloudWatchMetricsEnabled: true || false, /* required */
        MetricName: 'STRING_VALUE', /* required */
        SampledRequestsEnabled: true || false /* required */
      },
      Action: {
        Allow: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        Block: {
          CustomResponse: {
            ResponseCode: 'NUMBER_VALUE', /* required */
            CustomResponseBodyKey: 'STRING_VALUE',
            ResponseHeaders: [
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        Captcha: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        Challenge: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        Count: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        }
      },
      CaptchaConfig: {
        ImmunityTimeProperty: {
          ImmunityTime: 'NUMBER_VALUE' /* required */
        }
      },
      ChallengeConfig: {
        ImmunityTimeProperty: {
          ImmunityTime: 'NUMBER_VALUE' /* required */
        }
      },
      OverrideAction: {
        Count: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        None: {
        }
      },
      RuleLabels: [
        {
          Name: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.checkCapacity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Scope — (String)

    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    • API and SDKs - For all calls, use the Region endpoint us-east-1.

    Possible values include:
    • "CLOUDFRONT"
    • "REGIONAL"
  • Rules — (Array<map>)

    An array of Rule that you're configuring to use in a rule group or web ACL.

    • Name — required — (String)

      The name of the rule. You can't change the name of a Rule after you create it.

    • Priority — required — (Integer)

      If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

    • Statement — required — (map)

      The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

      • ByteMatchStatement — (map)

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

        • SearchString — required — (Buffer, Typed Array, Blob, String)

          A string value that you want WAF to search for. 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.

          Valid values depend on the component that you specify for inspection in FieldToMatch:

          • Method: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.

          • UriPath: The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg.

          If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

          If you're using the WAF API

          Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.

          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 base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString.

          If you're using the CLI or one of the Amazon Web Services SDKs

          The value that you want WAF to search for. The SDK automatically base64 encodes the value.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
        • PositionalConstraint — required — (String)

          The area within the portion of the web request that you want 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.

          Possible values include:
          • "EXACTLY"
          • "STARTS_WITH"
          • "ENDS_WITH"
          • "CONTAINS"
          • "CONTAINS_WORD"
      • SqliMatchStatement — (map)

        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.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
        • SensitivityLevel — (String)

          The sensitivity that you want 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 in the 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

          Possible values include:
          • "LOW"
          • "HIGH"
      • XssMatchStatement — (map)

        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.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
      • SizeConstraintStatement — (map)

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

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

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

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • ComparisonOperator — required — (String)

          The operator to use to compare the request part to the size setting.

          Possible values include:
          • "EQ"
          • "NE"
          • "LE"
          • "LT"
          • "GE"
          • "GT"
        • Size — required — (Integer)

          The size, in byte, to compare to the request part, after any transformations.

        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
      • GeoMatchStatement — (map)

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

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

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

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

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

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

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

        • CountryCodes — (Array<String>)

          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.

        • ForwardedIPConfig — (map)

          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.

          Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • HeaderName — required — (String)

            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.

            Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • FallbackBehavior — required — (String)

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note: If the specified header isn't present in the request, 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. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

            Possible values include:
            • "MATCH"
            • "NO_MATCH"
      • RuleGroupReferenceStatement — (map)

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

        You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You can only use a rule group reference statement at the top level inside a web ACL.

        • ARN — required — (String)

          The Amazon Resource Name (ARN) of the entity.

        • ExcludedRules — (Array<map>)

          Rules in the referenced rule group whose actions are set to Count.

          Note: Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.
          • Name — required — (String)

            The name of the rule whose action you want to override to Count.

        • RuleActionOverrides — (Array<map>)

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • Name — required — (String)

            The name of the rule to override.

          • ActionToUse — required — (map)

            The override action to use, in place of the configured action of the rule in the rule group.

            • Block — (map)

              Instructs WAF to block the web request.

              • CustomResponse — (map)

                Defines a custom response for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • ResponseCode — required — (Integer)

                  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 in the WAF Developer Guide.

                • CustomResponseBodyKey — (String)

                  References the response body that you want 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.

                • ResponseHeaders — (Array<map>)

                  The HTTP headers to use in the response. Duplicate header names are not allowed.

                  For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Allow — (map)

              Instructs WAF to allow the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Count — (map)

              Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Captcha — (map)

              Instructs WAF to run a CAPTCHA check against the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Challenge — (map)

              Instructs WAF to run a Challenge check against the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

      • IPSetReferenceStatement — (map)

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

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

        • ARN — required — (String)

          The Amazon Resource Name (ARN) of the IPSet that this statement references.

        • IPSetForwardedIPConfig — (map)

          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.

          Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • HeaderName — required — (String)

            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.

            Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • FallbackBehavior — required — (String)

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note: If the specified header isn't present in the request, 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. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

            Possible values include:
            • "MATCH"
            • "NO_MATCH"
          • Position — required — (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, WAF inspects the last 10.

            Possible values include:
            • "FIRST"
            • "LAST"
            • "ANY"
      • RegexPatternSetReferenceStatement — (map)

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

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

        • ARN — required — (String)

          The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
      • RateBasedStatement — (map)

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

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

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

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

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

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

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

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

        • Limit — required — (Integer)

          The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

        • AggregateKeyType — required — (String)

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

          • IP - Aggregate the request counts on the IP address from the web request origin.

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

          Possible values include:
          • "IP"
          • "FORWARDED_IP"
        • ForwardedIPConfig — (map)

          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.

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

          This is required if AggregateKeyType is set to FORWARDED_IP.

          • HeaderName — required — (String)

            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.

            Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • FallbackBehavior — required — (String)

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note: If the specified header isn't present in the request, 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. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

            Possible values include:
            • "MATCH"
            • "NO_MATCH"
      • AndStatement — (map)

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

        • Statements — required — (Array<map>)

          The statements to combine with AND logic. You can use any statements that can be nested.

      • OrStatement — (map)

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

        • Statements — required — (Array<map>)

          The statements to combine with OR logic. You can use any statements that can be nested.

      • NotStatement — (map)

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

      • ManagedRuleGroupStatement — (map)

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

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

        Note: You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
        • VendorName — required — (String)

          The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

        • Name — required — (String)

          The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

        • Version — (String)

          The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

        • ExcludedRules — (Array<map>)

          Rules in the referenced rule group whose actions are set to Count.

          Note: Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.
          • Name — required — (String)

            The name of the rule whose action you want to override to Count.

        • ManagedRuleGroupConfigs — (Array<map>)

          Additional information that's used by a managed rule group. Many managed rule groups don't require this.

          Use the AWSManagedRulesATPRuleSet configuration object for the account takeover prevention managed rule group, to provide information such as the sign-in page of your application and the type of content to accept or reject from the client.

          Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

          • LoginPath — (String)
            Note: Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.
          • PayloadType — (String)
            Note: Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.
            Possible values include:
            • "JSON"
            • "FORM_ENCODED"
          • UsernameField — (map)
            Note: Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.
            • Identifier — required — (String)

              The name of the username field. For example /form/username.

          • PasswordField — (map)
            Note: Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.
            • Identifier — required — (String)

              The name of the password field. For example /form/password.

          • AWSManagedRulesBotControlRuleSet — (map)

            Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

            • InspectionLevel — required — (String)

              The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group.

              Possible values include:
              • "COMMON"
              • "TARGETED"
          • AWSManagedRulesATPRuleSet — (map)

            Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

            This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

            For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

            • LoginPath — required — (String)

              The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login.

              The rule group inspects only HTTP POST requests to your specified login endpoint.

            • RequestInspection — (map)

              The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

              • PayloadType — required — (String)

                The payload type for your login endpoint, either JSON or form encoded.

                Possible values include:
                • "JSON"
                • "FORM_ENCODED"
              • UsernameField — required — (map)

                Details about your login page username field.

                How you specify this depends on the payload type.

                • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

                  For example, for the JSON payload { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.

                • For form encoded payload types, use the HTML form names.

                  For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.

                • Identifier — required — (String)

                  The name of the username field. For example /form/username.

              • PasswordField — required — (map)

                Details about your login page password field.

                How you specify this depends on the payload type.

                • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

                  For example, for the JSON payload { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.

                • For form encoded payload types, use the HTML form names.

                  For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.

                • Identifier — required — (String)

                  The name of the password field. For example /form/password.

            • ResponseInspection — (map)

              The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

              The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that submit too many failed login attempts in a short amount of time.

              Note: Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
              • StatusCode — (map)

                Configures inspection of the response status code.

                • SuccessCodes — required — (Array<Integer>)

                  Status codes in the response that indicate a successful login attempt. To be counted as a successful login, the response status code must match one of these. Each code must be unique among the success and failure status codes.

                  JSON example: "SuccessCodes": [ 200, 201 ]

                • FailureCodes — required — (Array<Integer>)

                  Status codes in the response that indicate a failed login attempt. To be counted as a failed login, the response status code must match one of these. Each code must be unique among the success and failure status codes.

                  JSON example: "FailureCodes": [ 400, 404 ]

              • Header — (map)

                Configures inspection of the response header.

                • Name — required — (String)

                  The name of the header to match against. The name must be an exact match, including case.

                  JSON example: "Name": [ "LoginResult" ]

                • SuccessValues — required — (Array<String>)

                  Values in the response header with the specified name that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

                  JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]

                • FailureValues — required — (Array<String>)

                  Values in the response header with the specified name that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

                  JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]

              • BodyContains — (map)

                Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.

                • SuccessStrings — required — (Array<String>)

                  Strings in the body of the response that indicate a successful login attempt. To be counted as a successful login, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

                  JSON example: "SuccessStrings": [ "Login successful", "Welcome to our site!" ]

                • FailureStrings — required — (Array<String>)

                  Strings in the body of the response that indicate a failed login attempt. To be counted as a failed login, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

                  JSON example: "FailureStrings": [ "Login failed" ]

              • Json — (map)

                Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.

                • Identifier — required — (String)

                  The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.

                  JSON example: "Identifier": [ "/login/success" ]

                • SuccessValues — required — (Array<String>)

                  Values for the specified identifier in the response JSON that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

                  JSON example: "SuccessValues": [ "True", "Succeeded" ]

                • FailureValues — required — (Array<String>)

                  Values for the specified identifier in the response JSON that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

                  JSON example: "FailureValues": [ "False", "Failed" ]

        • RuleActionOverrides — (Array<map>)

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • Name — required — (String)

            The name of the rule to override.

          • ActionToUse — required — (map)

            The override action to use, in place of the configured action of the rule in the rule group.

            • Block — (map)

              Instructs WAF to block the web request.

              • CustomResponse — (map)

                Defines a custom response for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • ResponseCode — required — (Integer)

                  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 in the WAF Developer Guide.

                • CustomResponseBodyKey — (String)

                  References the response body that you want 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.

                • ResponseHeaders — (Array<map>)

                  The HTTP headers to use in the response. Duplicate header names are not allowed.

                  For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Allow — (map)

              Instructs WAF to allow the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Count — (map)

              Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Captcha — (map)

              Instructs WAF to run a CAPTCHA check against the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Challenge — (map)

              Instructs WAF to run a Challenge check against the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

      • LabelMatchStatement — (map)

        A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

        The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

        • Scope — required — (String)

          Specify whether you want to match using the label name or just the namespace.

          Possible values include:
          • "LABEL"
          • "NAMESPACE"
        • Key — required — (String)

          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.

      • RegexMatchStatement — (map)

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

        • RegexString — required — (String)

          The string representing the regular expression.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
    • Action — (map)

      The action that 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.

      This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

      You must specify either this Action setting or the rule OverrideAction setting, but not both:

      • If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.

      • If the rule statement references a rule group, use the override action setting and not this action setting.

      • Block — (map)

        Instructs WAF to block the web request.

        • CustomResponse — (map)

          Defines a custom response for the web request.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • ResponseCode — required — (Integer)

            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 in the WAF Developer Guide.

          • CustomResponseBodyKey — (String)

            References the response body that you want 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.

          • ResponseHeaders — (Array<map>)

            The HTTP headers to use in the response. Duplicate header names are not allowed.

            For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • Allow — (map)

        Instructs WAF to allow the web request.

        • CustomRequestHandling — (map)

          Defines custom handling for the web request.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • Count — (map)

        Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

        • CustomRequestHandling — (map)

          Defines custom handling for the web request.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • Captcha — (map)

        Instructs WAF to run a CAPTCHA check against the web request.

        • CustomRequestHandling — (map)

          Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • Challenge — (map)

        Instructs WAF to run a Challenge check against the web request.

        • CustomRequestHandling — (map)

          Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

    • OverrideAction — (map)

      The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

      You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

      Note: This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.
      • Count — (map)

        Override the rule group evaluation result to count only.

        Note: This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.
        • CustomRequestHandling — (map)

          Defines custom handling for the web request.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • None — (map)

        Don't override the rule group evaluation result. This is the most common setting.

    • RuleLabels — (Array<map>)

      Labels to apply to web requests that match the rule match statement. 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.

      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.

      • Name — required — (String)

        The label string.

    • VisibilityConfig — required — (map)

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      • SampledRequestsEnabled — required — (Boolean)

        A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

      • CloudWatchMetricsEnabled — required — (Boolean)

        A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.

      • MetricName — required — (String)

        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 WAF, for example All and Default_Action.

    • CaptchaConfig — (map)

      Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.

      • ImmunityTimeProperty — (map)

        Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.

        • ImmunityTime — required — (Integer)

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

    • ChallengeConfig — (map)

      Specifies how WAF should handle Challenge evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.

      • ImmunityTimeProperty — (map)

        Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.

        • ImmunityTime — required — (Integer)

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Capacity — (Integer)

      The capacity required by the rules and scope.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Addresses: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  IPAddressVersion: IPV4 | IPV6, /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
wafv2.createIPSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the IP set. You cannot change the name of an IPSet after you create it.

  • Scope — (String)

    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    • API and SDKs - For all calls, use the Region endpoint us-east-1.

    Possible values include:
    • "CLOUDFRONT"
    • "REGIONAL"
  • Description — (String)

    A description of the IP set that helps with identification.

  • IPAddressVersion — (String)

    The version of the IP addresses, either IPV4 or IPV6.

    Possible values include:
    • "IPV4"
    • "IPV6"
  • Addresses — (Array<String>)

    Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

    Example address strings:

    • To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    • To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

    • To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    • To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    Example JSON Addresses specifications:

    • Empty array: "Addresses": []

    • Array with one address: "Addresses": ["192.0.2.44/32"]

    • Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    • INVALID specification: "Addresses": [""] INVALID

  • Tags — (Array<map>)

    An array of key:value pairs to associate with the resource.

    • Key — required — (String)

      Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

    • Value — required — (String)

      Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Summary — (map)

      High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

      • Name — (String)

        The name of the IP set. You cannot change the name of an IPSet after you create it.

      • Id — (String)

        A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      • Description — (String)

        A description of the IP set that helps with identification.

      • LockToken — (String)

        A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

      • ARN — (String)

        The Amazon Resource Name (ARN) of the entity.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  RegularExpressionList: [ /* required */
    {
      RegexString: 'STRING_VALUE'
    },
    /* more items */
  ],
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
wafv2.createRegexPatternSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the set. You cannot change the name after you create the set.

  • Scope — (String)

    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    • API and SDKs - For all calls, use the Region endpoint us-east-1.

    Possible values include:
    • "CLOUDFRONT"
    • "REGIONAL"
  • Description — (String)

    A description of the set that helps with identification.

  • RegularExpressionList — (Array<map>)

    Array of regular expression strings.

    • RegexString — (String)

      The string representing the regular expression.

  • Tags — (Array<map>)

    An array of key:value pairs to associate with the resource.

    • Key — required — (String)

      Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

    • Value — required — (String)

      Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Summary — (map)

      High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

      • Name — (String)

        The name of the data type instance. You cannot change the name after you create the instance.

      • Id — (String)

        A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      • Description — (String)

        A description of the set that helps with identification.

      • LockToken — (String)

        A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

      • ARN — (String)

        The Amazon Resource Name (ARN) of the entity.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Capacity: 'NUMBER_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  VisibilityConfig: { /* required */
    CloudWatchMetricsEnabled: true || false, /* required */
    MetricName: 'STRING_VALUE', /* required */
    SampledRequestsEnabled: true || false /* required */
  },
  CustomResponseBodies: {
    '<EntityName>': {
      Content: 'STRING_VALUE', /* required */
      ContentType: TEXT_PLAIN | TEXT_HTML | APPLICATION_JSON /* required */
    },
    /* '<EntityName>': ... */
  },
  Description: 'STRING_VALUE',
  Rules: [
    {
      Name: 'STRING_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      Statement: { /* Statement */ /* required */
        AndStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        ByteMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          PositionalConstraint: EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD, /* required */
          SearchString: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        },
        GeoMatchStatement: {
          CountryCodes: [
            AF | AX | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BQ | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CD | CK | CR | CI | HR | CU | CW | CY | CZ | DK | DJ | DM | DO | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | JM | JP | JE | JO | KZ | KE | KI | KP | KR | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | NC | NZ | NI | NE | NG | NU | NF | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | BL | SH | KN | LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK | SI | SB | SO | ZA | GS | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW | TJ | TZ | TH | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | GB | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | ZM | ZW | XK,
            /* more items */
          ],
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          }
        },
        IPSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          IPSetForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE', /* required */
            Position: FIRST | LAST | ANY /* required */
          }
        },
        LabelMatchStatement: {
          Key: 'STRING_VALUE', /* required */
          Scope: LABEL | NAMESPACE /* required */
        },
        ManagedRuleGroupStatement: {
          Name: 'STRING_VALUE', /* required */
          VendorName: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          ManagedRuleGroupConfigs: [
            {
              AWSManagedRulesATPRuleSet: {
                LoginPath: 'STRING_VALUE', /* required */
                RequestInspection: {
                  PasswordField: { /* required */
                    Identifier: 'STRING_VALUE' /* required */
                  },
                  PayloadType: JSON | FORM_ENCODED, /* required */
                  UsernameField: { /* required */
                    Identifier: 'STRING_VALUE' /* required */
                  }
                },
                ResponseInspection: {
                  BodyContains: {
                    FailureStrings: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ],
                    SuccessStrings: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ]
                  },
                  Header: {
                    FailureValues: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ],
                    Name: 'STRING_VALUE', /* required */
                    SuccessValues: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ]
                  },
                  Json: {
                    FailureValues: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ],
                    Identifier: 'STRING_VALUE', /* required */
                    SuccessValues: [ /* required */
                      'STRING_VALUE',
                      /* more items */
                    ]
                  },
                  StatusCode: {
                    FailureCodes: [ /* required */
                      'NUMBER_VALUE',
                      /* more items */
                    ],
                    SuccessCodes: [ /* required */
                      'NUMBER_VALUE',
                      /* more items */
                    ]
                  }
                }
              },
              AWSManagedRulesBotControlRuleSet: {
                InspectionLevel: COMMON | TARGETED /* required */
              },
              LoginPath: 'STRING_VALUE',
              PasswordField: {
                Identifier: 'STRING_VALUE' /* required */
              },
              PayloadType: JSON | FORM_ENCODED,
              UsernameField: {
                Identifier: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ],
          RuleActionOverrides: [
            {
              ActionToUse: { /* required */
                Allow: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Block: {
                  CustomResponse: {
                    ResponseCode: 'NUMBER_VALUE', /* required */
                    CustomResponseBodyKey: 'STRING_VALUE',
                    ResponseHeaders: [
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Captcha: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Challenge: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Count: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                }
              },
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          ScopeDownStatement: /* recursive Statement */,
          Version: 'STRING_VALUE'
        },
        NotStatement: {
          Statement: /* recursive Statement */
        },
        OrStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        RateBasedStatement: {
          AggregateKeyType: IP | FORWARDED_IP, /* required */
          Limit: 'NUMBER_VALUE', /* required */
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          },
          ScopeDownStatement: /* recursive Statement */
        },
        RegexMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          RegexString: 'STRING_VALUE', /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        },
        RegexPatternSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        },
        RuleGroupReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          RuleActionOverrides: [
            {
              ActionToUse: { /* required */
                Allow: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Block: {
                  CustomResponse: {
                    ResponseCode: 'NUMBER_VALUE', /* required */
                    CustomResponseBodyKey: 'STRING_VALUE',
                    ResponseHeaders: [
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Captcha: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Challenge: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                },
                Count: {
                  CustomRequestHandling: {
                    InsertHeaders: [ /* required */
                      {
                        Name: 'STRING_VALUE', /* required */
                        Value: 'STRING_VALUE' /* required */
                      },
                      /* more items */
                    ]
                  }
                }
              },
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        SizeConstraintStatement: {
          ComparisonOperator: EQ | NE | LE | LT | GE | GT, /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          Size: 'NUMBER_VALUE', /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        },
        SqliMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ],
          SensitivityLevel: LOW | HIGH
        },
        XssMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Cookies: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedCookies: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            Headers: {
              MatchPattern: { /* required */
                All: {
                },
                ExcludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ],
                IncludedHeaders: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              OversizeHandling: CONTINUE | MATCH | NO_MATCH /* required */
            },
            JsonBody: {
              MatchPattern: { /* required */
                All: {
                },
                IncludedPaths: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              MatchScope: ALL | KEY | VALUE, /* required */
              InvalidFallbackBehavior: MATCH | NO_MATCH | EVALUATE_AS_STRING,
              OversizeHandling: CONTINUE | MATCH | NO_MATCH
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: 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 /* required */
            },
            /* more items */
          ]
        }
      },
      VisibilityConfig: { /* required */
        CloudWatchMetricsEnabled: true || false, /* required */
        MetricName: 'STRING_VALUE', /* required */
        SampledRequestsEnabled: true || false /* required */
      },
      Action: {
        Allow: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        Block: {
          CustomResponse: {
            ResponseCode: 'NUMBER_VALUE', /* required */
            CustomResponseBodyKey: 'STRING_VALUE',
            ResponseHeaders: [
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        Captcha: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        Challenge: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        Count: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        }
      },
      CaptchaConfig: {
        ImmunityTimeProperty: {
          ImmunityTime: 'NUMBER_VALUE' /* required */
        }
      },
      ChallengeConfig: {
        ImmunityTimeProperty: {
          ImmunityTime: 'NUMBER_VALUE' /* required */
        }
      },
      OverrideAction: {
        Count: {
          CustomRequestHandling: {
            InsertHeaders: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          }
        },
        None: {
        }
      },
      RuleLabels: [
        {
          Name: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
wafv2.createRuleGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the rule group. You cannot change the name of a rule group after you create it.

  • Scope — (String)

    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    • API and SDKs - For all calls, use the Region endpoint us-east-1.

    Possible values include:
    • "CLOUDFRONT"
    • "REGIONAL"
  • Capacity — (Integer)

    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, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

    WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. 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.

  • Description — (String)

    A description of the rule group that helps with identification.

  • Rules — (Array<map>)

    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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

    • Name — required — (String)

      The name of the rule. You can't change the name of a Rule after you create it.

    • Priority — required — (Integer)

      If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

    • Statement — required — (map)

      The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

      • ByteMatchStatement — (map)

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

        • SearchString — required — (Buffer, Typed Array, Blob, String)

          A string value that you want WAF to search for. 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.

          Valid values depend on the component that you specify for inspection in FieldToMatch:

          • Method: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.

          • UriPath: The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg.

          If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

          If you're using the WAF API

          Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.

          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 base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString.

          If you're using the CLI or one of the Amazon Web Services SDKs

          The value that you want WAF to search for. The SDK automatically base64 encodes the value.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
        • PositionalConstraint — required — (String)

          The area within the portion of the web request that you want 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.

          Possible values include:
          • "EXACTLY"
          • "STARTS_WITH"
          • "ENDS_WITH"
          • "CONTAINS"
          • "CONTAINS_WORD"
      • SqliMatchStatement — (map)

        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.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
        • SensitivityLevel — (String)

          The sensitivity that you want 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 in the 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

          Possible values include:
          • "LOW"
          • "HIGH"
      • XssMatchStatement — (map)

        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.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
      • SizeConstraintStatement — (map)

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

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

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

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • ComparisonOperator — required — (String)

          The operator to use to compare the request part to the size setting.

          Possible values include:
          • "EQ"
          • "NE"
          • "LE"
          • "LT"
          • "GE"
          • "GT"
        • Size — required — (Integer)

          The size, in byte, to compare to the request part, after any transformations.

        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
      • GeoMatchStatement — (map)

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

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

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

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

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

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

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

        • CountryCodes — (Array<String>)

          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.

        • ForwardedIPConfig — (map)

          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.

          Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • HeaderName — required — (String)

            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.

            Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • FallbackBehavior — required — (String)

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note: If the specified header isn't present in the request, 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. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

            Possible values include:
            • "MATCH"
            • "NO_MATCH"
      • RuleGroupReferenceStatement — (map)

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

        You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You can only use a rule group reference statement at the top level inside a web ACL.

        • ARN — required — (String)

          The Amazon Resource Name (ARN) of the entity.

        • ExcludedRules — (Array<map>)

          Rules in the referenced rule group whose actions are set to Count.

          Note: Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.
          • Name — required — (String)

            The name of the rule whose action you want to override to Count.

        • RuleActionOverrides — (Array<map>)

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • Name — required — (String)

            The name of the rule to override.

          • ActionToUse — required — (map)

            The override action to use, in place of the configured action of the rule in the rule group.

            • Block — (map)

              Instructs WAF to block the web request.

              • CustomResponse — (map)

                Defines a custom response for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • ResponseCode — required — (Integer)

                  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 in the WAF Developer Guide.

                • CustomResponseBodyKey — (String)

                  References the response body that you want 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.

                • ResponseHeaders — (Array<map>)

                  The HTTP headers to use in the response. Duplicate header names are not allowed.

                  For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Allow — (map)

              Instructs WAF to allow the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Count — (map)

              Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Captcha — (map)

              Instructs WAF to run a CAPTCHA check against the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Challenge — (map)

              Instructs WAF to run a Challenge check against the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

      • IPSetReferenceStatement — (map)

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

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

        • ARN — required — (String)

          The Amazon Resource Name (ARN) of the IPSet that this statement references.

        • IPSetForwardedIPConfig — (map)

          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.

          Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • HeaderName — required — (String)

            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.

            Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • FallbackBehavior — required — (String)

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note: If the specified header isn't present in the request, 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. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

            Possible values include:
            • "MATCH"
            • "NO_MATCH"
          • Position — required — (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, WAF inspects the last 10.

            Possible values include:
            • "FIRST"
            • "LAST"
            • "ANY"
      • RegexPatternSetReferenceStatement — (map)

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

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

        • ARN — required — (String)

          The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
      • RateBasedStatement — (map)

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

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

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

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

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

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

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

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

        • Limit — required — (Integer)

          The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

        • AggregateKeyType — required — (String)

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

          • IP - Aggregate the request counts on the IP address from the web request origin.

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

          Possible values include:
          • "IP"
          • "FORWARDED_IP"
        • ForwardedIPConfig — (map)

          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.

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

          This is required if AggregateKeyType is set to FORWARDED_IP.

          • HeaderName — required — (String)

            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.

            Note: If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
          • FallbackBehavior — required — (String)

            The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

            Note: If the specified header isn't present in the request, 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. WAF applies the rule action to the request.

            • NO_MATCH - Treat the web request as not matching the rule statement.

            Possible values include:
            • "MATCH"
            • "NO_MATCH"
      • AndStatement — (map)

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

        • Statements — required — (Array<map>)

          The statements to combine with AND logic. You can use any statements that can be nested.

      • OrStatement — (map)

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

        • Statements — required — (Array<map>)

          The statements to combine with OR logic. You can use any statements that can be nested.

      • NotStatement — (map)

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

      • ManagedRuleGroupStatement — (map)

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

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

        Note: You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.
        • VendorName — required — (String)

          The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

        • Name — required — (String)

          The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

        • Version — (String)

          The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

        • ExcludedRules — (Array<map>)

          Rules in the referenced rule group whose actions are set to Count.

          Note: Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.
          • Name — required — (String)

            The name of the rule whose action you want to override to Count.

        • ManagedRuleGroupConfigs — (Array<map>)

          Additional information that's used by a managed rule group. Many managed rule groups don't require this.

          Use the AWSManagedRulesATPRuleSet configuration object for the account takeover prevention managed rule group, to provide information such as the sign-in page of your application and the type of content to accept or reject from the client.

          Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

          • LoginPath — (String)
            Note: Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.
          • PayloadType — (String)
            Note: Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.
            Possible values include:
            • "JSON"
            • "FORM_ENCODED"
          • UsernameField — (map)
            Note: Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.
            • Identifier — required — (String)

              The name of the username field. For example /form/username.

          • PasswordField — (map)
            Note: Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.
            • Identifier — required — (String)

              The name of the password field. For example /form/password.

          • AWSManagedRulesBotControlRuleSet — (map)

            Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

            • InspectionLevel — required — (String)

              The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group.

              Possible values include:
              • "COMMON"
              • "TARGETED"
          • AWSManagedRulesATPRuleSet — (map)

            Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

            This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

            For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

            • LoginPath — required — (String)

              The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login.

              The rule group inspects only HTTP POST requests to your specified login endpoint.

            • RequestInspection — (map)

              The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

              • PayloadType — required — (String)

                The payload type for your login endpoint, either JSON or form encoded.

                Possible values include:
                • "JSON"
                • "FORM_ENCODED"
              • UsernameField — required — (map)

                Details about your login page username field.

                How you specify this depends on the payload type.

                • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

                  For example, for the JSON payload { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.

                • For form encoded payload types, use the HTML form names.

                  For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.

                • Identifier — required — (String)

                  The name of the username field. For example /form/username.

              • PasswordField — required — (map)

                Details about your login page password field.

                How you specify this depends on the payload type.

                • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

                  For example, for the JSON payload { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.

                • For form encoded payload types, use the HTML form names.

                  For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.

                • Identifier — required — (String)

                  The name of the password field. For example /form/password.

            • ResponseInspection — (map)

              The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

              The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that submit too many failed login attempts in a short amount of time.

              Note: Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
              • StatusCode — (map)

                Configures inspection of the response status code.

                • SuccessCodes — required — (Array<Integer>)

                  Status codes in the response that indicate a successful login attempt. To be counted as a successful login, the response status code must match one of these. Each code must be unique among the success and failure status codes.

                  JSON example: "SuccessCodes": [ 200, 201 ]

                • FailureCodes — required — (Array<Integer>)

                  Status codes in the response that indicate a failed login attempt. To be counted as a failed login, the response status code must match one of these. Each code must be unique among the success and failure status codes.

                  JSON example: "FailureCodes": [ 400, 404 ]

              • Header — (map)

                Configures inspection of the response header.

                • Name — required — (String)

                  The name of the header to match against. The name must be an exact match, including case.

                  JSON example: "Name": [ "LoginResult" ]

                • SuccessValues — required — (Array<String>)

                  Values in the response header with the specified name that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

                  JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]

                • FailureValues — required — (Array<String>)

                  Values in the response header with the specified name that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

                  JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]

              • BodyContains — (map)

                Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.

                • SuccessStrings — required — (Array<String>)

                  Strings in the body of the response that indicate a successful login attempt. To be counted as a successful login, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

                  JSON example: "SuccessStrings": [ "Login successful", "Welcome to our site!" ]

                • FailureStrings — required — (Array<String>)

                  Strings in the body of the response that indicate a failed login attempt. To be counted as a failed login, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

                  JSON example: "FailureStrings": [ "Login failed" ]

              • Json — (map)

                Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.

                • Identifier — required — (String)

                  The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.

                  JSON example: "Identifier": [ "/login/success" ]

                • SuccessValues — required — (Array<String>)

                  Values for the specified identifier in the response JSON that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

                  JSON example: "SuccessValues": [ "True", "Succeeded" ]

                • FailureValues — required — (Array<String>)

                  Values for the specified identifier in the response JSON that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

                  JSON example: "FailureValues": [ "False", "Failed" ]

        • RuleActionOverrides — (Array<map>)

          Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

          You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

          • Name — required — (String)

            The name of the rule to override.

          • ActionToUse — required — (map)

            The override action to use, in place of the configured action of the rule in the rule group.

            • Block — (map)

              Instructs WAF to block the web request.

              • CustomResponse — (map)

                Defines a custom response for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • ResponseCode — required — (Integer)

                  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 in the WAF Developer Guide.

                • CustomResponseBodyKey — (String)

                  References the response body that you want 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.

                • ResponseHeaders — (Array<map>)

                  The HTTP headers to use in the response. Duplicate header names are not allowed.

                  For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Allow — (map)

              Instructs WAF to allow the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Count — (map)

              Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Captcha — (map)

              Instructs WAF to run a CAPTCHA check against the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

            • Challenge — (map)

              Instructs WAF to run a Challenge check against the web request.

              • CustomRequestHandling — (map)

                Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

                For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

                • InsertHeaders — required — (Array<map>)

                  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 WAF quotas in the WAF Developer Guide.

                  • Name — required — (String)

                    The name of the custom header.

                    For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

                  • Value — required — (String)

                    The value of the custom header.

      • LabelMatchStatement — (map)

        A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

        The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

        • Scope — required — (String)

          Specify whether you want to match using the label name or just the namespace.

          Possible values include:
          • "LABEL"
          • "NAMESPACE"
        • Key — required — (String)

          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.

      • RegexMatchStatement — (map)

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

        • RegexString — required — (String)

          The string representing the regular expression.

        • FieldToMatch — required — (map)

          The part of the web request that you want WAF to inspect.

          • SingleHeader — (map)

            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.

            • Name — required — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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" }

            • Name — required — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • JsonBody — (map)

            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.

            Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

            • MatchPattern — required — (map)

              The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

              • All — (map)

                Match all of the elements. See also MatchScope in JsonBody.

                You must specify either this setting or the IncludedPaths setting, but not both.

              • IncludedPaths — (Array<String>)

                Match only the specified include paths. See also MatchScope in JsonBody.

                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.

                You must specify either this setting or the All setting, but not both.

                Note: Don't use this option to include all paths. Instead, use the All setting.
            • MatchScope — required — (String)

              The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • InvalidFallbackBehavior — (String)

              What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

              WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

              WAF parses the JSON in the following examples as two valid key, value pairs:

              • Missing comma: {"key1":"value1""key2":"value2"}

              • Missing colon: {"key1":"value1","key2""value2"}

              • Extra colons: {"key1"::"value1","key2""value2"}

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
              • "EVALUATE_AS_STRING"
            • OversizeHandling — (String)

              What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the body normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. 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 8 KB.

              Default: CONTINUE

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Headers — (map)

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

            Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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"} }

              • All — (map)

                Inspect all headers.

              • IncludedHeaders — (Array<String>)

                Inspect only the headers that have a key that matches one of the strings specified here.

              • ExcludedHeaders — (Array<String>)

                Inspect only the headers whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the headers of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
          • Cookies — (map)

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

            Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

            • MatchPattern — required — (map)

              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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

              • All — (map)

                Inspect all cookies.

              • IncludedCookies — (Array<String>)

                Inspect only the cookies that have a key that matches one of the strings specified here.

              • ExcludedCookies — (Array<String>)

                Inspect only the cookies whose keys don't match any of the strings specified here.

            • MatchScope — required — (String)

              The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

              Possible values include:
              • "ALL"
              • "KEY"
              • "VALUE"
            • OversizeHandling — required — (String)

              What WAF should do if the cookies of the request are larger than WAF can inspect. 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 WAF.

              The options for oversize handling are the following:

              • CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.

              • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

              • NO_MATCH - Treat the web request as not matching the rule statement.

              Possible values include:
              • "CONTINUE"
              • "MATCH"
              • "NO_MATCH"
        • TextTransformations — required — (Array<map>)

          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, 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.

          • Priority — required — (Integer)

            Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

          • Type — required — (String)

            You can specify the following transformation types:

            BASE64_DECODE - Decode a Base64-encoded string.

            BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.

            CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.

            • Delete the following characters: \ " ' ^

            • Delete spaces before the following characters: / (

            • Replace the following characters with a space: , ;

            • Replace multiple spaces with one space

            • Convert uppercase letters (A-Z) to lowercase (a-z)

            COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):

            • \f, formfeed, decimal 12

            • \t, tab, decimal 9

            • \n, newline, decimal 10

            • \r, carriage return, decimal 13

            • \v, vertical tab, decimal 11

            • Non-breaking space, decimal 160

            COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

            CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript.

            ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output.

            HEX_DECODE - Decode a string of hexadecimal characters into a binary.

            HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:

            • Replaces (ampersand)quot; with "

            • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

            • Replaces (ampersand)lt; with a "less than" symbol

            • Replaces (ampersand)gt; with >

            • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

            • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

            JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.

            LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).

            MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.

            NONE - Specify NONE if you don't want any text transformations.

            NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.

            NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.

            REMOVE_NULLS - Remove all NULL bytes from the input.

            REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.

            REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).

            SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

            URL_DECODE - Decode a URL-encoded value.

            URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.

            UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.

            Possible values include:
            • "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"
    • Action — (map)

      The action that 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.

      This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

      You must specify either this Action setting or the rule OverrideAction setting, but not both:

      • If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.

      • If the rule statement references a rule group, use the override action setting and not this action setting.

      • Block — (map)

        Instructs WAF to block the web request.

        • CustomResponse — (map)

          Defines a custom response for the web request.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • ResponseCode — required — (Integer)

            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 in the WAF Developer Guide.

          • CustomResponseBodyKey — (String)

            References the response body that you want 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.

          • ResponseHeaders — (Array<map>)

            The HTTP headers to use in the response. Duplicate header names are not allowed.

            For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • Allow — (map)

        Instructs WAF to allow the web request.

        • CustomRequestHandling — (map)

          Defines custom handling for the web request.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • Count — (map)

        Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

        • CustomRequestHandling — (map)

          Defines custom handling for the web request.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • Captcha — (map)

        Instructs WAF to run a CAPTCHA check against the web request.

        • CustomRequestHandling — (map)

          Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • Challenge — (map)

        Instructs WAF to run a Challenge check against the web request.

        • CustomRequestHandling — (map)

          Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

    • OverrideAction — (map)

      The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

      You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

      Note: This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.
      • Count — (map)

        Override the rule group evaluation result to count only.

        Note: This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.
        • CustomRequestHandling — (map)

          Defines custom handling for the web request.

          For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

          • InsertHeaders — required — (Array<map>)

            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 WAF quotas in the WAF Developer Guide.

            • Name — required — (String)

              The name of the custom header.

              For custom request header insertion, when 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, WAF inserts the header x-amzn-waf-sample.

            • Value — required — (String)

              The value of the custom header.

      • None — (map)

        Don't override the rule group evaluation result. This is the most common setting.

    • RuleLabels — (Array<map>)

      Labels to apply to web requests that match the rule match statement. 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.

      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.

      • Name — required — (String)

        The label string.

    • VisibilityConfig — required — (map)

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      • SampledRequestsEnabled — required — (Boolean)

        A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

      • CloudWatchMetricsEnabled — required — (Boolean)

        A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.

      • MetricName — required — (String)

        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 WAF, for example All and Default_Action.

    • CaptchaConfig — (map)

      Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.

      • ImmunityTimeProperty — (map)

        Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.

        • ImmunityTime — required — (Integer)

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

    • ChallengeConfig — (map)

      Specifies how WAF should handle Challenge evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.

      • ImmunityTimeProperty — (map)

        Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.

        • ImmunityTime — required — (Integer)

          The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

          For the Challenge action, the minimum setting is 300.

  • VisibilityConfig — (map)

    Defines and enables Amazon CloudWatch metrics and web request sample collection.

    • SampledRequestsEnabled — required — (Boolean)

      A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

    • CloudWatchMetricsEnabled — required — (Boolean)

      A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.

    • MetricName — required — (String)

      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 WAF, for example All and Default_Action.

  • Tags — (Array<map>)

    An array of key:value pairs to associate with the resource.

    • Key — required — (String)

      Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

    • Value — required — (String)

      Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

  • CustomResponseBodies — (map<map>)

    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 WAF in the WAF Developer Guide.

    For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

    • ContentType — required — (String)

      The type of content in the payload that you are defining in the Content string.

      Possible values include:
      • "TEXT_PLAIN"
      • "TEXT_HTML"
      • "APPLICATION_JSON"
    • Content — required — (String)

      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 WAF quotas in the WAF Developer Guide.