limit_​bit_​rate

Version: v2025-01-13Includes use: Yes

Behavior name: Bit Rate Limiting

Control the rate at which content serves out to end users, optionally varying the speed depending on the file size or elapsed download time. Each bit rate specified in the bitrate_table array corresponds to a threshold_table entry that activates it. You can use this behavior to prevent media downloads from progressing faster than they are viewed, for example, or to differentiate various tiers of end-user experience. To apply this behavior, you should match on a content_type, path, or filename.

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" "limit_bit_rate" {
  rules_v2025_02_18 {
    name     = "Bit Rate Limiting"
    comments = "Controls the rate at which content serves out to end users."
    behavior {
      limit_bit_rate {
        enabled = false
      }
    }
  }
}
"behaviors": [
  {
  "name": "limitBitRate",
  "options": {
    "enabled": false
    }
  }
]

Options

Option Description
enabled
When enabled, activates the bit rate limiting behavior.
bitrate_table
Specifies a download rate that corresponds to a threshold_table entry. Contains:
  • bitrate_value. The numeric indicator of the download rate.
  • bitrate_unit. The unit of measurement. Value is one of:
    • Kbps
    • Mbps
    • Gbps
threshold_table
Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrate_table entry. Contains:
  • threshold_value. The numeric indicator of the minimum file size or elapsed download time.
  • threshold_unit. The unit of measurement. Value is one of:
    • SECONDS
    • BYTES