fail_action

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

Behavior name: Site Failover

Specifies how to respond when the origin is not available: by serving stale content, by serving an error page, or by redirecting. To apply this behavior, you should match on an origin_timeout or match_response_code.

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" "fail_action" {
  rules_v2023_09_20 {
    name     = "Site Failover"
    comments = "Specifies how to respond when the origin is not available"
    behavior {
      fail_action {
        enabled                = true
        action_type            = "REDIRECT"
        redirect_hostname_type = "ALTERNATE"
        redirectHostname       = ""
        redirect_custom_path   = true
        redirect_path          = ""
        redirect_method        = 302
        preserve_query_string  = true
        modify_protocol        = false
      }
    }
  }
}

"behaviors": [
  {
  "name": "failAction",
  "options": {
    "enabled": true,
    "actionType": "REDIRECT",
    "redirectHostnameType": "ALTERNATE",
    "redirectHostname": "",
    "redirectCustomPath": true,
    "redirectPath": "",
    "redirectMethod": 302,
    "preserveQueryString": true,
    "modifyProtocol": false
    }
  }
]

Options

Option	Description
`enabled`	Boolean When enabled in case of a failure to contact the origin, the current behavior applies.
`action_type`	Enum Specifies the basic action to take when there is a failure to contact the origin. Value is one of: `SERVE_STALE`. Serves content that is already in the cache. `REDIRECT`. Specifies a redirect action. Use with these options: `redirect_hostname_type` `redirect_hostname` `redirect_custom_path` `redirect_path` `redirect_method` `modify_protocol` `protocol` `RECREATED_CO`. Serves alternate content from your network. Use with these options: `content_hostname` `content_custom_path` `content_path` `RECREATED_CEX`. Serves alternate content from an external network. Use with these options: `cex_hostname` `cex_custom_path` `cex_path` `RECREATED_NS`. Serves NetStorage content. Use with these options: `net_storage_hostname` `net_storage_path` `cp_code` `DYNAMIC`. Allows you to serve dynamic SaaS content if SaaS acceleration is available on your contract. Use with these options: `dynamic_method` `dynamic_custom_path` `saas_type` `saas_suffix` `saas_regex` `saas_replace`
`saas_type`	Enum \| Requires: `action_type` is `DYNAMIC` Identifies the component of the request that identifies the SaaS dynamic fail action. Value is one of: `COOKIE` `HOSTNAME` `PATH` `QUERY_STRING`
`saas_cname_enabled`	Boolean \| Requires: `saas_type` is `HOSTNAME` Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic fail action.
`saas_cname_level`	Number \| Requires: `saas_cname_enabled` is `true` Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic fail action.
`saas_cookie`	String \| Requires: `saas_type` is `COOKIE` Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic fail action.
`saas_query_string`	String \| Requires: `saas_type` is `QUERY_STRING` Specifies the name of the query parameter that identifies this SaaS dynamic fail action.
`saas_regex`	String \| Requires: `action_type` is `DYNAMIC` Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic fail action.
`saas_replace`	String \| Requires: `action_type` is `DYNAMIC` Specifies the replacement pattern that defines the SaaS dynamic fail action.
`saas_suffix`	String \| Requires: `action_type` is `DYNAMIC` Specifies the static portion of the SaaS dynamic fail action.
`dynamic_method`	Enum \| Requires: `action_type` is `DYNAMIC` Specifies the redirect method. Value is one of: `SERVE_301`. A 301 redirect response. `SERVE_302`. A 302 redirect response. `SERVE_ALTERNATE`. Serve an alternate response.
`dynamic_custom_path`	Boolean \| Requires: `action_type` is `DYNAMIC` Allows you to modify the original requested path.
`dynamic_path`	String \| Requires: `dynamic_custom_path` is `true` Specifies the new path.
`redirect_hostname_type`	Enum \| Requires: `action_type` is `REDIRECT` Whether to preserve or customize the hostname. Value is one of: `ORIGINAL`. Preserve the original hostname in the redirect. `ALTERNATE`. Specify a `redirect_hostname`.
`redirect_hostname`	String \| Requires: `redirect_hostname_type` is `ALTERNATE` When the `action_type` is `REDIRECT` and the `redirect_hostname_type` is `ALTERNATE` this specifies the hostname for the redirect.
`redirect_custom_path`	Boolean \| Requires: `action_type` is `REDIRECT` Uses the `redirect_path` to customize a new path.
`redirect_path`	Boolean \| Requires: `redirect_custom_path` is `true` Specifies a new path.
`redirect_method`	Enum \| Requires: `action_type` is `REDIRECT` Specifies the HTTP response code. Value is one of: `301` `302`
`content_hostname`	Boolean \| Requires: `action_type` is `RECREATED_CO` Specifies the static hostname for the alternate redirect.
`content_custom_path`	Boolean \| Requires: `action_type` is `RECREATED_CO` Specifies a custom redirect path.
`content_path`	String \| Requires: `content_custom_path` is `true` Specifies a custom redirect path.
`net_storage_hostname`	Object \| Requires: `action_type` is `RECREATED_NS` When the `action_type` is `RECREATED_NS` specifies the NetStorage origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin's `id`. Contains: `cp_code`. Identifies a CP code assigned to this storage group. `download_domain_name`. Domain name from which content can be downloaded. `g2o_token`. Signature Header Authentication key. `id`. Unique identifier for the storage group. `name`. Name of the storage group.
`net_storage_path`	String \| Requires: `action_type` is `RECREATED_NS` When the `action_type` is `RECREATED_NS` specifies the path for the NetStorage request.
`cex_hostname`	String \| Requires: `action_type` is `RECREATED_CEX` Specifies a hostname.
`cex_custom_path`	Boolean \| Requires: `action_type` is `RECREATED_CEX` Specifies a custom path.
`cex_path`	Boolean \| Requires: `cex_custom_path` is `true` Specifies a custom path.
`cp_code`	Object \| Requires: `action_type` is `RECREATED_NS` Specifies a CP code for which to log errors for the NetStorage location. Contains a CP code `id` without the prefix.
`status_code`	Enum \| Requires: `action_type` is `RECREATED_NS` Assigns a new HTTP status code to the failure response. Value is one of: `100` `101` `102` `103` `122` `200` `201` `202` `203` `204` `205` `206` `207` `226` `400` `401` `402` `403` `404` `405` `406` `407` `408` `409` `410` `411` `412` `413` `414` `415` `416` `417` `422` `423` `424` `428` `429` `431` `444` `449` `450` `499` `500` `501` `502` `503` `504` `505` `506` `507` `509` `510` `511` `598` `599`
`preserve_query_string`	Boolean \| Requires Requires one is `true`: `content_custom_path` `cex_custom_path` `cex_custom_path` When using either `content_custom_path`, `cex_custom_path`, `dynamic_custom_path`, or `redirect_custom_path` to specify a custom path, enabling this passes in the original request's query string as part of the path.
`modify_protocol`	Boolean \| Requires Requires one of: `action_type` is `REDIRECT` `dynamic_method` is either `SERVE_301` or `SERVE_302` Modifies the redirect's protocol using the value of the `protocol` field.
`protocol`	Enum \| Requires: `modify_protocol` is `true` When the `action_type` is `REDIRECT` and `modify_protocol` is enabled, this specifies the redirect's protocol. Value is one of: `HTTP` `HTTPS`