View a markdown version of this page

DistributionCustomErrorResponse - Amazon Lightsail

DistributionCustomErrorResponse

Describes a custom error response for a Lightsail distribution. A custom error response specifies the page that the distribution returns to the viewer. It also specifies the HTTP status code that the distribution sends when the origin responds with a given HTTP error code.

Contents

errorCachingMinTTL

The minimum time, in seconds, that the distribution caches the custom error response before requesting the object again from the origin. If you don't specify a value, the default is 10 seconds.

Type: Long

Required: No

errorCode

The HTTP error code from the origin that triggers the custom error response (for example, 403 or 404).

Type: Integer

Required: No

responseCode

The HTTP status code that the distribution returns to the viewer for the custom error response.

Type: String

Required: No

responsePagePath

The path to the custom error page that the distribution returns to the viewer (for example, /404.html). The path must begin with a forward slash (/) and reference an object that is available from the origin.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: