origin_failure_recovery

Property Manager name: Origin Failure Recovery Policy
Behavior version: The v2024-05-31 rule format supports the origin_failure_recovery_policy behavior v1.0.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

Configures how to detect an origin failure, in which case the origin_failure_recovery_method behavior applies. You can also define up to three sets of criteria to detect origin failure based on specific response codes. Use it to apply specific retry or recovery actions. You can do this using Property Manager. Learn more about this process in Adaptive Media Delivery Implementation Guide. You can use the origin_failure_recovery_method member to edit existing instances of the Origin Failure Recover Method behavior.

Option	Type	Description	Requires
`enabled`	boolean	Activates and configures a recovery policy.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`enable_ip_avoidance`	boolean	Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the `configName` established for `origin_responsiveness_recovery_config_name` is applied.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`ip_avoidance_error_threshold`	number	Defines the number of failures that need to occur to an origin address before it's blocked.	`enable_ip_avoidance` is `true`	{"displayType":"number","tag":"input","type":"number"} {"if":{"attribute":"enableIPAvoidance","op":"eq","value":true}}
`ip_avoidance_retry_interval`	number	Defines the number of seconds after which the IP address is removed from the blocklist.	`enable_ip_avoidance` is `true`	{"displayType":"number","tag":"input","type":"number"} {"if":{"attribute":"enableIPAvoidance","op":"eq","value":true}}
`binary_equivalent_content`	boolean	Synchronizes content between the primary and backup origins, byte for byte.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`monitor_origin_responsiveness`	boolean	Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`origin_responsiveness_timeout`	enum	The timeout threshold that triggers a retry or recovery action.	`monitor_origin_responsiveness` is `true`	{"displayType":"enum","options":["AGGRESSIVE","MODERATE","CONSERVATIVE","USER_SPECIFIED"],"tag":"select"} {"if":{"attribute":"monitorOriginResponsiveness","op":"eq","value":true}}
	`AGGRESSIVE`	A 2 second threshold.
	`MODERATE`	3 seconds.
	`CONSERVATIVE`	4 seconds.
	`USER_SPECIFIED`	Specify your own timeout.
`origin_responsiveness_custom_timeout`	number	Specify a custom timeout, from 1 to 10 seconds.	`origin_responsiveness_timeout` is `USER_SPECIFIED`	{"displayType":"number","tag":"input","type":"number"} {"if":{"attribute":"originResponsivenessTimeout","op":"eq","value":"USER_SPECIFIED"}}
`origin_responsiveness_enable_retry`	boolean	If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.	`monitor_origin_responsiveness` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"monitorOriginResponsiveness","op":"eq","value":true}}
`origin_responsiveness_enable_recovery`	boolean	Enables a recovery action for a specific failure condition.	`monitor_origin_responsiveness` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"monitorOriginResponsiveness","op":"eq","value":true}}
`origin_responsiveness_recovery_config_name`	string	Specifies a recovery configuration using the `configName` you defined in the `recovery_config` match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the `recovery_config` match criteria to apply this option.	`origin_responsiveness_enable_recovery` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"originResponsivenessEnableRecovery","op":"eq","value":true}}
`monitor_status_codes1`	boolean	Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`monitor_response_codes1`	string array	Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (`501`) or a range (`501:504`). If you configure other `monitorStatusCodes` and `monitorResponseCodes` options, you can't use the same codes here.	`monitor_status_codes1` is `true`	{"displayType":"string array","tag":"input","todo":true} {"if":{"attribute":"monitorStatusCodes1","op":"eq","value":true}}
`monitor_status_codes1EnableRetry`	boolean	When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.	`monitor_status_codes1` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"monitorStatusCodes1","op":"eq","value":true}}
`monitor_status_codes1EnableRecovery`	boolean	Enables the recovery action for the response codes you define.	`monitor_status_codes1` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"monitorStatusCodes1","op":"eq","value":true}}
`monitor_status_codes1RecoveryConfigName`	string	Specifies a recovery configuration using the `configName` you defined in the `recovery_config` match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the `recovery_config` match criteria to apply this option.	`monitor_status_codes1EnableRecovery` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"monitorStatusCodes1EnableRecovery","op":"eq","value":true}}
`monitor_status_codes2`	boolean	Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`monitor_response_codes2`	string array	Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (`501`) or a range (`501:504`). If you configure other `monitorStatusCodes` and `monitorResponseCodes` options, you can't use the same codes here.	`monitor_status_codes2` is `true`	{"displayType":"string array","tag":"input","todo":true} {"if":{"attribute":"monitorStatusCodes2","op":"eq","value":true}}
`monitor_status_codes2EnableRetry`	boolean	When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.	`monitor_status_codes2` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"monitorStatusCodes2","op":"eq","value":true}}
`monitor_status_codes2EnableRecovery`	boolean	Enables the recovery action for the response codes you define.	`monitor_status_codes2` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"monitorStatusCodes2","op":"eq","value":true}}
`monitor_status_codes2RecoveryConfigName`	string	Specifies a recovery configuration using the `configName` you defined in the `recovery_config` match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the `recovery_config` match criteria to apply this option.	`monitor_status_codes2EnableRecovery` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"monitorStatusCodes2EnableRecovery","op":"eq","value":true}}
`monitor_status_codes3`	boolean	Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`monitor_response_codes3`	string array	Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (`501`) or a range (`501:504`). If you configure other `monitorStatusCodes` and `monitorResponseCodes` options, you can't use the same codes here..	`monitor_status_codes3` is `true`	{"displayType":"string array","tag":"input","todo":true} {"if":{"attribute":"monitorStatusCodes3","op":"eq","value":true}}
`monitor_status_codes3EnableRetry`	boolean	When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.	`monitor_status_codes3` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"monitorStatusCodes3","op":"eq","value":true}}
`monitor_status_codes3EnableRecovery`	boolean	Enables the recovery action for the response codes you define.	`monitor_status_codes3` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"monitorStatusCodes3","op":"eq","value":true}}
`monitor_status_codes3RecoveryConfigName`	string	Specifies a recovery configuration using the `configName` you defined in the `recovery_config` match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the `recovery_config` match criteria to apply this option.	`monitor_status_codes3EnableRecovery` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"monitorStatusCodes3EnableRecovery","op":"eq","value":true}}