query_​string_​parameter

Version: v2023-01-05Includes use: Yes

Criterion name: Query String Parameter

Matches query string field names or values.

Default criterion

These samples reflect the criterion's default settings. You can use these as is in your configurations or make adjustments based on the criterion's available options.

data "akamai_property_rules_builder" "query_string_parameter" {
  rules_v2023_01_05 {
    name     = "Query String Parameter"
    comments = "Matches query string field names or values"
    criterion {
      query_string_parameter {
        match_wildcard_name = false
        match_operator = "IS_ONE_OF"
        parameter_name = ""
        match_case_sensitive_name = true
        values = []
        match_wildcard_value = false
        match_case_sensitive_value = true
        escape_value = false
      }
    }
  }
}
"criterion": [
  {
    "name": "queryStringParameter",
    "options": {
      "matchWildcardName": false,
      "matchOperator": "IS_ONE_OF",
      "parameterName": "",
      "matchCaseSensitiveName": true,
      "values": [],
      "matchWildcardValue": false,
      "matchCaseSensitiveValue": true,
      "escapeValue": false
    }
  }
]

Options

Option Description
parameter_name
The name of the query field, for example, q in ?q=string.
match_operator
Matches the contents of the values array. Value is one of:
  • IS_ONE_OF. Tests whether the field's value string matches..
  • IS_NOT_ONE_OF. Tests whether the field's value string does not match.
  • EXISTS. Whether the query field's parameter_name is present in the requesting URL.
  • DOES_NOT_EXIST. Whether the query field's parameter_name is absent from the requesting URL.
  • IS_LESS_THAN. Matches a range when the value is numeric.
  • IS_MORE_THAN. Matches a range when the value is numeric.
  • IS_BETWEEN. Is between the numeric lower_bound and upper_bound values.
values
The value of the query field, for example, string in ?q=string.
lower_bound
When the value is numeric, this specifies the match's minimum value.
upper_bound
When the value is numeric, this specifies the match's maximum value.
match_wildcard_name
Allows wildcards in the parameter_name field, where ? matches a single character and * matches zero or more characters.
match_wildcard_value
Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
match_case_sensitive_name Sets a case-sensitive match for the parameter_name field.
match_case_sensitive_value Sets a case-sensitive match for the value field.
escape_value Matches when the value is URl-escaped.