media origin failover

Version: `v2023-09-20`	Includes use: Yes

Behavior name: Media Origin Failover

Specifies how edge servers respond when the origin is unresponsive or suffers from server or content errors. You can specify how many times to retry, switch to a backup origin hostname, or configure a redirect.

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" "media_origin_failover" {
  rules_v2023_09_20 {
    name     = "Media Origin Failover"
    comments = "Specifies how edge servers respond when the origin is unresponsive or suffers from server or content errors."
    behavior {
      media_origin_failover {
        detect_origin_unresponsive = false
        detect_origin_unavailable  = false
        detect_object_unavailable  = false
        other_options              = ""
        client_response_code       = ""
        cache_error_response       = false
      }
    }
  }
}


"behaviors": [
  {
    "name": "mediaOriginFailover",
    "options": {
      "detectOriginUnresponsive": false,
      "detectOriginUnavailable": false,
      "detectObjectUnavailable": false,
      "otherOptions": "",
      "clientResponseCode": "",
      "cacheErrorResponse": false
    }
  }
]

Options

Option	Description
`detect_origin_unresponsive`	Boolean Allows you to configure what happens when the origin is unresponsive.
`origin_unresponsive_detection_level`	Enum \| Requires: `detect_origin_unresponsive` is `true` Specify the level of response to slow origin connections. Value is one of: `AGGRESSIVE` `CONSERVATIVE` `MODERATE`
`origin_unresponsive_blocklist_origin_ip`	Boolean \| Requires: `detect_origin_unresponsive` is `true` Enabling this blocklists the origin's IP address.
`origin_unresponsive_blocklist_window`	Enum \| Requires: `origin_unresponsive_blocklist_origin_ip` is `true` This sets the delay before blocklisting an IP address. Value is one of: `TEN_S`. Ten seconds. `THIRTY_S`. Thirty seconds.
`origin_unresponsive_recovery`	Enum \| Requires: `detect_origin_unresponsive` is `true` This sets the recovery option. Value is one of: `RETRY_X_TIMES`. Retry. `SWITCH_TO_BACKUP_ORIGIN`. Switch to a backup origin. `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION`. Redirect to a different origin.
`origin_unresponsive_retry_limit`	Enum \| Requires: `origin_unresponsive_recovery` is `RETRY_X_TIMES` Sets how many times to retry. Value is one of: `ONE` `TWO` `THREE`
`origin_unresponsive_backup_host`	String \| Requires: `origin_unresponsive_recovery` is `SWITCH_TO_BACKUP_ORIGIN` This specifies the origin hostname.
`origin_unresponsive_alternate_host`	String \| Requires: `origin_unresponsive_recovery` is `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` This specifies the redirect's destination hostname.
`origin_unresponsive_modify_request_path`	Boolean \| Requires Requires `origin_unresponsive_recovery` is one of: `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` `SWITCH_TO_BACKUP_ORIGIN` Modifies the request path.
`origin_unresponsive_modified_path`	String \| Requires: `origin_unresponsive_modify_request_path` is `true` This specifies the path to form the new URL.
`origin_unresponsive_include_query_string`	Boolean \| Requires: `origin_unresponsive_modify_request_path` is `true` Enabling this includes the original set of query parameters.
`origin_unresponsive_redirect_method`	Enum \| Requires: `origin_unresponsive_recovery` is `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` Specifies the redirect response code. Value is one of: `301` `302`
`origin_unresponsive_change_protocol`	Boolean \| Requires Requires `origin_unresponsive_recovery` is one of: `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` `SWITCH_TO_BACKUP_ORIGIN` This allows you to change the request protocol.
`origin_unresponsive_protocol`	Enum \| Requires: `origin_unresponsive_change_protocol` is `true` Specifies which protocol to use. Value is one of: `HTTP` `HTTPS`
`detect_origin_unavailable`	Boolean Allows you to configure failover settings when the origin server responds with errors.
`origin_unavailable_detection_level`	Enum \| Requires: `detect_origin_unavailable` is `true` Specifies how edge servers respond when the origin is unresponsive or suffers from server or content errors. Value is `RESPONSE_CODES`.
`origin_unavailable_response_codes`	String array \| Requires: `detect_origin_unavailable` is `true` Specifies the set of response codes identifying when the origin responds with errors.
`origin_unavailable_blocklist_origin_ip`	Boolean \| Requires: `detect_origin_unavailable` is `true` Enabling this blocklists the origin's IP address.
`origin_unavailable_blocklist_window`	Enum \| Requires: `origin_unavailable_blocklist_origin_ip` is `true` This sets the delay before blocklisting an IP address. Value is one of: `TEN_S`. 10 seconds. `THIRTY_S`. 30 seconds.
`origin_unavailable_recovery`	Enum \| Requires: `detect_origin_unavailable` is `true` This sets the recovery option. Value is one of: `RETRY_X_TIMES`. Retry. `SWITCH_TO_BACKUP_ORIGIN`. Switch to a backup origin. `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION`. Redirect to a different origin.
`origin_unavailable_retry_limit`	Enum \| Requires: `origin_unavailable_recovery` is `RETRY_X_TIMES` Sets how many times to retry. Value is one of: `ONE` `TWO` `THREE`
`origin_unavailable_backup_host`	String \| Requires: `origin_unavailable_recovery` is `SWITCH_TO_BACKUP_ORIGIN` This specifies the origin hostname.
`origin_unavailable_alternate_host`	String \| Requires: `origin_unavailable_recovery` is `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` This specifies the redirect's destination hostname.
`origin_unavailable_modify_request_path`	Boolean \| Requires Requires `origin_unresponsive_recovery` is one of: `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` `SWITCH_TO_BACKUP_ORIGIN` Modifies the request path.
`origin_unavailable_modified_path`	String \| Requires: `origin_unavailable_modify_request_path` is `true` This specifies the path to form the new URL.
`origin_unavailable_include_query_string`	Boolean \| Requires: `origin_unavailable_modify_request_path` is `true` Enabling this includes the original set of query parameters.
`origin_unavailable_redirect_method`	Enum \| Requires: `origin_unavailable_recovery` is `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` Specifies either a redirect response code. Value is one of: `301` `302`
`origin_unavailable_change_protocol`	Boolean \| Requires Requires `origin_unavailable_recovery` is one of: `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` `SWITCH_TO_BACKUP_ORIGIN` Modifies the request protocol.
`origin_unavailable_protocol`	Enum \| Requires: `origin_unavailable_change_protocol` is `true` Specifies the internet protocol type. Value is one of: `HTTP` `HTTPS`
`detect_object_unavailable`	Boolean Allows you to configure failover settings when the origin has content errors.
`object_unavailable_detection_level`	Enum \| Requires: `detect_object_unavailable` is `true` Specify `RESPONSE_CODES` the only available option.
`object_unavailable_response_codes`	String array \| Requires: `detect_object_unavailable` is `true` Specifies the set of response codes identifying when there are content errors.
`object_unavailable_blocklist_origin_ip`	Boolean \| Requires: `detect_object_unavailable` is `true` Enabling this blocklists the origin's IP address.
`object_unavailable_blocklist_window`	Enum \| Requires: `object_unavailable_blocklist_origin_ip` is `true` This sets the delay before blocklisting an IP address. Value is one of: `TEN_S`. Ten seconds. `THIRTY_S`. Thirty seconds.
`object_unavailable_recovery`	Enum \| Requires: `detect_object_unavailable` is `true` This sets the recovery option. Value is one of: `RETRY_X_TIMES`. Retry. `SWITCH_TO_BACKUP_ORIGIN`. Switch to a backup origin. `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION`. Redirect to a different origin.
`object_unavailable_retry_limit`	Enum \| Requires: `origin_unavailable_recovery` is `RETRY_X_TIMES` Sets how many times to retry. Value is one of: `ONE` `TWO` `THREE`
`object_unavailable_backup_host`	String \| Requires: `origin_unavailable_recovery` is `SWITCH_TO_BACKUP_ORIGIN` This specifies the origin hostname.
`object_unavailable_alternate_host`	String \| Requires: `origin_unavailable_recovery` is `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` This specifies the redirect's destination hostname.
`object_unavailable_modify_request_path`	Boolean \| Requires Requires `origin_unavailable_recovery` is one of: `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` `SWITCH_TO_BACKUP_ORIGIN` Enabling this allows you to modify the request path.
`object_unavailable_modified_path`	String \| Requires: `object_unavailable_modify_request_path` is `true` This specifies the path to form the new URL.
`object_unavailable_include_query_string`	Boolean \| Requires: `object_unavailable_modify_request_path` is `true` Enabling this includes the original set of query parameters.
`object_unavailable_redirect_method`	Enum \| Requires: `object_unavailable_recovery` is `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` Specifies a redirect response code. Value is one of: `301` `302`
`object_unavailable_change_protocol`	Boolean \| Requires Requires `origin_unavailable_recovery` is one of: `REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION` `SWITCH_TO_BACKUP_ORIGIN` Changes the request protocol.
`object_unavailable_protocol`	Enum \| Requires: `object_unavailable_change_protocol` is `true` Specifies the internet protocol. Value is one of: `HTTP` `HTTPS`
`client_response_code`	String Specifies the response code served to the client.
`cache_error_response`	Boolean When enabled, caches the error response.
`cache_window`	Enum \| Requires: `cache_error_response` is `true` This sets error response's TTL. Value is one of: `ONE_S`. One second. `TEN_S`. Ten seconds. `THIRTY_S`. Thirty seconds.