match_variable

Version: `v2023-01-05`	Includes use: Yes

Criterion name: Variable

Matches a built-in variable, or a custom variable pre-declared within the rule tree by the set_variable behavior. See Support for variables for more information on this feature.

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" "match_variable" {
  rules_v2023_01_05 {
    name     = "Variable"
    comments = "Matches a built-in variable, or a custom variable pre-declared within the rule tree"
    criterion {
      match_variable {
        variable_name = ""
        match_wildcard = false
        variable_values = []
        match_case_sensitive = true
        match_operator = "IS_ONE_OF"
      }
    }
  }
}

"criterion": [
  {
    "name": "matchVariable",
    "options": {
      "variableName": "",
      "matchWildcard": false,
      "variableValues": [],
      "matchCaseSensitive": true,
      "matchOperator": "IS_ONE_OF"
    }
  }
]

Options

Option	Description
`variable_name`	String The name of the variable to match.
`match_operator`	Enum The name of the variable to match. Value is one of: `IS`. Matches the `variable_expression` string. `IS_NOT`. Does not match the `variable_expression` string. `IS_ONE_OF`. Matches any of an array of string `variable_values`. `IS_NOT_ONE_OF`. Does not match any of an array of string `variable_values`. `IS_EMPTY`. Matches if a defined variable does not contain a value. You can't activate a rule that matches an undefined variable. `IS_NOT_EMPTY`. Matches if a defined variable contains a value. You can't activate a rule that matches an undefined variable. `IS_BETWEEN`. Is between the numeric `lower_bound` and `upper_bound` values. `IS_NOT_BETWEEN`. Is outside the numeric `lower_bound` and `upper_bound` range. `IS_GREATER_THAN`. Is greater than the `variable_expression` string-formatted number. `IS_GREATER_THAN_OR_EQUAL_TO`. Is greater than or equal to the `variable_expression` string-formatted number. `IS_LESS_THAN`. Is less than the `variable_expression` string-formatted number. `IS_LESS_THAN_OR_EQUAL_TO`. Is less than or equal to the `variable_expression` string-formatted number.
`variable_values`	String array \| Requires Requires `match_operator` is one of: `IS_ONE_OF` `IS_NOT_ONE_OF` Specifies an array of matching strings.
`variable_expression`	String \| Requires Requires `match_operator` is one of: `IS` `IS_NOT` `IS_GREATER_THAN` `IS_GREATER_THAN_OR_EQUAL_TO` `IS_LESS_THAN` `IS_LESS_THAN_OR_EQUAL_TO` Specifies a single matching string.
`lower_bound`	String \| Requires Requires `match_operator` is one of: `IS_BETWEEN` `IS_NOT_BETWEEN` Specifies the range's numeric minimum value.
`upper_bound`	String \| Requires Requires `match_operator` is one of: `IS_BETWEEN` `IS_NOT_BETWEEN` Specifies the range's numeric maximum value.
`match_wildcard`	Boolean \| Requires Requires `match_operator` is one of: `IS` `IS_NOT` `IS_ONE_OF` `IS_NOT_ONE_OF` When matching string expressions, enabling this allows wildcards, where `?` matches a single character and `*` matches zero or more characters.
`match_wildcard`	Boolean \| Requires Requires `match_operator` is one of: `IS` `IS_NOT` `IS_ONE_OF` `IS_NOT_ONE_OF` When matching string expressions, enabling this performs a case-sensitive match.