edge_​load_​balancing_​origin

Version: v2025-01-13Includes use: No

Behavior name: Edge Load Balancing: Origin Definition

The Edge Load Balancing module allows you to implement groups of data centers featuring load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify.

This behavior specifies the data center's origin, and needs to be paired in the same rule with at least one edge_load_balancing_data_center behavior, which provides details about a particular data center. An origin is an abstraction that helps group a logical set of a website or application. It potentially includes information about many data centers and cloud providers, as well as many end points or IP addresses for each data center. To specify an ELB origin, you need to have configured an origin behavior whose type is set to elb_origin_group.

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" "edge_load_balancing_origin" {
  rules_v2025_02_18 {
    name     = "Edge Load Balancing: Origin Definition"
    comments = "Specifies a data center's origin."
    behavior {
      edge_load_balancing_origin {
        id                         = ""
        description                = ""
        hostname                   = ""
        enable_session_persistence = false
      }
    }
  }
}
"behaviors": [
  {
  "name": "edgeLoadBalancingOrigin",
  "options": {
    "id": "",
    "description": "",
    "hostname": "",
    "enableSessionPersistence": false
    }
  }
]

Options

Option Description
id
Specifies a unique descriptive string for this ELB origin. The value needs to match the origin_id specified by the edge_load_balancing_data_center behavior associated with this origin.
description
Provides a description for the ELB origin, for your own reference.
hostname
Specifies the hostname associated with the ELB rule.
enable_session_persistence
Allows you to specify a cookie to pin the user's browser session to one data center. When disabled, ELB's default load balancing may send users to various data centers within the same session.
cookie_name
This specifies the name of the cookie that marks users' persistent sessions. The accompanying edge_load_balancing_data_center behavior's description option specifies the cookie's value.