Type Alias CreateBackendRequest

CreateBackendRequest: {
    failoverHost?: string;
    forwardPort: number;
    forwardPortAlgorithm: ForwardPortAlgorithm;
    forwardProtocol: Protocol;
    healthCheck: HealthCheck;
    ignoreSslServerVerify?: boolean;
    lbId: string;
    maxConnections?: number;
    maxRetries?: number;
    name?: string;
    onMarkedDownAction?: OnMarkedDownAction;
    proxyProtocol?: ProxyProtocol;
    redispatchAttemptCount?: number;
    region?: Region;
    sendProxyV2?: boolean;
    serverIp: string[];
    sslBridging?: boolean;
    stickySessions: StickySessionsType;
    stickySessionsCookieName: string;
    timeoutConnect?: string;
    timeoutQueue?: string;
    timeoutServer?: string;
    timeoutTunnel?: string;
}

Type declaration

  • OptionalfailoverHost?: string

    Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

  • forwardPort: number

    Port to be used by the backend when forwarding traffic to backend servers.

  • forwardPortAlgorithm: ForwardPortAlgorithm

    Load balancing algorithm to be used when determining which backend server to forward new traffic to.

  • forwardProtocol: Protocol

    Protocol to be used by the backend when forwarding traffic to backend servers.

  • healthCheck: HealthCheck

    Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

  • OptionalignoreSslServerVerify?: boolean

    Defines whether the server certificate verification should be ignored.

  • lbId: string

    Load Balancer ID.

  • OptionalmaxConnections?: number

    Maximum number of connections allowed per backend server.

  • OptionalmaxRetries?: number

    Number of retries when a backend server connection failed.

  • Optionalname?: string

    Name for the backend.

  • OptionalonMarkedDownAction?: OnMarkedDownAction

    Action to take when a backend server is marked as down.

  • OptionalproxyProtocol?: ProxyProtocol

    Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.

  • OptionalredispatchAttemptCount?: number

    Whether to use another backend server on each attempt.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • OptionalsendProxyV2?: boolean

    Deprecated

    Deprecated in favor of proxy_protocol field.

  • serverIp: string[]

    List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to.

  • OptionalsslBridging?: boolean

    Defines whether to enable SSL bridging between the Load Balancer and backend servers.

  • stickySessions: StickySessionsType

    Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.

  • stickySessionsCookieName: string

    Cookie name for cookie-based sticky sessions.

  • OptionaltimeoutConnect?: string

    Maximum allowed time for establishing a connection to a backend server.

  • OptionaltimeoutQueue?: string

    Maximum time for a request to be left pending in queue when max_connections is reached.

  • OptionaltimeoutServer?: string

    Maximum allowed time for a backend server to process a request.

  • OptionaltimeoutTunnel?: string

    Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout).

Settings