cache_​tag

Version: v2024-02-12Includes use: Yes

Behavior name: Cache Tag

This adds a cache tag to the requested object. With cache tags, you can flexibly fast purge tagged segments of your cached content. You can either define these tags with an Edge-Cache-Tag header at the origin server level, or use this behavior to directly add a cache tag to the object as the edge server caches it. The cacheTag behavior can only take a single value, including a variable. If you want to specify more tags for an object, add a few instances of this behavior to your configuration.

For guidance on deploying cache tags, see Fast Purge.

Use the Fast Purge API to purge by cache tag programmatically.

Note: This behavior is not compatible with the dynamic_throughtput_optimization behavior

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" "cache_tag" {
  rules_v2024-02-12 {
    name     = "Cache Tag"
    comments = "Adds a cache tag to the requested object."
    behavior {
      cache_tag {
        tag = ""
      }
    }
  }
}
"behaviors": [
  {
    "name": "cacheTag",
    "options": {
      "tag": ""
    }
  }
]

Options

Option Description
tag
Specifies the cache tag you want to add to your cached content. A cache tag is only added when the object is first added to cache. A single cache tag can't exceed 128 characters and can only include alphanumeric characters, plus this class of characters: [!#$%'+./^_`|~-].