im_override

Suggest Edits

Version: `v2025-01-13`	Includes use: Yes

Behavior name: Image and Video Manager: Set Parameter

This specifies common query parameters that affect how image_manager transforms images, potentially overriding policy, width, format, or density request parameters. This also allows you to assign the value of one of the property's rule tree variables to one of Image and Video Manager's own policy variables.

Default behavior

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

data "akamai_property_rules_builder" "im_override" {
  rules_v2025_02_18 {
    name     = "Image and Video Manager: Set Parameter"
    comments = "Specifies common query parameters that affect how image_manager transforms images"
    behavior {
      im_override {
        override = "POLICY"
        typesel  = "VALUE"
        policy   = ""
      }
    }
  }
}

"behaviors": [
  {
  "name": "imOverride",
  "options": {
    "override": "POLICY",
    "typesel": "VALUE",
    "policy": ""
    }
  }
]

Options

Option	Description
`override`	Enum Selects the type of query parameter you want to set. Value is one of: `POLICY`. For the name of the Image and Video Manager policy you want to apply. `POLICY_VARIABLE`. Specify that you want to set an Image and Video Manager policy variable from a rule tree variable defined in the property. `WIDTH`. A predefined width to constrain the image to. `FORMAT`. For browser types. `DPR`. For pixel density. `EXCLUDE_QUERY`. Excludes the specified query parameters from the cache key.
`typesel`	Enum \| Requires Requires `override` isn't one of: `POLICY_VARIABLE` `EXCLUDE_QUERY` Specifies how to set a query parameter. Value is one of: `VALUE`. Assign a specific value. `VARIABLE`. Assign a Property Manager rule tree `VARIABLE`.
`formatvar`	String \| Requires Requires both: `override` is `FORMAT` `typesel` is `VARIABLE` This selects the variable with the name of the browser for which you want to optimize images. The variable specifies the same type of data as the `format` option.
`format`	Enum \| Requires Requires both: `override` is `FORMAT` `typesel` is `VALUE` Specifies the type of the browser, or the encodings passed in the `Accept` header, that you want to optimize images for. Value is one of: `CHROME`. Google Chrome. `IE`. Internet Explorer. `SAFARI`. Apple Safari. `GENERIC`. Generic. `AVIF_WEBP_JPEG_PNG_GIF`. Best of AVIF, WebP, JPEG, PNG, and GIF. `JP2_WEBP_JPEG_PNG_GIF`. Best of JP2, WebP, JPEG, PNG, and GIF. `WEBP_JPEG_PNG_GIF`. Best of WebP, JPEG, PNG, and GIF. `JPEG_PNG_GIF`. Best of JPEG, PNG, GIF.
`dprvar`	String \| Requires Requires both: `override` is `DPR` `typesel` is `VARIABLE` This selects the variable with the desired pixel density. The variable specifies the same type of data as the `dpr` option.
`dpr`	Number Requires Requires both: `override` is `DPR` `typesel` is `VALUE` Directly specifies the pixel density. The numeric value is a scaling factor of 1, representing normal density.
`widthvar`	String \| Requires Requires both: `override` is `WIDTH` `typesel` is `VARIABLE` Selects the variable with the desired width. If the Image and Video Manager policy doesn't define that width, it serves the next largest width.
`width`	Number \| Requires Requires both: `override` is `WIDTH` `typesel` is `VARIABLE` Sets the image's desired pixel width directly. If the Image Manager policy doesn't define that width, it serves the next largest width.
`policyvar`	String \| Requires Requires both: `override` is `POLICY` `typesel` is `VARIABLE` This selects the variable with the desired Image and Video Manager policy name to apply to image requests. If there is no policy by that name, Image and Video Manager serves the image unmodified.
`policy`	String \| Requires Requires both: `override` is `POLICY` `typesel` is `VALUE` This selects the desired Image and Video Manager policy name directly. If there is no policy by that name, Image and Video Manager serves the image unmodified.
`policyvar_name`	String \| Requires: `override` is `POLICY_VARIABLE` This selects the name of one of the variables defined in an Image and Video Manager policy that you want to replace with the property's rule tree variable.
`policyvar_i_mvar`	String \| Requires: `override` is `POLICY_VARIABLE` This selects one of the property's rule tree variables to assign to the `policyvar_name` variable within Image and Video Manager.
`exclude_all_query_parameters`	Boolean \| Requires: `override` is `EXCLUDE_QUERY` Whether to exclude all query parameters from the Image and Video Manager cache key.
`excluded_query_parameters`	String array \| Requires Requires both: `override` is `EXCLUDE_QUERY` `exclude_all_query_parameters` is `false` Specifies individual query parameters to exclude from the Image and Video Manager cache key.

Updated about 1 hour ago