edge_load_balancing_data

Property Manager name: Edge Load Balancing: Data Center
Behavior version: The v2024-01-09 rule format supports the edge_load_balancing_data_center behavior v1.2.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: No (temporarily)

The Edge Load Balancing module allows you to specify groups of data centers that implement 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 details about a data center, and needs to be paired in the same rule with an edge_load_balancing_origin behavior, which specifies its origin. 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. More than one data center can thus refer to the same origin.

Option	Type	Description	Requires
`origin_id`	string	Corresponds to the `id` specified by the `edge_load_balancing_origin` behavior associated with this data center.		{"displayType":"string","tag":"input","type":"text"}
`description`	string	Provides a description for the ELB data center, for your own reference.		{"displayType":"string","tag":"input","type":"text"}
`hostname`	string	Specifies the data center's hostname.		{"displayType":"string","tag":"input","type":"text"}
`cookie_name`	string	If using session persistence, this specifies the value of the cookie named in the corresponding `edge_load_balancing_origin` behavior's `cookie_name` option.		{"displayType":"string","tag":"input","type":"text"}
`enable_failover`	boolean	Allows you to specify failover rules.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`ip`	string	Specifies this data center's IP address.	`enable_failover` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enableFailover","op":"eq","value":true}}
`failover_rules`	object array	Provides up to four failover rules to apply in the specified order.	`enable_failover` is `true`	{"displayType":"object array","tag":"input","todo":true} {"if":{"attribute":"enableFailover","op":"eq","value":true}}
`failover_rules[].failover_hostname`	string	The hostname of the data center to fail over to.		{"displayType":"string","tag":"input","type":"text"}
`failover_rules[].modify_request`	boolean	Allows you to modify the request's hostname or path.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`failover_rules[].override_hostname`	boolean	Overrides the request's hostname with the `failover_hostname`.	`modify_request` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"modifyRequest","op":"eq","value":true}}
`failover_rules[].context_root`	string	Specifies the path to use in the forwarding request, typically the root (`/`) when failing over to a different data center, or a full path such as `/static/error.html` when failing over to an error page.	`modify_request` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"modifyRequest","op":"eq","value":true}}
`failover_rules[].absolute_path`	boolean	When enabled, interprets the path specified by `context_root` as an absolute server path, for example to reference a site-down page. Otherwise when disabled, the path is appended to the request.	`modify_request` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"modifyRequest","op":"eq","value":true}}