application load balancer

Property Manager name: Application Load Balancer Cloudlet
Behavior version: The v2025-01-13 rule format supports the application_load_balancer behavior v1.10.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: No (temporarily)

Enables the Application Load Balancer Cloudlet, which automates load balancing based on configurable criteria. To configure this behavior, use either the Cloudlets Policy Manager or the Cloudlets API to set up a policy.

Option	Type	Description	Requires
`enabled`	boolean	Activates the Application Load Balancer Cloudlet.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`cloudlet_policy`	object	Identifies the Cloudlet policy.		{"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"enabled","op":"eq","value":true}}
`cloudlet_policy.id`	number	Identifies the Cloudlet.
`cloudlet_policy.name`	string	The Cloudlet's descriptive name.
`label`	string	A label to distinguish this Application Load Balancer policy from any others within the same property.		{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`stickiness_cookie_type`	enum	Determines how a cookie persistently associates the client with a load-balanced origin.		{"displayType":"enum","options":["NONE","NEVER","ON_BROWSER_CLOSE","FIXED_DATE","DURATION","ORIGIN_SESSION"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`NONE`	Dynamically reassigns different load-balanced origins for each request.
	`NEVER`	Preserves the cookie indefinitely.
	`ON_BROWSER_CLOSE`	Limit the cookie duration to browser sessions.
	`FIXED_DATE`	Specify a specific time for when the cookie expires.
	`DURATION`	Specify a delay for when the cookie expires.
	`ORIGIN_SESSION`	Limit the cookie duration to when the `ORIGIN_SESSION` terminates. (After the cookie expires, the cookie type re-evaluates.)
`stickiness_expiration_date`	string (epoch timestamp)	Specifies when the cookie expires.	`stickiness_cookie_type` is `FIXED_DATE`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"eq","value":"FIXED_DATE"}]}}
`stickiness_duration`	string (duration)	Sets how long it is before the cookie expires.	`stickiness_cookie_type` is `DURATION`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"eq","value":"DURATION"}]}}
`stickiness_refresh`	boolean	Extends the duration of the cookie with each new request. When enabled, the `DURATION` thus specifies the latency between requests that would cause the cookie to expire.	`stickiness_cookie_type` is `DURATION`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"eq","value":"DURATION"}]}}
`origin_cookie_name`	string	Specifies the name for your session cookie.	`stickiness_cookie_type` is `ORIGIN_SESSION`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"eq","value":"ORIGIN_SESSION"}]}}
`specify_stickiness_cookie_domain`	boolean	Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.	`stickiness_cookie_type` is either: `ON_BROWSER_CLOSE`, `FIXED_DATE`, `DURATION`, `NEVER`, `ORIGIN_SESSION`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"in","value":["ON_BROWSER_CLOSE","FIXED_DATE","DURATION","NEVER","ORIGIN_SESSION"]}]}}
`stickiness_cookie_domain`	string	Specifies the domain to track the stickiness cookie.	`specify_stickiness_cookie_domain` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"specifyStickinessCookieDomain","op":"eq","value":true}]}}
`stickiness_cookie_automatic_salt`	boolean	Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.	`stickiness_cookie_type` is either: `ON_BROWSER_CLOSE`, `FIXED_DATE`, `DURATION`, `NEVER`, `ORIGIN_SESSION`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"in","value":["ON_BROWSER_CLOSE","FIXED_DATE","DURATION","NEVER","ORIGIN_SESSION"]}]}}
`stickiness_cookie_salt`	string	Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.	`stickiness_cookie_automatic_salt` is `false`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieAutomaticSalt","op":"eq","value":false}]}}
`stickiness_cookie_set_http_only_flag`	boolean	Ensures the cookie is transmitted only over HTTP.	`stickiness_cookie_type` is either: `ON_BROWSER_CLOSE`, `FIXED_DATE`, `DURATION`, `NEVER`, `ORIGIN_SESSION`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"in","value":["ON_BROWSER_CLOSE","FIXED_DATE","DURATION","NEVER","ORIGIN_SESSION"]}]}}
`all_down_net_storage`	object	Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.		{"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"enabled","op":"eq","value":true}}
`all_down_net_storage.cpCode`	integer	Identifies a CP code assigned to this storage group.
`all_down_net_storage.downloadDomainName`	string	Domain name from which content can be downloaded.
`all_down_net_storage.g2oToken`	string	Signature Header Authentication key.
`all_down_net_storage.id`	integer	Unique identifier for the storage group.
`all_down_net_storage.name`	string	Name of the storage group.
`all_down_net_storageFile`	string	Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.		{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`all_down_status_code`	string	Specifies the HTTP response code when all load-balancing origins are unavailable.		{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`failover_status_codes`	string array	Specifies a set of HTTP status codes that signal a failure on the origin, in which case the cookie that binds the client to that origin is invalidated and the client is rerouted to another available origin.		{"displayType":"string array","tag":"input","todo":true} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true}]}}
`failover_mode`	enum	Determines what to do if an origin fails.		{"displayType":"enum","options":["AUTOMATIC","MANUAL","DISABLED"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`AUTOMATIC`	Automatically determines which origin in the policy to try next.
	`MANUAL`	You define a sequence of failover origins. (If failover runs out of origins, requests are sent to NetStorage.)
	`DISABLED`	Turns off failover, but maintains origin stickiness even when the origin goes down.
`failover_origin_map`	object array	Specifies a fixed set of failover mapping rules.	`failover_mode` is `MANUAL`	{"displayType":"object array","tag":"input","todo":true} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"failoverMode","op":"eq","value":"MANUAL"}]}}
`failover_origin_map[].from_origin_id`	string	Specifies the origin whose failure triggers the mapping rule.		{"displayType":"string","tag":"input","type":"text"}
`failover_origin_map[].to_origin_ids`	string array	Requests stuck to the `from_origin_id` origin retry for each alternate origin `to_origin_ids`, until one succeeds.		{"displayType":"string array","tag":"input","todo":true}
`failover_attempts_threshold`	number	Sets the number of failed requests that would trigger the failover process.	`failover_mode` is either: `MANUAL`, `AUTOMATIC`	{"displayType":"number","tag":"input","type":"number"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"failoverMode","op":"in","value":["MANUAL","AUTOMATIC"]}]}}
`allow_cache_prefresh`	boolean	Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}