scaleway.LoadbalancerBackend
Explore with Pulumi AI
Creates and manages Scaleway Load-Balancer Backends. For more information, see the documentation.
Example Usage
Basic
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";
const backend01 = new scaleway.LoadbalancerBackend("backend01", {
lbId: scaleway_lb.lb01.id,
forwardProtocol: "http",
forwardPort: 80,
});
import pulumi
import pulumiverse_scaleway as scaleway
backend01 = scaleway.LoadbalancerBackend("backend01",
lb_id=scaleway_lb["lb01"]["id"],
forward_protocol="http",
forward_port=80)
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := scaleway.NewLoadbalancerBackend(ctx, "backend01", &scaleway.LoadbalancerBackendArgs{
LbId: pulumi.Any(scaleway_lb.Lb01.Id),
ForwardProtocol: pulumi.String("http"),
ForwardPort: pulumi.Int(80),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;
return await Deployment.RunAsync(() =>
{
var backend01 = new Scaleway.LoadbalancerBackend("backend01", new()
{
LbId = scaleway_lb.Lb01.Id,
ForwardProtocol = "http",
ForwardPort = 80,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.LoadbalancerBackend;
import com.pulumi.scaleway.LoadbalancerBackendArgs;
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 LoadbalancerBackend("backend01", LoadbalancerBackendArgs.builder()
.lbId(scaleway_lb.lb01().id())
.forwardProtocol("http")
.forwardPort("80")
.build());
}
}
resources:
backend01:
type: scaleway:LoadbalancerBackend
properties:
lbId: ${scaleway_lb.lb01.id}
forwardProtocol: http
forwardPort: '80'
With HTTP Health Check
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";
const backend01 = new scaleway.LoadbalancerBackend("backend01", {
lbId: scaleway_lb.lb01.id,
forwardProtocol: "http",
forwardPort: 80,
healthCheckHttp: {
uri: "www.test.com/health",
},
});
import pulumi
import pulumiverse_scaleway as scaleway
backend01 = scaleway.LoadbalancerBackend("backend01",
lb_id=scaleway_lb["lb01"]["id"],
forward_protocol="http",
forward_port=80,
health_check_http=scaleway.LoadbalancerBackendHealthCheckHttpArgs(
uri="www.test.com/health",
))
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := scaleway.NewLoadbalancerBackend(ctx, "backend01", &scaleway.LoadbalancerBackendArgs{
LbId: pulumi.Any(scaleway_lb.Lb01.Id),
ForwardProtocol: pulumi.String("http"),
ForwardPort: pulumi.Int(80),
HealthCheckHttp: &scaleway.LoadbalancerBackendHealthCheckHttpArgs{
Uri: pulumi.String("www.test.com/health"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;
return await Deployment.RunAsync(() =>
{
var backend01 = new Scaleway.LoadbalancerBackend("backend01", new()
{
LbId = scaleway_lb.Lb01.Id,
ForwardProtocol = "http",
ForwardPort = 80,
HealthCheckHttp = new Scaleway.Inputs.LoadbalancerBackendHealthCheckHttpArgs
{
Uri = "www.test.com/health",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.LoadbalancerBackend;
import com.pulumi.scaleway.LoadbalancerBackendArgs;
import com.pulumi.scaleway.inputs.LoadbalancerBackendHealthCheckHttpArgs;
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 LoadbalancerBackend("backend01", LoadbalancerBackendArgs.builder()
.lbId(scaleway_lb.lb01().id())
.forwardProtocol("http")
.forwardPort("80")
.healthCheckHttp(LoadbalancerBackendHealthCheckHttpArgs.builder()
.uri("www.test.com/health")
.build())
.build());
}
}
resources:
backend01:
type: scaleway:LoadbalancerBackend
properties:
lbId: ${scaleway_lb.lb01.id}
forwardProtocol: http
forwardPort: '80'
healthCheckHttp:
uri: www.test.com/health
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,
forward_protocol: Optional[str] = None,
forward_port: Optional[int] = None,
lb_id: Optional[str] = None,
health_check_max_retries: Optional[int] = None,
max_retries: Optional[int] = None,
health_check_http: Optional[LoadbalancerBackendHealthCheckHttpArgs] = None,
health_check_https: Optional[LoadbalancerBackendHealthCheckHttpsArgs] = None,
failover_host: Optional[str] = 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,
forward_port_algorithm: Optional[str] = None,
max_connections: Optional[int] = None,
health_check_delay: Optional[str] = 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 string
- The unique name of the resource.
- args LoadbalancerBackendArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args LoadbalancerBackendArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LoadbalancerBackendArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LoadbalancerBackendArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var loadbalancerBackendResource = new Scaleway.LoadbalancerBackend("loadbalancerBackendResource", new()
{
ForwardProtocol = "string",
ForwardPort = 0,
LbId = "string",
HealthCheckMaxRetries = 0,
MaxRetries = 0,
HealthCheckHttp = new Scaleway.Inputs.LoadbalancerBackendHealthCheckHttpArgs
{
Uri = "string",
Code = 0,
HostHeader = "string",
Method = "string",
},
HealthCheckHttps = new Scaleway.Inputs.LoadbalancerBackendHealthCheckHttpsArgs
{
Uri = "string",
Code = 0,
HostHeader = "string",
Method = "string",
Sni = "string",
},
FailoverHost = "string",
HealthCheckPort = 0,
HealthCheckSendProxy = false,
HealthCheckTcp = null,
HealthCheckTimeout = "string",
HealthCheckTransientDelay = "string",
IgnoreSslServerVerify = false,
ForwardPortAlgorithm = "string",
MaxConnections = 0,
HealthCheckDelay = "string",
Name = "string",
OnMarkedDownAction = "string",
ProxyProtocol = "string",
RedispatchAttemptCount = 0,
ServerIps = new[]
{
"string",
},
SslBridging = false,
StickySessions = "string",
StickySessionsCookieName = "string",
TimeoutConnect = "string",
TimeoutQueue = "string",
TimeoutServer = "string",
TimeoutTunnel = "string",
});
example, err := scaleway.NewLoadbalancerBackend(ctx, "loadbalancerBackendResource", &scaleway.LoadbalancerBackendArgs{
ForwardProtocol: pulumi.String("string"),
ForwardPort: pulumi.Int(0),
LbId: pulumi.String("string"),
HealthCheckMaxRetries: pulumi.Int(0),
MaxRetries: pulumi.Int(0),
HealthCheckHttp: &scaleway.LoadbalancerBackendHealthCheckHttpArgs{
Uri: pulumi.String("string"),
Code: pulumi.Int(0),
HostHeader: pulumi.String("string"),
Method: pulumi.String("string"),
},
HealthCheckHttps: &scaleway.LoadbalancerBackendHealthCheckHttpsArgs{
Uri: pulumi.String("string"),
Code: pulumi.Int(0),
HostHeader: pulumi.String("string"),
Method: pulumi.String("string"),
Sni: pulumi.String("string"),
},
FailoverHost: pulumi.String("string"),
HealthCheckPort: pulumi.Int(0),
HealthCheckSendProxy: pulumi.Bool(false),
HealthCheckTcp: nil,
HealthCheckTimeout: pulumi.String("string"),
HealthCheckTransientDelay: pulumi.String("string"),
IgnoreSslServerVerify: pulumi.Bool(false),
ForwardPortAlgorithm: pulumi.String("string"),
MaxConnections: pulumi.Int(0),
HealthCheckDelay: pulumi.String("string"),
Name: pulumi.String("string"),
OnMarkedDownAction: pulumi.String("string"),
ProxyProtocol: pulumi.String("string"),
RedispatchAttemptCount: pulumi.Int(0),
ServerIps: pulumi.StringArray{
pulumi.String("string"),
},
SslBridging: pulumi.Bool(false),
StickySessions: pulumi.String("string"),
StickySessionsCookieName: pulumi.String("string"),
TimeoutConnect: pulumi.String("string"),
TimeoutQueue: pulumi.String("string"),
TimeoutServer: pulumi.String("string"),
TimeoutTunnel: pulumi.String("string"),
})
var loadbalancerBackendResource = new LoadbalancerBackend("loadbalancerBackendResource", LoadbalancerBackendArgs.builder()
.forwardProtocol("string")
.forwardPort(0)
.lbId("string")
.healthCheckMaxRetries(0)
.maxRetries(0)
.healthCheckHttp(LoadbalancerBackendHealthCheckHttpArgs.builder()
.uri("string")
.code(0)
.hostHeader("string")
.method("string")
.build())
.healthCheckHttps(LoadbalancerBackendHealthCheckHttpsArgs.builder()
.uri("string")
.code(0)
.hostHeader("string")
.method("string")
.sni("string")
.build())
.failoverHost("string")
.healthCheckPort(0)
.healthCheckSendProxy(false)
.healthCheckTcp()
.healthCheckTimeout("string")
.healthCheckTransientDelay("string")
.ignoreSslServerVerify(false)
.forwardPortAlgorithm("string")
.maxConnections(0)
.healthCheckDelay("string")
.name("string")
.onMarkedDownAction("string")
.proxyProtocol("string")
.redispatchAttemptCount(0)
.serverIps("string")
.sslBridging(false)
.stickySessions("string")
.stickySessionsCookieName("string")
.timeoutConnect("string")
.timeoutQueue("string")
.timeoutServer("string")
.timeoutTunnel("string")
.build());
loadbalancer_backend_resource = scaleway.LoadbalancerBackend("loadbalancerBackendResource",
forward_protocol="string",
forward_port=0,
lb_id="string",
health_check_max_retries=0,
max_retries=0,
health_check_http=scaleway.LoadbalancerBackendHealthCheckHttpArgs(
uri="string",
code=0,
host_header="string",
method="string",
),
health_check_https=scaleway.LoadbalancerBackendHealthCheckHttpsArgs(
uri="string",
code=0,
host_header="string",
method="string",
sni="string",
),
failover_host="string",
health_check_port=0,
health_check_send_proxy=False,
health_check_tcp=scaleway.LoadbalancerBackendHealthCheckTcpArgs(),
health_check_timeout="string",
health_check_transient_delay="string",
ignore_ssl_server_verify=False,
forward_port_algorithm="string",
max_connections=0,
health_check_delay="string",
name="string",
on_marked_down_action="string",
proxy_protocol="string",
redispatch_attempt_count=0,
server_ips=["string"],
ssl_bridging=False,
sticky_sessions="string",
sticky_sessions_cookie_name="string",
timeout_connect="string",
timeout_queue="string",
timeout_server="string",
timeout_tunnel="string")
const loadbalancerBackendResource = new scaleway.LoadbalancerBackend("loadbalancerBackendResource", {
forwardProtocol: "string",
forwardPort: 0,
lbId: "string",
healthCheckMaxRetries: 0,
maxRetries: 0,
healthCheckHttp: {
uri: "string",
code: 0,
hostHeader: "string",
method: "string",
},
healthCheckHttps: {
uri: "string",
code: 0,
hostHeader: "string",
method: "string",
sni: "string",
},
failoverHost: "string",
healthCheckPort: 0,
healthCheckSendProxy: false,
healthCheckTcp: {},
healthCheckTimeout: "string",
healthCheckTransientDelay: "string",
ignoreSslServerVerify: false,
forwardPortAlgorithm: "string",
maxConnections: 0,
healthCheckDelay: "string",
name: "string",
onMarkedDownAction: "string",
proxyProtocol: "string",
redispatchAttemptCount: 0,
serverIps: ["string"],
sslBridging: false,
stickySessions: "string",
stickySessionsCookieName: "string",
timeoutConnect: "string",
timeoutQueue: "string",
timeoutServer: "string",
timeoutTunnel: "string",
});
type: scaleway:LoadbalancerBackend
properties:
failoverHost: string
forwardPort: 0
forwardPortAlgorithm: string
forwardProtocol: string
healthCheckDelay: string
healthCheckHttp:
code: 0
hostHeader: string
method: string
uri: string
healthCheckHttps:
code: 0
hostHeader: string
method: string
sni: string
uri: string
healthCheckMaxRetries: 0
healthCheckPort: 0
healthCheckSendProxy: false
healthCheckTcp: {}
healthCheckTimeout: string
healthCheckTransientDelay: string
ignoreSslServerVerify: false
lbId: string
maxConnections: 0
maxRetries: 0
name: string
onMarkedDownAction: string
proxyProtocol: string
redispatchAttemptCount: 0
serverIps:
- string
sslBridging: false
stickySessions: string
stickySessionsCookieName: string
timeoutConnect: string
timeoutQueue: string
timeoutServer: string
timeoutTunnel: string
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
The LoadbalancerBackend resource accepts the following input properties:
- Forward
Port int - User sessions will be forwarded to this port of backend servers.
- Forward
Protocol string - Backend protocol. Possible values are:
tcp
orhttp
. - Lb
Id string The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- Failover
Host 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/'.
- Forward
Port stringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - Health
Check stringDelay - Interval between two HC requests.
- Health
Check Pulumiverse.Http Scaleway. Inputs. Loadbalancer Backend Health Check Http - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check Pulumiverse.Https Scaleway. Inputs. Loadbalancer Backend Health Check Https - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check intMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- Health
Check intPort - Port the HC requests will be send to.
- Health
Check boolSend Proxy - Defines whether proxy protocol should be activated for the health check.
- Health
Check Pulumiverse.Tcp Scaleway. Inputs. Loadbalancer Backend Health Check Tcp - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check stringTimeout - Timeout before we consider a HC request failed.
- Health
Check stringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- Ignore
Ssl boolServer Verify - 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 string
- The name of the load-balancer backend.
- On
Marked stringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - Proxy
Protocol string - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - Redispatch
Attempt intCount - Whether to use another backend server on each attempt.
- Send
Proxy boolV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - Server
Ips List<string> - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- Ssl
Bridging bool - Enables SSL between load balancer and backend servers.
- Sticky
Sessions string - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - string
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - Timeout
Connect string - Maximum initial server connection establishment time. (e.g.:
1s
) - Timeout
Queue string - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - Timeout
Server string - Maximum server connection inactivity time. (e.g.:
1s
) - Timeout
Tunnel string - Maximum tunnel inactivity time. (e.g.:
1s
)
- Forward
Port int - User sessions will be forwarded to this port of backend servers.
- Forward
Protocol string - Backend protocol. Possible values are:
tcp
orhttp
. - Lb
Id string The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- Failover
Host 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/'.
- Forward
Port stringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - Health
Check stringDelay - Interval between two HC requests.
- Health
Check LoadbalancerHttp Backend Health Check Http Args - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check LoadbalancerHttps Backend Health Check Https Args - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check intMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- Health
Check intPort - Port the HC requests will be send to.
- Health
Check boolSend Proxy - Defines whether proxy protocol should be activated for the health check.
- Health
Check LoadbalancerTcp Backend Health Check Tcp Args - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check stringTimeout - Timeout before we consider a HC request failed.
- Health
Check stringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- Ignore
Ssl boolServer Verify - 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 string
- The name of the load-balancer backend.
- On
Marked stringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - Proxy
Protocol string - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - Redispatch
Attempt intCount - Whether to use another backend server on each attempt.
- Send
Proxy boolV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - Server
Ips []string - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- Ssl
Bridging bool - Enables SSL between load balancer and backend servers.
- Sticky
Sessions string - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - string
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - Timeout
Connect string - Maximum initial server connection establishment time. (e.g.:
1s
) - Timeout
Queue string - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - Timeout
Server string - Maximum server connection inactivity time. (e.g.:
1s
) - Timeout
Tunnel string - Maximum tunnel inactivity time. (e.g.:
1s
)
- forward
Port Integer - User sessions will be forwarded to this port of backend servers.
- forward
Protocol String - Backend protocol. Possible values are:
tcp
orhttp
. - lb
Id String The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- failover
Host 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/'.
- forward
Port StringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - health
Check StringDelay - Interval between two HC requests.
- health
Check LoadbalancerHttp Backend Health Check Http - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check LoadbalancerHttps Backend Health Check Https - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check IntegerMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- health
Check IntegerPort - Port the HC requests will be send to.
- health
Check BooleanSend Proxy - Defines whether proxy protocol should be activated for the health check.
- health
Check LoadbalancerTcp Backend Health Check Tcp - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check StringTimeout - Timeout before we consider a HC request failed.
- health
Check StringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- ignore
Ssl BooleanServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- max
Connections Integer - Maximum number of connections allowed per backend server.
- max
Retries Integer - Number of retries when a backend server connection failed.
- name String
- The name of the load-balancer backend.
- on
Marked StringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - proxy
Protocol String - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - redispatch
Attempt IntegerCount - Whether to use another backend server on each attempt.
- send
Proxy BooleanV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - server
Ips List<String> - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- ssl
Bridging Boolean - Enables SSL between load balancer and backend servers.
- sticky
Sessions String - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - String
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - timeout
Connect String - Maximum initial server connection establishment time. (e.g.:
1s
) - timeout
Queue String - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - timeout
Server String - Maximum server connection inactivity time. (e.g.:
1s
) - timeout
Tunnel String - Maximum tunnel inactivity time. (e.g.:
1s
)
- forward
Port number - User sessions will be forwarded to this port of backend servers.
- forward
Protocol string - Backend protocol. Possible values are:
tcp
orhttp
. - lb
Id string The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- failover
Host 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/'.
- forward
Port stringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - health
Check stringDelay - Interval between two HC requests.
- health
Check LoadbalancerHttp Backend Health Check Http - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check LoadbalancerHttps Backend Health Check Https - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check numberMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- health
Check numberPort - Port the HC requests will be send to.
- health
Check booleanSend Proxy - Defines whether proxy protocol should be activated for the health check.
- health
Check LoadbalancerTcp Backend Health Check Tcp - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check stringTimeout - Timeout before we consider a HC request failed.
- health
Check stringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- ignore
Ssl booleanServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- max
Connections number - Maximum number of connections allowed per backend server.
- max
Retries number - Number of retries when a backend server connection failed.
- name string
- The name of the load-balancer backend.
- on
Marked stringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - proxy
Protocol string - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - redispatch
Attempt numberCount - Whether to use another backend server on each attempt.
- send
Proxy booleanV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - server
Ips string[] - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- ssl
Bridging boolean - Enables SSL between load balancer and backend servers.
- sticky
Sessions string - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - string
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - timeout
Connect string - Maximum initial server connection establishment time. (e.g.:
1s
) - timeout
Queue string - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - timeout
Server string - Maximum server connection inactivity time. (e.g.:
1s
) - timeout
Tunnel string - Maximum tunnel inactivity time. (e.g.:
1s
)
- forward_
port int - User sessions will be forwarded to this port of backend servers.
- forward_
protocol str - Backend protocol. Possible values are:
tcp
orhttp
. - lb_
id str The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- 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_ stralgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - health_
check_ strdelay - Interval between two HC requests.
- health_
check_ Loadbalancerhttp Backend Health Check Http Args - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health_
check_ Loadbalancerhttps Backend Health Check Https Args - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health_
check_ intmax_ retries - Number of allowed failed HC requests before the backend server is marked down.
- health_
check_ intport - Port the HC requests will be send to.
- health_
check_ boolsend_ proxy - Defines whether proxy protocol should be activated for the health check.
- health_
check_ Loadbalancertcp Backend Health Check Tcp Args - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health_
check_ strtimeout - Timeout before we consider a HC request failed.
- health_
check_ strtransient_ delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- ignore_
ssl_ boolserver_ verify - 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 load-balancer backend.
- on_
marked_ strdown_ action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - proxy_
protocol str - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - redispatch_
attempt_ intcount - Whether to use another backend server on each attempt.
- send_
proxy_ boolv2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - server_
ips Sequence[str] - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- ssl_
bridging bool - Enables SSL between load balancer and backend servers.
- sticky_
sessions str - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - str
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - timeout_
connect str - Maximum initial server connection establishment time. (e.g.:
1s
) - timeout_
queue str - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - timeout_
server str - Maximum server connection inactivity time. (e.g.:
1s
) - timeout_
tunnel str - Maximum tunnel inactivity time. (e.g.:
1s
)
- forward
Port Number - User sessions will be forwarded to this port of backend servers.
- forward
Protocol String - Backend protocol. Possible values are:
tcp
orhttp
. - lb
Id String The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- failover
Host 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/'.
- forward
Port StringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - health
Check StringDelay - Interval between two HC requests.
- health
Check Property MapHttp - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check Property MapHttps - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check NumberMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- health
Check NumberPort - Port the HC requests will be send to.
- health
Check BooleanSend Proxy - Defines whether proxy protocol should be activated for the health check.
- health
Check Property MapTcp - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check StringTimeout - Timeout before we consider a HC request failed.
- health
Check StringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- ignore
Ssl BooleanServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- max
Connections Number - Maximum number of connections allowed per backend server.
- max
Retries Number - Number of retries when a backend server connection failed.
- name String
- The name of the load-balancer backend.
- on
Marked StringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - proxy
Protocol String - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - redispatch
Attempt NumberCount - Whether to use another backend server on each attempt.
- send
Proxy BooleanV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - server
Ips List<String> - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- ssl
Bridging Boolean - Enables SSL between load balancer and backend servers.
- sticky
Sessions String - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - String
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - timeout
Connect String - Maximum initial server connection establishment time. (e.g.:
1s
) - timeout
Queue String - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - timeout
Server String - Maximum server connection inactivity time. (e.g.:
1s
) - timeout
Tunnel String - Maximum tunnel inactivity time. (e.g.:
1s
)
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Failover
Host 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/'.
- Forward
Port int - User sessions will be forwarded to this port of backend servers.
- Forward
Port stringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - Forward
Protocol string - Backend protocol. Possible values are:
tcp
orhttp
. - Health
Check stringDelay - Interval between two HC requests.
- Health
Check Pulumiverse.Http Scaleway. Inputs. Loadbalancer Backend Health Check Http - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check Pulumiverse.Https Scaleway. Inputs. Loadbalancer Backend Health Check Https - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check intMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- Health
Check intPort - Port the HC requests will be send to.
- Health
Check boolSend Proxy - Defines whether proxy protocol should be activated for the health check.
- Health
Check Pulumiverse.Tcp Scaleway. Inputs. Loadbalancer Backend Health Check Tcp - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check stringTimeout - Timeout before we consider a HC request failed.
- Health
Check stringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- Ignore
Ssl boolServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- Lb
Id string The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- Max
Connections int - Maximum number of connections allowed per backend server.
- Max
Retries int - Number of retries when a backend server connection failed.
- Name string
- The name of the load-balancer backend.
- On
Marked stringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - Proxy
Protocol string - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - Redispatch
Attempt intCount - Whether to use another backend server on each attempt.
- Send
Proxy boolV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - Server
Ips List<string> - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- Ssl
Bridging bool - Enables SSL between load balancer and backend servers.
- Sticky
Sessions string - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - string
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - Timeout
Connect string - Maximum initial server connection establishment time. (e.g.:
1s
) - Timeout
Queue string - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - Timeout
Server string - Maximum server connection inactivity time. (e.g.:
1s
) - Timeout
Tunnel string - Maximum tunnel inactivity time. (e.g.:
1s
)
- Failover
Host 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/'.
- Forward
Port int - User sessions will be forwarded to this port of backend servers.
- Forward
Port stringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - Forward
Protocol string - Backend protocol. Possible values are:
tcp
orhttp
. - Health
Check stringDelay - Interval between two HC requests.
- Health
Check LoadbalancerHttp Backend Health Check Http Args - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check LoadbalancerHttps Backend Health Check Https Args - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check intMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- Health
Check intPort - Port the HC requests will be send to.
- Health
Check boolSend Proxy - Defines whether proxy protocol should be activated for the health check.
- Health
Check LoadbalancerTcp Backend Health Check Tcp Args - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - Health
Check stringTimeout - Timeout before we consider a HC request failed.
- Health
Check stringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- Ignore
Ssl boolServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- Lb
Id string The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- Max
Connections int - Maximum number of connections allowed per backend server.
- Max
Retries int - Number of retries when a backend server connection failed.
- Name string
- The name of the load-balancer backend.
- On
Marked stringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - Proxy
Protocol string - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - Redispatch
Attempt intCount - Whether to use another backend server on each attempt.
- Send
Proxy boolV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - Server
Ips []string - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- Ssl
Bridging bool - Enables SSL between load balancer and backend servers.
- Sticky
Sessions string - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - string
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - Timeout
Connect string - Maximum initial server connection establishment time. (e.g.:
1s
) - Timeout
Queue string - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - Timeout
Server string - Maximum server connection inactivity time. (e.g.:
1s
) - Timeout
Tunnel string - Maximum tunnel inactivity time. (e.g.:
1s
)
- failover
Host 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/'.
- forward
Port Integer - User sessions will be forwarded to this port of backend servers.
- forward
Port StringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - forward
Protocol String - Backend protocol. Possible values are:
tcp
orhttp
. - health
Check StringDelay - Interval between two HC requests.
- health
Check LoadbalancerHttp Backend Health Check Http - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check LoadbalancerHttps Backend Health Check Https - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check IntegerMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- health
Check IntegerPort - Port the HC requests will be send to.
- health
Check BooleanSend Proxy - Defines whether proxy protocol should be activated for the health check.
- health
Check LoadbalancerTcp Backend Health Check Tcp - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check StringTimeout - Timeout before we consider a HC request failed.
- health
Check StringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- ignore
Ssl BooleanServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- lb
Id String The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- max
Connections Integer - Maximum number of connections allowed per backend server.
- max
Retries Integer - Number of retries when a backend server connection failed.
- name String
- The name of the load-balancer backend.
- on
Marked StringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - proxy
Protocol String - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - redispatch
Attempt IntegerCount - Whether to use another backend server on each attempt.
- send
Proxy BooleanV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - server
Ips List<String> - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- ssl
Bridging Boolean - Enables SSL between load balancer and backend servers.
- sticky
Sessions String - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - String
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - timeout
Connect String - Maximum initial server connection establishment time. (e.g.:
1s
) - timeout
Queue String - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - timeout
Server String - Maximum server connection inactivity time. (e.g.:
1s
) - timeout
Tunnel String - Maximum tunnel inactivity time. (e.g.:
1s
)
- failover
Host 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/'.
- forward
Port number - User sessions will be forwarded to this port of backend servers.
- forward
Port stringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - forward
Protocol string - Backend protocol. Possible values are:
tcp
orhttp
. - health
Check stringDelay - Interval between two HC requests.
- health
Check LoadbalancerHttp Backend Health Check Http - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check LoadbalancerHttps Backend Health Check Https - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check numberMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- health
Check numberPort - Port the HC requests will be send to.
- health
Check booleanSend Proxy - Defines whether proxy protocol should be activated for the health check.
- health
Check LoadbalancerTcp Backend Health Check Tcp - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check stringTimeout - Timeout before we consider a HC request failed.
- health
Check stringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- ignore
Ssl booleanServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- lb
Id string The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- max
Connections number - Maximum number of connections allowed per backend server.
- max
Retries number - Number of retries when a backend server connection failed.
- name string
- The name of the load-balancer backend.
- on
Marked stringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - proxy
Protocol string - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - redispatch
Attempt numberCount - Whether to use another backend server on each attempt.
- send
Proxy booleanV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - server
Ips string[] - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- ssl
Bridging boolean - Enables SSL between load balancer and backend servers.
- sticky
Sessions string - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - string
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - timeout
Connect string - Maximum initial server connection establishment time. (e.g.:
1s
) - timeout
Queue string - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - timeout
Server string - Maximum server connection inactivity time. (e.g.:
1s
) - timeout
Tunnel string - Maximum tunnel inactivity time. (e.g.:
1s
)
- 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_ stralgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - forward_
protocol str - Backend protocol. Possible values are:
tcp
orhttp
. - health_
check_ strdelay - Interval between two HC requests.
- health_
check_ Loadbalancerhttp Backend Health Check Http Args - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health_
check_ Loadbalancerhttps Backend Health Check Https Args - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health_
check_ intmax_ retries - Number of allowed failed HC requests before the backend server is marked down.
- health_
check_ intport - Port the HC requests will be send to.
- health_
check_ boolsend_ proxy - Defines whether proxy protocol should be activated for the health check.
- health_
check_ Loadbalancertcp Backend Health Check Tcp Args - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health_
check_ strtimeout - Timeout before we consider a HC request failed.
- health_
check_ strtransient_ delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- ignore_
ssl_ boolserver_ verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- lb_
id str The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- 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 load-balancer backend.
- on_
marked_ strdown_ action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - proxy_
protocol str - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - redispatch_
attempt_ intcount - Whether to use another backend server on each attempt.
- send_
proxy_ boolv2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - server_
ips Sequence[str] - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- ssl_
bridging bool - Enables SSL between load balancer and backend servers.
- sticky_
sessions str - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - str
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - timeout_
connect str - Maximum initial server connection establishment time. (e.g.:
1s
) - timeout_
queue str - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - timeout_
server str - Maximum server connection inactivity time. (e.g.:
1s
) - timeout_
tunnel str - Maximum tunnel inactivity time. (e.g.:
1s
)
- failover
Host 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/'.
- forward
Port Number - User sessions will be forwarded to this port of backend servers.
- forward
Port StringAlgorithm - Load balancing algorithm. Possible values are:
roundrobin
,leastconn
andfirst
. - forward
Protocol String - Backend protocol. Possible values are:
tcp
orhttp
. - health
Check StringDelay - Interval between two HC requests.
- health
Check Property MapHttp - This block enable HTTP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check Property MapHttps - This block enable HTTPS health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check NumberMax Retries - Number of allowed failed HC requests before the backend server is marked down.
- health
Check NumberPort - Port the HC requests will be send to.
- health
Check BooleanSend Proxy - Defines whether proxy protocol should be activated for the health check.
- health
Check Property MapTcp - This block enable TCP health check. Only one of
health_check_tcp
,health_check_http
andhealth_check_https
should be specified. - health
Check StringTimeout - Timeout before we consider a HC request failed.
- health
Check StringTransient Delay - The time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
- ignore
Ssl BooleanServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- lb
Id String The load-balancer ID this backend is attached to.
Important: Updates to
lb_id
will recreate the backend.- max
Connections Number - Maximum number of connections allowed per backend server.
- max
Retries Number - Number of retries when a backend server connection failed.
- name String
- The name of the load-balancer backend.
- on
Marked StringDown Action - Modify what occurs when a backend server is marked down. Possible values are:
none
andshutdown_sessions
. - proxy
Protocol String - Choose the type of PROXY protocol to enable (
none
,v1
,v2
,v2_ssl
,v2_ssl_cn
) - redispatch
Attempt NumberCount - Whether to use another backend server on each attempt.
- send
Proxy BooleanV2 - DEPRECATED please use
proxy_protocol
instead - (Default:false
) Enables PROXY protocol version 2. - server
Ips List<String> - List of backend server IP addresses. Addresses can be either IPv4 or IPv6.
- ssl
Bridging Boolean - Enables SSL between load balancer and backend servers.
- sticky
Sessions String - The type of sticky sessions. The only current possible values are:
none
,cookie
andtable
. - String
- Cookie name for sticky sessions. Only applicable when sticky_sessions is set to
cookie
. - timeout
Connect String - Maximum initial server connection establishment time. (e.g.:
1s
) - timeout
Queue String - Maximum time for a request to be left pending in queue when
max_connections
is reached. (e.g.:1s
) - timeout
Server String - Maximum server connection inactivity time. (e.g.:
1s
) - timeout
Tunnel String - Maximum tunnel inactivity time. (e.g.:
1s
)
Supporting Types
LoadbalancerBackendHealthCheckHttp, LoadbalancerBackendHealthCheckHttpArgs
- Uri string
- The HTTPS endpoint URL to call for HC requests.
- Code int
- The expected HTTP status code.
- Host
Header string - The HTTP host header to use for HC requests.
- Method string
- The HTTP method to use for HC requests.
- Uri string
- The HTTPS endpoint URL to call for HC requests.
- Code int
- The expected HTTP status code.
- Host
Header string - The HTTP host header to use for HC requests.
- Method string
- The HTTP method to use for HC requests.
- uri String
- The HTTPS endpoint URL to call for HC requests.
- code Integer
- The expected HTTP status code.
- host
Header String - The HTTP host header to use for HC requests.
- method String
- The HTTP method to use for HC requests.
- uri string
- The HTTPS endpoint URL to call for HC requests.
- code number
- The expected HTTP status code.
- host
Header string - The HTTP host header to use for HC requests.
- method string
- The HTTP method to use for HC requests.
- uri 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.
- uri String
- The HTTPS endpoint URL to call for HC requests.
- code Number
- The expected HTTP status code.
- host
Header String - The HTTP host header to use for HC requests.
- method String
- The HTTP method to use for HC requests.
LoadbalancerBackendHealthCheckHttps, LoadbalancerBackendHealthCheckHttpsArgs
- Uri string
- The HTTPS endpoint URL to call for HC requests.
- Code int
- The expected HTTP status code.
- Host
Header 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 string
- The HTTPS endpoint URL to call for HC requests.
- Code int
- The expected HTTP status code.
- Host
Header 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 String
- The HTTPS endpoint URL to call for HC requests.
- code Integer
- The expected HTTP status code.
- host
Header 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 string
- The HTTPS endpoint URL to call for HC requests.
- code number
- The expected HTTP status code.
- host
Header 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 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 String
- The HTTPS endpoint URL to call for HC requests.
- code Number
- The expected HTTP status code.
- host
Header 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 backend can be imported using the {zone}/{id}
, e.g.
bash
$ pulumi import scaleway:index/loadbalancerBackend:LoadbalancerBackend backend01 fr-par-1/11111111-1111-1111-1111-111111111111
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.