lightsail/aws.sdk.kotlin.services.lightsail.model/DistributionCustomErrorResponse

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.

Types

Builder

class Builder

Companion

object Companion

Properties

errorCachingMinTtl

val errorCachingMinTtl: Long?

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.

errorCode

val errorCode: Int?

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

responseCode

val responseCode: String?

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

responsePagePath

val responsePagePath: String?

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.

Functions

copy

inline fun copy(block: DistributionCustomErrorResponse.Builder.() -> Unit = {}): DistributionCustomErrorResponse

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String