schedule_​invalidation

Version: v2024-10-21Includes use: Yes

Behavior name: Scheduled Invalidation

Specifies when cached content that satisfies a rule's criteria expires, optionally at repeating intervals. In addition to periodic cache flushes, you can use this behavior to minimize potential conflicts when related objects expire at different times.

Warning: Scheduled invalidations can significantly increase origin servers' load when matching content expires simultaneously across all edge servers.

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" "schedule_invalidation" {
  rules_v2024-10-21 {
    name     = "Scheduled Invalidation"
    comments = "Specifies when cached content expires."
    behavior {
      schedule_invalidation {
        start          = ""
        repeat         = false
        refresh_method = "INVALIDATE"
      }
    }
  }
}

"behaviors": [
  {
    "name": "scheduleInvalidation",
    "options": {
      "start": "",
      "repeat": false,
      "refreshMethod": "INVALIDATE"
    }
  }
]

Options

Option Description
start
The UTC date and time when matching cached content is to expire.
repeat
When enabled, invalidation recurs periodically from the start time based on the repeat_interval time.
repeat_interval
Specifies how often to invalidate content from the start time in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day. Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.
refresh_method
Specifies how to invalidate the content. Value is one of:
  • INVALIDATE. Sends an If-Modified-Since request to the origin, re-caching the content only if it is fresher.
  • PURGE. Re-caches content regardless of its freshness, potentially creating more traffic at the origin.