Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. LoadbalancerBackend
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.LoadbalancerBackend

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway
Deprecated: scaleway.index/loadbalancerbackend.LoadbalancerBackend has been deprecated in favor of scaleway.loadbalancers/backend.Backend

Creates and manages Scaleway Load Balancer backends.

or more information, see the main documentation or API documentation.

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const backend01 = new scaleway.loadbalancers.Backend("backend01", {
    lbId: lb01.id,
    name: "backend01",
    forwardProtocol: "http",
    forwardPort: 80,
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

backend01 = scaleway.loadbalancers.Backend("backend01",
    lb_id=lb01["id"],
    name="backend01",
    forward_protocol="http",
    forward_port=80)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/loadbalancers"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancers.NewBackend(ctx, "backend01", &loadbalancers.BackendArgs{
			LbId:            pulumi.Any(lb01.Id),
			Name:            pulumi.String("backend01"),
			ForwardProtocol: pulumi.String("http"),
			ForwardPort:     pulumi.Int(80),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var backend01 = new Scaleway.Loadbalancers.Backend("backend01", new()
    {
        LbId = lb01.Id,
        Name = "backend01",
        ForwardProtocol = "http",
        ForwardPort = 80,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.loadbalancers.Backend;
import com.pulumi.scaleway.loadbalancers.BackendArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var backend01 = new Backend("backend01", BackendArgs.builder()
            .lbId(lb01.id())
            .name("backend01")
            .forwardProtocol("http")
            .forwardPort("80")
            .build());

    }
}
Copy
resources:
  backend01:
    type: scaleway:loadbalancers:Backend
    properties:
      lbId: ${lb01.id}
      name: backend01
      forwardProtocol: http
      forwardPort: '80'
Copy

With HTTP Health Check

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const backend01 = new scaleway.loadbalancers.Backend("backend01", {
    lbId: lb01.id,
    name: "backend01",
    forwardProtocol: "http",
    forwardPort: 80,
    healthCheckHttp: {
        uri: "/health",
    },
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

backend01 = scaleway.loadbalancers.Backend("backend01",
    lb_id=lb01["id"],
    name="backend01",
    forward_protocol="http",
    forward_port=80,
    health_check_http={
        "uri": "/health",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/loadbalancers"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancers.NewBackend(ctx, "backend01", &loadbalancers.BackendArgs{
			LbId:            pulumi.Any(lb01.Id),
			Name:            pulumi.String("backend01"),
			ForwardProtocol: pulumi.String("http"),
			ForwardPort:     pulumi.Int(80),
			HealthCheckHttp: &loadbalancers.BackendHealthCheckHttpArgs{
				Uri: pulumi.String("/health"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var backend01 = new Scaleway.Loadbalancers.Backend("backend01", new()
    {
        LbId = lb01.Id,
        Name = "backend01",
        ForwardProtocol = "http",
        ForwardPort = 80,
        HealthCheckHttp = new Scaleway.Loadbalancers.Inputs.BackendHealthCheckHttpArgs
        {
            Uri = "/health",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.loadbalancers.Backend;
import com.pulumi.scaleway.loadbalancers.BackendArgs;
import com.pulumi.scaleway.loadbalancers.inputs.BackendHealthCheckHttpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var backend01 = new Backend("backend01", BackendArgs.builder()
            .lbId(lb01.id())
            .name("backend01")
            .forwardProtocol("http")
            .forwardPort("80")
            .healthCheckHttp(BackendHealthCheckHttpArgs.builder()
                .uri("/health")
                .build())
            .build());

    }
}
Copy
resources:
  backend01:
    type: scaleway:loadbalancers:Backend
    properties:
      lbId: ${lb01.id}
      name: backend01
      forwardProtocol: http
      forwardPort: '80'
      healthCheckHttp:
        uri: /health
Copy

Create LoadbalancerBackend Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LoadbalancerBackend(name: string, args: LoadbalancerBackendArgs, opts?: CustomResourceOptions);
@overload
def LoadbalancerBackend(resource_name: str,
                        args: LoadbalancerBackendArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def LoadbalancerBackend(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        failover_host: Optional[str] = None,
                        forward_port: Optional[int] = None,
                        forward_port_algorithm: Optional[str] = None,
                        forward_protocol: Optional[str] = None,
                        health_check_delay: Optional[str] = None,
                        health_check_http: Optional[LoadbalancerBackendHealthCheckHttpArgs] = None,
                        health_check_https: Optional[LoadbalancerBackendHealthCheckHttpsArgs] = None,
                        health_check_max_retries: Optional[int] = None,
                        health_check_port: Optional[int] = None,
                        health_check_send_proxy: Optional[bool] = None,
                        health_check_tcp: Optional[LoadbalancerBackendHealthCheckTcpArgs] = None,
                        health_check_timeout: Optional[str] = None,
                        health_check_transient_delay: Optional[str] = None,
                        ignore_ssl_server_verify: Optional[bool] = None,
                        lb_id: Optional[str] = None,
                        max_connections: Optional[int] = None,
                        max_retries: Optional[int] = None,
                        name: Optional[str] = None,
                        on_marked_down_action: Optional[str] = None,
                        proxy_protocol: Optional[str] = None,
                        redispatch_attempt_count: Optional[int] = None,
                        send_proxy_v2: Optional[bool] = None,
                        server_ips: Optional[Sequence[str]] = None,
                        ssl_bridging: Optional[bool] = None,
                        sticky_sessions: Optional[str] = None,
                        sticky_sessions_cookie_name: Optional[str] = None,
                        timeout_connect: Optional[str] = None,
                        timeout_queue: Optional[str] = None,
                        timeout_server: Optional[str] = None,
                        timeout_tunnel: Optional[str] = None)
func NewLoadbalancerBackend(ctx *Context, name string, args LoadbalancerBackendArgs, opts ...ResourceOption) (*LoadbalancerBackend, error)
public LoadbalancerBackend(string name, LoadbalancerBackendArgs args, CustomResourceOptions? opts = null)
public LoadbalancerBackend(String name, LoadbalancerBackendArgs args)
public LoadbalancerBackend(String name, LoadbalancerBackendArgs args, CustomResourceOptions options)

type: scaleway:LoadbalancerBackend
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LoadbalancerBackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LoadbalancerBackendArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LoadbalancerBackendArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LoadbalancerBackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LoadbalancerBackendArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

LoadbalancerBackend Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The LoadbalancerBackend resource accepts the following input properties:

ForwardPort This property is required. int
User sessions will be forwarded to this port of backend servers
ForwardProtocol This property is required. string
Backend protocol
LbId
This property is required.
Changes to this property will trigger replacement.
string
The load-balancer ID
FailoverHost string
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
ForwardPortAlgorithm string
Load balancing algorithm
HealthCheckDelay string
Interval between two HC requests
HealthCheckHttp Pulumiverse.Scaleway.Inputs.LoadbalancerBackendHealthCheckHttp
HealthCheckHttps Pulumiverse.Scaleway.Inputs.LoadbalancerBackendHealthCheckHttps
HealthCheckMaxRetries int
Number of allowed failed HC requests before the backend server is marked down
HealthCheckPort int
Port the HC requests will be send to. Default to forward_port
HealthCheckSendProxy bool
Defines whether proxy protocol should be activated for the health check
HealthCheckTcp Pulumiverse.Scaleway.Inputs.LoadbalancerBackendHealthCheckTcp
HealthCheckTimeout string
Timeout before we consider a HC request failed
HealthCheckTransientDelay string
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
IgnoreSslServerVerify bool
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
MaxConnections int
Maximum number of connections allowed per backend server
MaxRetries int
Number of retries when a backend server connection failed
Name string
The name of the backend
OnMarkedDownAction string
Modify what occurs when a backend server is marked down
ProxyProtocol string
Type of PROXY protocol to enable
RedispatchAttemptCount int
Whether to use another backend server on each attempt
SendProxyV2 bool
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

ServerIps List<string>
Backend server IP addresses list (IPv4 or IPv6)
SslBridging bool
Enables SSL between load balancer and backend servers
StickySessions string
The type of sticky sessions
StickySessionsCookieName string
Cookie name for sticky sessions
TimeoutConnect string
Maximum initial server connection establishment time
TimeoutQueue string
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
TimeoutServer string
Maximum server connection inactivity time
TimeoutTunnel string
Maximum tunnel inactivity time
ForwardPort This property is required. int
User sessions will be forwarded to this port of backend servers
ForwardProtocol This property is required. string
Backend protocol
LbId
This property is required.
Changes to this property will trigger replacement.
string
The load-balancer ID
FailoverHost string
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
ForwardPortAlgorithm string
Load balancing algorithm
HealthCheckDelay string
Interval between two HC requests
HealthCheckHttp LoadbalancerBackendHealthCheckHttpArgs
HealthCheckHttps LoadbalancerBackendHealthCheckHttpsArgs
HealthCheckMaxRetries int
Number of allowed failed HC requests before the backend server is marked down
HealthCheckPort int
Port the HC requests will be send to. Default to forward_port
HealthCheckSendProxy bool
Defines whether proxy protocol should be activated for the health check
HealthCheckTcp LoadbalancerBackendHealthCheckTcpArgs
HealthCheckTimeout string
Timeout before we consider a HC request failed
HealthCheckTransientDelay string
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
IgnoreSslServerVerify bool
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
MaxConnections int
Maximum number of connections allowed per backend server
MaxRetries int
Number of retries when a backend server connection failed
Name string
The name of the backend
OnMarkedDownAction string
Modify what occurs when a backend server is marked down
ProxyProtocol string
Type of PROXY protocol to enable
RedispatchAttemptCount int
Whether to use another backend server on each attempt
SendProxyV2 bool
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

ServerIps []string
Backend server IP addresses list (IPv4 or IPv6)
SslBridging bool
Enables SSL between load balancer and backend servers
StickySessions string
The type of sticky sessions
StickySessionsCookieName string
Cookie name for sticky sessions
TimeoutConnect string
Maximum initial server connection establishment time
TimeoutQueue string
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
TimeoutServer string
Maximum server connection inactivity time
TimeoutTunnel string
Maximum tunnel inactivity time
forwardPort This property is required. Integer
User sessions will be forwarded to this port of backend servers
forwardProtocol This property is required. String
Backend protocol
lbId
This property is required.
Changes to this property will trigger replacement.
String
The load-balancer ID
failoverHost String
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
forwardPortAlgorithm String
Load balancing algorithm
healthCheckDelay String
Interval between two HC requests
healthCheckHttp LoadbalancerBackendHealthCheckHttp
healthCheckHttps LoadbalancerBackendHealthCheckHttps
healthCheckMaxRetries Integer
Number of allowed failed HC requests before the backend server is marked down
healthCheckPort Integer
Port the HC requests will be send to. Default to forward_port
healthCheckSendProxy Boolean
Defines whether proxy protocol should be activated for the health check
healthCheckTcp LoadbalancerBackendHealthCheckTcp
healthCheckTimeout String
Timeout before we consider a HC request failed
healthCheckTransientDelay String
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
ignoreSslServerVerify Boolean
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
maxConnections Integer
Maximum number of connections allowed per backend server
maxRetries Integer
Number of retries when a backend server connection failed
name String
The name of the backend
onMarkedDownAction String
Modify what occurs when a backend server is marked down
proxyProtocol String
Type of PROXY protocol to enable
redispatchAttemptCount Integer
Whether to use another backend server on each attempt
sendProxyV2 Boolean
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

serverIps List<String>
Backend server IP addresses list (IPv4 or IPv6)
sslBridging Boolean
Enables SSL between load balancer and backend servers
stickySessions String
The type of sticky sessions
stickySessionsCookieName String
Cookie name for sticky sessions
timeoutConnect String
Maximum initial server connection establishment time
timeoutQueue String
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
timeoutServer String
Maximum server connection inactivity time
timeoutTunnel String
Maximum tunnel inactivity time
forwardPort This property is required. number
User sessions will be forwarded to this port of backend servers
forwardProtocol This property is required. string
Backend protocol
lbId
This property is required.
Changes to this property will trigger replacement.
string
The load-balancer ID
failoverHost string
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
forwardPortAlgorithm string
Load balancing algorithm
healthCheckDelay string
Interval between two HC requests
healthCheckHttp LoadbalancerBackendHealthCheckHttp
healthCheckHttps LoadbalancerBackendHealthCheckHttps
healthCheckMaxRetries number
Number of allowed failed HC requests before the backend server is marked down
healthCheckPort number
Port the HC requests will be send to. Default to forward_port
healthCheckSendProxy boolean
Defines whether proxy protocol should be activated for the health check
healthCheckTcp LoadbalancerBackendHealthCheckTcp
healthCheckTimeout string
Timeout before we consider a HC request failed
healthCheckTransientDelay string
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
ignoreSslServerVerify boolean
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
maxConnections number
Maximum number of connections allowed per backend server
maxRetries number
Number of retries when a backend server connection failed
name string
The name of the backend
onMarkedDownAction string
Modify what occurs when a backend server is marked down
proxyProtocol string
Type of PROXY protocol to enable
redispatchAttemptCount number
Whether to use another backend server on each attempt
sendProxyV2 boolean
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

serverIps string[]
Backend server IP addresses list (IPv4 or IPv6)
sslBridging boolean
Enables SSL between load balancer and backend servers
stickySessions string
The type of sticky sessions
stickySessionsCookieName string
Cookie name for sticky sessions
timeoutConnect string
Maximum initial server connection establishment time
timeoutQueue string
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
timeoutServer string
Maximum server connection inactivity time
timeoutTunnel string
Maximum tunnel inactivity time
forward_port This property is required. int
User sessions will be forwarded to this port of backend servers
forward_protocol This property is required. str
Backend protocol
lb_id
This property is required.
Changes to this property will trigger replacement.
str
The load-balancer ID
failover_host str
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
forward_port_algorithm str
Load balancing algorithm
health_check_delay str
Interval between two HC requests
health_check_http LoadbalancerBackendHealthCheckHttpArgs
health_check_https LoadbalancerBackendHealthCheckHttpsArgs
health_check_max_retries int
Number of allowed failed HC requests before the backend server is marked down
health_check_port int
Port the HC requests will be send to. Default to forward_port
health_check_send_proxy bool
Defines whether proxy protocol should be activated for the health check
health_check_tcp LoadbalancerBackendHealthCheckTcpArgs
health_check_timeout str
Timeout before we consider a HC request failed
health_check_transient_delay str
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
ignore_ssl_server_verify bool
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
max_connections int
Maximum number of connections allowed per backend server
max_retries int
Number of retries when a backend server connection failed
name str
The name of the backend
on_marked_down_action str
Modify what occurs when a backend server is marked down
proxy_protocol str
Type of PROXY protocol to enable
redispatch_attempt_count int
Whether to use another backend server on each attempt
send_proxy_v2 bool
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

server_ips Sequence[str]
Backend server IP addresses list (IPv4 or IPv6)
ssl_bridging bool
Enables SSL between load balancer and backend servers
sticky_sessions str
The type of sticky sessions
sticky_sessions_cookie_name str
Cookie name for sticky sessions
timeout_connect str
Maximum initial server connection establishment time
timeout_queue str
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
timeout_server str
Maximum server connection inactivity time
timeout_tunnel str
Maximum tunnel inactivity time
forwardPort This property is required. Number
User sessions will be forwarded to this port of backend servers
forwardProtocol This property is required. String
Backend protocol
lbId
This property is required.
Changes to this property will trigger replacement.
String
The load-balancer ID
failoverHost String
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
forwardPortAlgorithm String
Load balancing algorithm
healthCheckDelay String
Interval between two HC requests
healthCheckHttp Property Map
healthCheckHttps Property Map
healthCheckMaxRetries Number
Number of allowed failed HC requests before the backend server is marked down
healthCheckPort Number
Port the HC requests will be send to. Default to forward_port
healthCheckSendProxy Boolean
Defines whether proxy protocol should be activated for the health check
healthCheckTcp Property Map
healthCheckTimeout String
Timeout before we consider a HC request failed
healthCheckTransientDelay String
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
ignoreSslServerVerify Boolean
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
maxConnections Number
Maximum number of connections allowed per backend server
maxRetries Number
Number of retries when a backend server connection failed
name String
The name of the backend
onMarkedDownAction String
Modify what occurs when a backend server is marked down
proxyProtocol String
Type of PROXY protocol to enable
redispatchAttemptCount Number
Whether to use another backend server on each attempt
sendProxyV2 Boolean
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

serverIps List<String>
Backend server IP addresses list (IPv4 or IPv6)
sslBridging Boolean
Enables SSL between load balancer and backend servers
stickySessions String
The type of sticky sessions
stickySessionsCookieName String
Cookie name for sticky sessions
timeoutConnect String
Maximum initial server connection establishment time
timeoutQueue String
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
timeoutServer String
Maximum server connection inactivity time
timeoutTunnel String
Maximum tunnel inactivity time

Outputs

All input properties are implicitly available as output properties. Additionally, the LoadbalancerBackend resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing LoadbalancerBackend Resource

Get an existing LoadbalancerBackend resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LoadbalancerBackendState, opts?: CustomResourceOptions): LoadbalancerBackend
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        failover_host: Optional[str] = None,
        forward_port: Optional[int] = None,
        forward_port_algorithm: Optional[str] = None,
        forward_protocol: Optional[str] = None,
        health_check_delay: Optional[str] = None,
        health_check_http: Optional[LoadbalancerBackendHealthCheckHttpArgs] = None,
        health_check_https: Optional[LoadbalancerBackendHealthCheckHttpsArgs] = None,
        health_check_max_retries: Optional[int] = None,
        health_check_port: Optional[int] = None,
        health_check_send_proxy: Optional[bool] = None,
        health_check_tcp: Optional[LoadbalancerBackendHealthCheckTcpArgs] = None,
        health_check_timeout: Optional[str] = None,
        health_check_transient_delay: Optional[str] = None,
        ignore_ssl_server_verify: Optional[bool] = None,
        lb_id: Optional[str] = None,
        max_connections: Optional[int] = None,
        max_retries: Optional[int] = None,
        name: Optional[str] = None,
        on_marked_down_action: Optional[str] = None,
        proxy_protocol: Optional[str] = None,
        redispatch_attempt_count: Optional[int] = None,
        send_proxy_v2: Optional[bool] = None,
        server_ips: Optional[Sequence[str]] = None,
        ssl_bridging: Optional[bool] = None,
        sticky_sessions: Optional[str] = None,
        sticky_sessions_cookie_name: Optional[str] = None,
        timeout_connect: Optional[str] = None,
        timeout_queue: Optional[str] = None,
        timeout_server: Optional[str] = None,
        timeout_tunnel: Optional[str] = None) -> LoadbalancerBackend
func GetLoadbalancerBackend(ctx *Context, name string, id IDInput, state *LoadbalancerBackendState, opts ...ResourceOption) (*LoadbalancerBackend, error)
public static LoadbalancerBackend Get(string name, Input<string> id, LoadbalancerBackendState? state, CustomResourceOptions? opts = null)
public static LoadbalancerBackend get(String name, Output<String> id, LoadbalancerBackendState state, CustomResourceOptions options)
resources:  _:    type: scaleway:LoadbalancerBackend    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
FailoverHost string
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
ForwardPort int
User sessions will be forwarded to this port of backend servers
ForwardPortAlgorithm string
Load balancing algorithm
ForwardProtocol string
Backend protocol
HealthCheckDelay string
Interval between two HC requests
HealthCheckHttp Pulumiverse.Scaleway.Inputs.LoadbalancerBackendHealthCheckHttp
HealthCheckHttps Pulumiverse.Scaleway.Inputs.LoadbalancerBackendHealthCheckHttps
HealthCheckMaxRetries int
Number of allowed failed HC requests before the backend server is marked down
HealthCheckPort int
Port the HC requests will be send to. Default to forward_port
HealthCheckSendProxy bool
Defines whether proxy protocol should be activated for the health check
HealthCheckTcp Pulumiverse.Scaleway.Inputs.LoadbalancerBackendHealthCheckTcp
HealthCheckTimeout string
Timeout before we consider a HC request failed
HealthCheckTransientDelay string
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
IgnoreSslServerVerify bool
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
LbId Changes to this property will trigger replacement. string
The load-balancer ID
MaxConnections int
Maximum number of connections allowed per backend server
MaxRetries int
Number of retries when a backend server connection failed
Name string
The name of the backend
OnMarkedDownAction string
Modify what occurs when a backend server is marked down
ProxyProtocol string
Type of PROXY protocol to enable
RedispatchAttemptCount int
Whether to use another backend server on each attempt
SendProxyV2 bool
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

ServerIps List<string>
Backend server IP addresses list (IPv4 or IPv6)
SslBridging bool
Enables SSL between load balancer and backend servers
StickySessions string
The type of sticky sessions
StickySessionsCookieName string
Cookie name for sticky sessions
TimeoutConnect string
Maximum initial server connection establishment time
TimeoutQueue string
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
TimeoutServer string
Maximum server connection inactivity time
TimeoutTunnel string
Maximum tunnel inactivity time
FailoverHost string
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
ForwardPort int
User sessions will be forwarded to this port of backend servers
ForwardPortAlgorithm string
Load balancing algorithm
ForwardProtocol string
Backend protocol
HealthCheckDelay string
Interval between two HC requests
HealthCheckHttp LoadbalancerBackendHealthCheckHttpArgs
HealthCheckHttps LoadbalancerBackendHealthCheckHttpsArgs
HealthCheckMaxRetries int
Number of allowed failed HC requests before the backend server is marked down
HealthCheckPort int
Port the HC requests will be send to. Default to forward_port
HealthCheckSendProxy bool
Defines whether proxy protocol should be activated for the health check
HealthCheckTcp LoadbalancerBackendHealthCheckTcpArgs
HealthCheckTimeout string
Timeout before we consider a HC request failed
HealthCheckTransientDelay string
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
IgnoreSslServerVerify bool
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
LbId Changes to this property will trigger replacement. string
The load-balancer ID
MaxConnections int
Maximum number of connections allowed per backend server
MaxRetries int
Number of retries when a backend server connection failed
Name string
The name of the backend
OnMarkedDownAction string
Modify what occurs when a backend server is marked down
ProxyProtocol string
Type of PROXY protocol to enable
RedispatchAttemptCount int
Whether to use another backend server on each attempt
SendProxyV2 bool
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

ServerIps []string
Backend server IP addresses list (IPv4 or IPv6)
SslBridging bool
Enables SSL between load balancer and backend servers
StickySessions string
The type of sticky sessions
StickySessionsCookieName string
Cookie name for sticky sessions
TimeoutConnect string
Maximum initial server connection establishment time
TimeoutQueue string
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
TimeoutServer string
Maximum server connection inactivity time
TimeoutTunnel string
Maximum tunnel inactivity time
failoverHost String
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
forwardPort Integer
User sessions will be forwarded to this port of backend servers
forwardPortAlgorithm String
Load balancing algorithm
forwardProtocol String
Backend protocol
healthCheckDelay String
Interval between two HC requests
healthCheckHttp LoadbalancerBackendHealthCheckHttp
healthCheckHttps LoadbalancerBackendHealthCheckHttps
healthCheckMaxRetries Integer
Number of allowed failed HC requests before the backend server is marked down
healthCheckPort Integer
Port the HC requests will be send to. Default to forward_port
healthCheckSendProxy Boolean
Defines whether proxy protocol should be activated for the health check
healthCheckTcp LoadbalancerBackendHealthCheckTcp
healthCheckTimeout String
Timeout before we consider a HC request failed
healthCheckTransientDelay String
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
ignoreSslServerVerify Boolean
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
lbId Changes to this property will trigger replacement. String
The load-balancer ID
maxConnections Integer
Maximum number of connections allowed per backend server
maxRetries Integer
Number of retries when a backend server connection failed
name String
The name of the backend
onMarkedDownAction String
Modify what occurs when a backend server is marked down
proxyProtocol String
Type of PROXY protocol to enable
redispatchAttemptCount Integer
Whether to use another backend server on each attempt
sendProxyV2 Boolean
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

serverIps List<String>
Backend server IP addresses list (IPv4 or IPv6)
sslBridging Boolean
Enables SSL between load balancer and backend servers
stickySessions String
The type of sticky sessions
stickySessionsCookieName String
Cookie name for sticky sessions
timeoutConnect String
Maximum initial server connection establishment time
timeoutQueue String
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
timeoutServer String
Maximum server connection inactivity time
timeoutTunnel String
Maximum tunnel inactivity time
failoverHost string
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
forwardPort number
User sessions will be forwarded to this port of backend servers
forwardPortAlgorithm string
Load balancing algorithm
forwardProtocol string
Backend protocol
healthCheckDelay string
Interval between two HC requests
healthCheckHttp LoadbalancerBackendHealthCheckHttp
healthCheckHttps LoadbalancerBackendHealthCheckHttps
healthCheckMaxRetries number
Number of allowed failed HC requests before the backend server is marked down
healthCheckPort number
Port the HC requests will be send to. Default to forward_port
healthCheckSendProxy boolean
Defines whether proxy protocol should be activated for the health check
healthCheckTcp LoadbalancerBackendHealthCheckTcp
healthCheckTimeout string
Timeout before we consider a HC request failed
healthCheckTransientDelay string
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
ignoreSslServerVerify boolean
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
lbId Changes to this property will trigger replacement. string
The load-balancer ID
maxConnections number
Maximum number of connections allowed per backend server
maxRetries number
Number of retries when a backend server connection failed
name string
The name of the backend
onMarkedDownAction string
Modify what occurs when a backend server is marked down
proxyProtocol string
Type of PROXY protocol to enable
redispatchAttemptCount number
Whether to use another backend server on each attempt
sendProxyV2 boolean
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

serverIps string[]
Backend server IP addresses list (IPv4 or IPv6)
sslBridging boolean
Enables SSL between load balancer and backend servers
stickySessions string
The type of sticky sessions
stickySessionsCookieName string
Cookie name for sticky sessions
timeoutConnect string
Maximum initial server connection establishment time
timeoutQueue string
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
timeoutServer string
Maximum server connection inactivity time
timeoutTunnel string
Maximum tunnel inactivity time
failover_host str
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
forward_port int
User sessions will be forwarded to this port of backend servers
forward_port_algorithm str
Load balancing algorithm
forward_protocol str
Backend protocol
health_check_delay str
Interval between two HC requests
health_check_http LoadbalancerBackendHealthCheckHttpArgs
health_check_https LoadbalancerBackendHealthCheckHttpsArgs
health_check_max_retries int
Number of allowed failed HC requests before the backend server is marked down
health_check_port int
Port the HC requests will be send to. Default to forward_port
health_check_send_proxy bool
Defines whether proxy protocol should be activated for the health check
health_check_tcp LoadbalancerBackendHealthCheckTcpArgs
health_check_timeout str
Timeout before we consider a HC request failed
health_check_transient_delay str
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
ignore_ssl_server_verify bool
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
lb_id Changes to this property will trigger replacement. str
The load-balancer ID
max_connections int
Maximum number of connections allowed per backend server
max_retries int
Number of retries when a backend server connection failed
name str
The name of the backend
on_marked_down_action str
Modify what occurs when a backend server is marked down
proxy_protocol str
Type of PROXY protocol to enable
redispatch_attempt_count int
Whether to use another backend server on each attempt
send_proxy_v2 bool
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

server_ips Sequence[str]
Backend server IP addresses list (IPv4 or IPv6)
ssl_bridging bool
Enables SSL between load balancer and backend servers
sticky_sessions str
The type of sticky sessions
sticky_sessions_cookie_name str
Cookie name for sticky sessions
timeout_connect str
Maximum initial server connection establishment time
timeout_queue str
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
timeout_server str
Maximum server connection inactivity time
timeout_tunnel str
Maximum tunnel inactivity time
failoverHost String
Scaleway S3 bucket website to be served in case all backend servers are down NOTE : Only the host part of the Scaleway S3 bucket website is expected. E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
forwardPort Number
User sessions will be forwarded to this port of backend servers
forwardPortAlgorithm String
Load balancing algorithm
forwardProtocol String
Backend protocol
healthCheckDelay String
Interval between two HC requests
healthCheckHttp Property Map
healthCheckHttps Property Map
healthCheckMaxRetries Number
Number of allowed failed HC requests before the backend server is marked down
healthCheckPort Number
Port the HC requests will be send to. Default to forward_port
healthCheckSendProxy Boolean
Defines whether proxy protocol should be activated for the health check
healthCheckTcp Property Map
healthCheckTimeout String
Timeout before we consider a HC request failed
healthCheckTransientDelay String
Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN)
ignoreSslServerVerify Boolean
Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection
lbId Changes to this property will trigger replacement. String
The load-balancer ID
maxConnections Number
Maximum number of connections allowed per backend server
maxRetries Number
Number of retries when a backend server connection failed
name String
The name of the backend
onMarkedDownAction String
Modify what occurs when a backend server is marked down
proxyProtocol String
Type of PROXY protocol to enable
redispatchAttemptCount Number
Whether to use another backend server on each attempt
sendProxyV2 Boolean
Enables PROXY protocol version 2

Deprecated: Please use proxy_protocol instead

serverIps List<String>
Backend server IP addresses list (IPv4 or IPv6)
sslBridging Boolean
Enables SSL between load balancer and backend servers
stickySessions String
The type of sticky sessions
stickySessionsCookieName String
Cookie name for sticky sessions
timeoutConnect String
Maximum initial server connection establishment time
timeoutQueue String
Maximum time (in seconds) for a request to be left pending in queue when max_connections is reached
timeoutServer String
Maximum server connection inactivity time
timeoutTunnel String
Maximum tunnel inactivity time

Supporting Types

LoadbalancerBackendHealthCheckHttp
, LoadbalancerBackendHealthCheckHttpArgs

Uri This property is required. string
The HTTP endpoint URL to call for HC requests
Code int
The expected HTTP status code
HostHeader string
The HTTP host header to use for HC requests
Method string
The HTTP method to use for HC requests
Uri This property is required. string
The HTTP endpoint URL to call for HC requests
Code int
The expected HTTP status code
HostHeader string
The HTTP host header to use for HC requests
Method string
The HTTP method to use for HC requests
uri This property is required. String
The HTTP endpoint URL to call for HC requests
code Integer
The expected HTTP status code
hostHeader String
The HTTP host header to use for HC requests
method String
The HTTP method to use for HC requests
uri This property is required. string
The HTTP endpoint URL to call for HC requests
code number
The expected HTTP status code
hostHeader string
The HTTP host header to use for HC requests
method string
The HTTP method to use for HC requests
uri This property is required. str
The HTTP endpoint URL to call for HC requests
code int
The expected HTTP status code
host_header str
The HTTP host header to use for HC requests
method str
The HTTP method to use for HC requests
uri This property is required. String
The HTTP endpoint URL to call for HC requests
code Number
The expected HTTP status code
hostHeader String
The HTTP host header to use for HC requests
method String
The HTTP method to use for HC requests

LoadbalancerBackendHealthCheckHttps
, LoadbalancerBackendHealthCheckHttpsArgs

Uri This property is required. string
The HTTPS endpoint URL to call for HC requests
Code int
The expected HTTP status code
HostHeader string
The HTTP host header to use for HC requests
Method string
The HTTP method to use for HC requests
Sni string
The SNI to use for HC requests over SSL
Uri This property is required. string
The HTTPS endpoint URL to call for HC requests
Code int
The expected HTTP status code
HostHeader string
The HTTP host header to use for HC requests
Method string
The HTTP method to use for HC requests
Sni string
The SNI to use for HC requests over SSL
uri This property is required. String
The HTTPS endpoint URL to call for HC requests
code Integer
The expected HTTP status code
hostHeader String
The HTTP host header to use for HC requests
method String
The HTTP method to use for HC requests
sni String
The SNI to use for HC requests over SSL
uri This property is required. string
The HTTPS endpoint URL to call for HC requests
code number
The expected HTTP status code
hostHeader string
The HTTP host header to use for HC requests
method string
The HTTP method to use for HC requests
sni string
The SNI to use for HC requests over SSL
uri This property is required. str
The HTTPS endpoint URL to call for HC requests
code int
The expected HTTP status code
host_header str
The HTTP host header to use for HC requests
method str
The HTTP method to use for HC requests
sni str
The SNI to use for HC requests over SSL
uri This property is required. String
The HTTPS endpoint URL to call for HC requests
code Number
The expected HTTP status code
hostHeader String
The HTTP host header to use for HC requests
method String
The HTTP method to use for HC requests
sni String
The SNI to use for HC requests over SSL

Import

Load Balancer backends can be imported using {zone}/{id}, e.g.

bash

$ pulumi import scaleway:index/loadbalancerBackend:LoadbalancerBackend backend01 fr-par-1/11111111-1111-1111-1111-111111111111
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
scaleway pulumiverse/pulumi-scaleway
License
Apache-2.0
Notes
This Pulumi package is based on the scaleway Terraform Provider.
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway