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

scaleway.Loadbalancer

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway
Deprecated: scaleway.index/loadbalancer.Loadbalancer has been deprecated in favor of scaleway.loadbalancers/loadbalancer.LoadBalancer

Creates and manages Scaleway Load Balancers.

For 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 main = new scaleway.loadbalancers.Ip("main", {zone: "fr-par-1"});
const base = new scaleway.loadbalancers.LoadBalancer("base", {
    ipIds: [main.id],
    zone: main.zone,
    type: "LB-S",
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

main = scaleway.loadbalancers.Ip("main", zone="fr-par-1")
base = scaleway.loadbalancers.LoadBalancer("base",
    ip_ids=[main.id],
    zone=main.zone,
    type="LB-S")
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 {
		main, err := loadbalancers.NewIp(ctx, "main", &loadbalancers.IpArgs{
			Zone: pulumi.String("fr-par-1"),
		})
		if err != nil {
			return err
		}
		_, err = loadbalancers.NewLoadBalancer(ctx, "base", &loadbalancers.LoadBalancerArgs{
			IpIds: pulumi.StringArray{
				main.ID(),
			},
			Zone: main.Zone,
			Type: pulumi.String("LB-S"),
		})
		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 main = new Scaleway.Loadbalancers.Ip("main", new()
    {
        Zone = "fr-par-1",
    });

    var @base = new Scaleway.Loadbalancers.LoadBalancer("base", new()
    {
        IpIds = new[]
        {
            main.Id,
        },
        Zone = main.Zone,
        Type = "LB-S",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.loadbalancers.Ip;
import com.pulumi.scaleway.loadbalancers.IpArgs;
import com.pulumi.scaleway.loadbalancers.LoadBalancer;
import com.pulumi.scaleway.loadbalancers.LoadBalancerArgs;
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 main = new Ip("main", IpArgs.builder()
            .zone("fr-par-1")
            .build());

        var base = new LoadBalancer("base", LoadBalancerArgs.builder()
            .ipIds(main.id())
            .zone(main.zone())
            .type("LB-S")
            .build());

    }
}
Copy
resources:
  main:
    type: scaleway:loadbalancers:Ip
    properties:
      zone: fr-par-1
  base:
    type: scaleway:loadbalancers:LoadBalancer
    properties:
      ipIds:
        - ${main.id}
      zone: ${main.zone}
      type: LB-S
Copy

Private LB

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

const base = new scaleway.loadbalancers.LoadBalancer("base", {
    name: "private-lb",
    type: "LB-S",
    assignFlexibleIp: false,
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

base = scaleway.loadbalancers.LoadBalancer("base",
    name="private-lb",
    type="LB-S",
    assign_flexible_ip=False)
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.NewLoadBalancer(ctx, "base", &loadbalancers.LoadBalancerArgs{
			Name:             pulumi.String("private-lb"),
			Type:             pulumi.String("LB-S"),
			AssignFlexibleIp: pulumi.Bool(false),
		})
		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 @base = new Scaleway.Loadbalancers.LoadBalancer("base", new()
    {
        Name = "private-lb",
        Type = "LB-S",
        AssignFlexibleIp = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.loadbalancers.LoadBalancer;
import com.pulumi.scaleway.loadbalancers.LoadBalancerArgs;
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 base = new LoadBalancer("base", LoadBalancerArgs.builder()
            .name("private-lb")
            .type("LB-S")
            .assignFlexibleIp(false)
            .build());

    }
}
Copy
resources:
  base:
    type: scaleway:loadbalancers:LoadBalancer
    properties:
      name: private-lb
      type: LB-S
      assignFlexibleIp: false
Copy

With IPv6

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

const v4 = new scaleway.loadbalancers.Ip("v4", {});
const v6 = new scaleway.loadbalancers.Ip("v6", {isIpv6: true});
const main = new scaleway.loadbalancers.LoadBalancer("main", {
    ipIds: [
        v4.id,
        v6.id,
    ],
    name: "ipv6-lb",
    type: "LB-S",
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

v4 = scaleway.loadbalancers.Ip("v4")
v6 = scaleway.loadbalancers.Ip("v6", is_ipv6=True)
main = scaleway.loadbalancers.LoadBalancer("main",
    ip_ids=[
        v4.id,
        v6.id,
    ],
    name="ipv6-lb",
    type="LB-S")
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 {
		v4, err := loadbalancers.NewIp(ctx, "v4", nil)
		if err != nil {
			return err
		}
		v6, err := loadbalancers.NewIp(ctx, "v6", &loadbalancers.IpArgs{
			IsIpv6: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = loadbalancers.NewLoadBalancer(ctx, "main", &loadbalancers.LoadBalancerArgs{
			IpIds: pulumi.StringArray{
				v4.ID(),
				v6.ID(),
			},
			Name: pulumi.String("ipv6-lb"),
			Type: pulumi.String("LB-S"),
		})
		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 v4 = new Scaleway.Loadbalancers.Ip("v4");

    var v6 = new Scaleway.Loadbalancers.Ip("v6", new()
    {
        IsIpv6 = true,
    });

    var main = new Scaleway.Loadbalancers.LoadBalancer("main", new()
    {
        IpIds = new[]
        {
            v4.Id,
            v6.Id,
        },
        Name = "ipv6-lb",
        Type = "LB-S",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.loadbalancers.Ip;
import com.pulumi.scaleway.loadbalancers.IpArgs;
import com.pulumi.scaleway.loadbalancers.LoadBalancer;
import com.pulumi.scaleway.loadbalancers.LoadBalancerArgs;
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 v4 = new Ip("v4");

        var v6 = new Ip("v6", IpArgs.builder()
            .isIpv6(true)
            .build());

        var main = new LoadBalancer("main", LoadBalancerArgs.builder()
            .ipIds(            
                v4.id(),
                v6.id())
            .name("ipv6-lb")
            .type("LB-S")
            .build());

    }
}
Copy
resources:
  v4:
    type: scaleway:loadbalancers:Ip
  v6:
    type: scaleway:loadbalancers:Ip
    properties:
      isIpv6: true
  main:
    type: scaleway:loadbalancers:LoadBalancer
    properties:
      ipIds:
        - ${v4.id}
        - ${v6.id}
      name: ipv6-lb
      type: LB-S
Copy

With IPAM IDs

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

const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my vpc"});
const pn01 = new scaleway.network.PrivateNetwork("pn01", {
    vpcId: vpc01.id,
    ipv4Subnet: {
        subnet: "172.16.32.0/22",
    },
});
const ip01 = new scaleway.ipam.Ip("ip01", {
    address: "172.16.32.7",
    sources: [{
        privateNetworkId: pn01.id,
    }],
});
const v4 = new scaleway.loadbalancers.Ip("v4", {});
const lb01 = new scaleway.loadbalancers.LoadBalancer("lb01", {
    ipIds: [v4.id],
    name: "my-lb",
    type: "LB-S",
    privateNetworks: [{
        privateNetworkId: pn01.id,
        ipamIds: ip01.id,
    }],
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

vpc01 = scaleway.network.Vpc("vpc01", name="my vpc")
pn01 = scaleway.network.PrivateNetwork("pn01",
    vpc_id=vpc01.id,
    ipv4_subnet={
        "subnet": "172.16.32.0/22",
    })
ip01 = scaleway.ipam.Ip("ip01",
    address="172.16.32.7",
    sources=[{
        "private_network_id": pn01.id,
    }])
v4 = scaleway.loadbalancers.Ip("v4")
lb01 = scaleway.loadbalancers.LoadBalancer("lb01",
    ip_ids=[v4.id],
    name="my-lb",
    type="LB-S",
    private_networks=[{
        "private_network_id": pn01.id,
        "ipam_ids": ip01.id,
    }])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		vpc01, err := network.NewVpc(ctx, "vpc01", &network.VpcArgs{
			Name: pulumi.String("my vpc"),
		})
		if err != nil {
			return err
		}
		pn01, err := network.NewPrivateNetwork(ctx, "pn01", &network.PrivateNetworkArgs{
			VpcId: vpc01.ID(),
			Ipv4Subnet: &network.PrivateNetworkIpv4SubnetArgs{
				Subnet: pulumi.String("172.16.32.0/22"),
			},
		})
		if err != nil {
			return err
		}
		ip01, err := ipam.NewIp(ctx, "ip01", &ipam.IpArgs{
			Address: pulumi.String("172.16.32.7"),
			Sources: ipam.IpSourceArray{
				&ipam.IpSourceArgs{
					PrivateNetworkId: pn01.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		v4, err := loadbalancers.NewIp(ctx, "v4", nil)
		if err != nil {
			return err
		}
		_, err = loadbalancers.NewLoadBalancer(ctx, "lb01", &loadbalancers.LoadBalancerArgs{
			IpIds: pulumi.StringArray{
				v4.ID(),
			},
			Name: pulumi.String("my-lb"),
			Type: pulumi.String("LB-S"),
			PrivateNetworks: loadbalancers.LoadBalancerPrivateNetworkArray{
				&loadbalancers.LoadBalancerPrivateNetworkArgs{
					PrivateNetworkId: pn01.ID(),
					IpamIds:          ip01.ID(),
				},
			},
		})
		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 vpc01 = new Scaleway.Network.Vpc("vpc01", new()
    {
        Name = "my vpc",
    });

    var pn01 = new Scaleway.Network.PrivateNetwork("pn01", new()
    {
        VpcId = vpc01.Id,
        Ipv4Subnet = new Scaleway.Network.Inputs.PrivateNetworkIpv4SubnetArgs
        {
            Subnet = "172.16.32.0/22",
        },
    });

    var ip01 = new Scaleway.Ipam.Ip("ip01", new()
    {
        Address = "172.16.32.7",
        Sources = new[]
        {
            new Scaleway.Ipam.Inputs.IpSourceArgs
            {
                PrivateNetworkId = pn01.Id,
            },
        },
    });

    var v4 = new Scaleway.Loadbalancers.Ip("v4");

    var lb01 = new Scaleway.Loadbalancers.LoadBalancer("lb01", new()
    {
        IpIds = new[]
        {
            v4.Id,
        },
        Name = "my-lb",
        Type = "LB-S",
        PrivateNetworks = new[]
        {
            new Scaleway.Loadbalancers.Inputs.LoadBalancerPrivateNetworkArgs
            {
                PrivateNetworkId = pn01.Id,
                IpamIds = ip01.Id,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.network.Vpc;
import com.pulumi.scaleway.network.VpcArgs;
import com.pulumi.scaleway.network.PrivateNetwork;
import com.pulumi.scaleway.network.PrivateNetworkArgs;
import com.pulumi.scaleway.network.inputs.PrivateNetworkIpv4SubnetArgs;
import com.pulumi.scaleway.ipam.Ip;
import com.pulumi.scaleway.ipam.IpArgs;
import com.pulumi.scaleway.ipam.inputs.IpSourceArgs;
import com.pulumi.scaleway.loadbalancers.Ip;
import com.pulumi.scaleway.loadbalancers.LoadBalancer;
import com.pulumi.scaleway.loadbalancers.LoadBalancerArgs;
import com.pulumi.scaleway.loadbalancers.inputs.LoadBalancerPrivateNetworkArgs;
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 vpc01 = new Vpc("vpc01", VpcArgs.builder()
            .name("my vpc")
            .build());

        var pn01 = new PrivateNetwork("pn01", PrivateNetworkArgs.builder()
            .vpcId(vpc01.id())
            .ipv4Subnet(PrivateNetworkIpv4SubnetArgs.builder()
                .subnet("172.16.32.0/22")
                .build())
            .build());

        var ip01 = new Ip("ip01", IpArgs.builder()
            .address("172.16.32.7")
            .sources(IpSourceArgs.builder()
                .privateNetworkId(pn01.id())
                .build())
            .build());

        var v4 = new Ip("v4");

        var lb01 = new LoadBalancer("lb01", LoadBalancerArgs.builder()
            .ipIds(v4.id())
            .name("my-lb")
            .type("LB-S")
            .privateNetworks(LoadBalancerPrivateNetworkArgs.builder()
                .privateNetworkId(pn01.id())
                .ipamIds(ip01.id())
                .build())
            .build());

    }
}
Copy
resources:
  vpc01:
    type: scaleway:network:Vpc
    properties:
      name: my vpc
  pn01:
    type: scaleway:network:PrivateNetwork
    properties:
      vpcId: ${vpc01.id}
      ipv4Subnet:
        subnet: 172.16.32.0/22
  ip01:
    type: scaleway:ipam:Ip
    properties:
      address: 172.16.32.7
      sources:
        - privateNetworkId: ${pn01.id}
  v4:
    type: scaleway:loadbalancers:Ip
  lb01:
    type: scaleway:loadbalancers:LoadBalancer
    properties:
      ipIds:
        - ${v4.id}
      name: my-lb
      type: LB-S
      privateNetworks:
        - privateNetworkId: ${pn01.id}
          ipamIds: ${ip01.id}
Copy

Migration

In order to migrate to other Load Balancer types, you can check upwards or downwards migration via our CLI scw lb lb-types list. This change will not recreate your Load Balancer.

Please check our documentation for further details.

Create Loadbalancer Resource

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

Constructor syntax

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

@overload
def Loadbalancer(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 assign_flexible_ip: Optional[bool] = None,
                 assign_flexible_ipv6: Optional[bool] = None,
                 description: Optional[str] = None,
                 ip_id: Optional[str] = None,
                 ip_ids: Optional[Sequence[str]] = None,
                 name: Optional[str] = None,
                 private_networks: Optional[Sequence[LoadbalancerPrivateNetworkArgs]] = None,
                 project_id: Optional[str] = None,
                 release_ip: Optional[bool] = None,
                 ssl_compatibility_level: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None,
                 type: Optional[str] = None,
                 zone: Optional[str] = None)
func NewLoadbalancer(ctx *Context, name string, args LoadbalancerArgs, opts ...ResourceOption) (*Loadbalancer, error)
public Loadbalancer(string name, LoadbalancerArgs args, CustomResourceOptions? opts = null)
public Loadbalancer(String name, LoadbalancerArgs args)
public Loadbalancer(String name, LoadbalancerArgs args, CustomResourceOptions options)

type: scaleway:Loadbalancer
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. LoadbalancerArgs
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. LoadbalancerArgs
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. LoadbalancerArgs
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. LoadbalancerArgs
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. LoadbalancerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Loadbalancer 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 Loadbalancer resource accepts the following input properties:

Type This property is required. string
The type of the Load Balancer. Please check the migration section to upgrade the type.
AssignFlexibleIp Changes to this property will trigger replacement. bool
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
AssignFlexibleIpv6 bool
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
Description string
The description of the Load Balancer.
IpId string

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

IpIds List<string>

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

Name string
The name of the Load Balancer.
PrivateNetworks List<Pulumiverse.Scaleway.Inputs.LoadbalancerPrivateNetwork>
List of private network to connect with your load balancer.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Load Balancer is associated with.
ReleaseIp bool
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

SslCompatibilityLevel string
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
Tags List<string>
The tags associated with the Load Balancer.
Zone Changes to this property will trigger replacement. string
zone) The zone of the Load Balancer.
Type This property is required. string
The type of the Load Balancer. Please check the migration section to upgrade the type.
AssignFlexibleIp Changes to this property will trigger replacement. bool
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
AssignFlexibleIpv6 bool
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
Description string
The description of the Load Balancer.
IpId string

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

IpIds []string

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

Name string
The name of the Load Balancer.
PrivateNetworks []LoadbalancerPrivateNetworkArgs
List of private network to connect with your load balancer.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Load Balancer is associated with.
ReleaseIp bool
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

SslCompatibilityLevel string
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
Tags []string
The tags associated with the Load Balancer.
Zone Changes to this property will trigger replacement. string
zone) The zone of the Load Balancer.
type This property is required. String
The type of the Load Balancer. Please check the migration section to upgrade the type.
assignFlexibleIp Changes to this property will trigger replacement. Boolean
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
assignFlexibleIpv6 Boolean
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
description String
The description of the Load Balancer.
ipId String

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

ipIds List<String>

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

name String
The name of the Load Balancer.
privateNetworks List<LoadbalancerPrivateNetwork>
List of private network to connect with your load balancer.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the Load Balancer is associated with.
releaseIp Boolean
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

sslCompatibilityLevel String
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
tags List<String>
The tags associated with the Load Balancer.
zone Changes to this property will trigger replacement. String
zone) The zone of the Load Balancer.
type This property is required. string
The type of the Load Balancer. Please check the migration section to upgrade the type.
assignFlexibleIp Changes to this property will trigger replacement. boolean
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
assignFlexibleIpv6 boolean
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
description string
The description of the Load Balancer.
ipId string

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

ipIds string[]

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

name string
The name of the Load Balancer.
privateNetworks LoadbalancerPrivateNetwork[]
List of private network to connect with your load balancer.
projectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Load Balancer is associated with.
releaseIp boolean
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

sslCompatibilityLevel string
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
tags string[]
The tags associated with the Load Balancer.
zone Changes to this property will trigger replacement. string
zone) The zone of the Load Balancer.
type This property is required. str
The type of the Load Balancer. Please check the migration section to upgrade the type.
assign_flexible_ip Changes to this property will trigger replacement. bool
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
assign_flexible_ipv6 bool
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
description str
The description of the Load Balancer.
ip_id str

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

ip_ids Sequence[str]

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

name str
The name of the Load Balancer.
private_networks Sequence[LoadbalancerPrivateNetworkArgs]
List of private network to connect with your load balancer.
project_id Changes to this property will trigger replacement. str
project_id) The ID of the Project the Load Balancer is associated with.
release_ip bool
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

ssl_compatibility_level str
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
tags Sequence[str]
The tags associated with the Load Balancer.
zone Changes to this property will trigger replacement. str
zone) The zone of the Load Balancer.
type This property is required. String
The type of the Load Balancer. Please check the migration section to upgrade the type.
assignFlexibleIp Changes to this property will trigger replacement. Boolean
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
assignFlexibleIpv6 Boolean
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
description String
The description of the Load Balancer.
ipId String

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

ipIds List<String>

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

name String
The name of the Load Balancer.
privateNetworks List<Property Map>
List of private network to connect with your load balancer.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the Load Balancer is associated with.
releaseIp Boolean
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

sslCompatibilityLevel String
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
tags List<String>
The tags associated with the Load Balancer.
zone Changes to this property will trigger replacement. String
zone) The zone of the Load Balancer.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
IpAddress string
The Load Balancer public IPv4 address.
Ipv6Address string
The Load Balancer public IPv6 address.
OrganizationId string
The ID of the Organization ID the Load Balancer is associated with.
Region string
The region of the resource
Id string
The provider-assigned unique ID for this managed resource.
IpAddress string
The Load Balancer public IPv4 address.
Ipv6Address string
The Load Balancer public IPv6 address.
OrganizationId string
The ID of the Organization ID the Load Balancer is associated with.
Region string
The region of the resource
id String
The provider-assigned unique ID for this managed resource.
ipAddress String
The Load Balancer public IPv4 address.
ipv6Address String
The Load Balancer public IPv6 address.
organizationId String
The ID of the Organization ID the Load Balancer is associated with.
region String
The region of the resource
id string
The provider-assigned unique ID for this managed resource.
ipAddress string
The Load Balancer public IPv4 address.
ipv6Address string
The Load Balancer public IPv6 address.
organizationId string
The ID of the Organization ID the Load Balancer is associated with.
region string
The region of the resource
id str
The provider-assigned unique ID for this managed resource.
ip_address str
The Load Balancer public IPv4 address.
ipv6_address str
The Load Balancer public IPv6 address.
organization_id str
The ID of the Organization ID the Load Balancer is associated with.
region str
The region of the resource
id String
The provider-assigned unique ID for this managed resource.
ipAddress String
The Load Balancer public IPv4 address.
ipv6Address String
The Load Balancer public IPv6 address.
organizationId String
The ID of the Organization ID the Load Balancer is associated with.
region String
The region of the resource

Look up Existing Loadbalancer Resource

Get an existing Loadbalancer 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?: LoadbalancerState, opts?: CustomResourceOptions): Loadbalancer
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assign_flexible_ip: Optional[bool] = None,
        assign_flexible_ipv6: Optional[bool] = None,
        description: Optional[str] = None,
        ip_address: Optional[str] = None,
        ip_id: Optional[str] = None,
        ip_ids: Optional[Sequence[str]] = None,
        ipv6_address: Optional[str] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None,
        private_networks: Optional[Sequence[LoadbalancerPrivateNetworkArgs]] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        release_ip: Optional[bool] = None,
        ssl_compatibility_level: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        zone: Optional[str] = None) -> Loadbalancer
func GetLoadbalancer(ctx *Context, name string, id IDInput, state *LoadbalancerState, opts ...ResourceOption) (*Loadbalancer, error)
public static Loadbalancer Get(string name, Input<string> id, LoadbalancerState? state, CustomResourceOptions? opts = null)
public static Loadbalancer get(String name, Output<String> id, LoadbalancerState state, CustomResourceOptions options)
resources:  _:    type: scaleway:Loadbalancer    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:
AssignFlexibleIp Changes to this property will trigger replacement. bool
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
AssignFlexibleIpv6 bool
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
Description string
The description of the Load Balancer.
IpAddress string
The Load Balancer public IPv4 address.
IpId string

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

IpIds List<string>

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

Ipv6Address string
The Load Balancer public IPv6 address.
Name string
The name of the Load Balancer.
OrganizationId string
The ID of the Organization ID the Load Balancer is associated with.
PrivateNetworks List<Pulumiverse.Scaleway.Inputs.LoadbalancerPrivateNetwork>
List of private network to connect with your load balancer.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Load Balancer is associated with.
Region string
The region of the resource
ReleaseIp bool
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

SslCompatibilityLevel string
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
Tags List<string>
The tags associated with the Load Balancer.
Type string
The type of the Load Balancer. Please check the migration section to upgrade the type.
Zone Changes to this property will trigger replacement. string
zone) The zone of the Load Balancer.
AssignFlexibleIp Changes to this property will trigger replacement. bool
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
AssignFlexibleIpv6 bool
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
Description string
The description of the Load Balancer.
IpAddress string
The Load Balancer public IPv4 address.
IpId string

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

IpIds []string

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

Ipv6Address string
The Load Balancer public IPv6 address.
Name string
The name of the Load Balancer.
OrganizationId string
The ID of the Organization ID the Load Balancer is associated with.
PrivateNetworks []LoadbalancerPrivateNetworkArgs
List of private network to connect with your load balancer.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Load Balancer is associated with.
Region string
The region of the resource
ReleaseIp bool
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

SslCompatibilityLevel string
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
Tags []string
The tags associated with the Load Balancer.
Type string
The type of the Load Balancer. Please check the migration section to upgrade the type.
Zone Changes to this property will trigger replacement. string
zone) The zone of the Load Balancer.
assignFlexibleIp Changes to this property will trigger replacement. Boolean
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
assignFlexibleIpv6 Boolean
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
description String
The description of the Load Balancer.
ipAddress String
The Load Balancer public IPv4 address.
ipId String

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

ipIds List<String>

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

ipv6Address String
The Load Balancer public IPv6 address.
name String
The name of the Load Balancer.
organizationId String
The ID of the Organization ID the Load Balancer is associated with.
privateNetworks List<LoadbalancerPrivateNetwork>
List of private network to connect with your load balancer.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the Load Balancer is associated with.
region String
The region of the resource
releaseIp Boolean
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

sslCompatibilityLevel String
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
tags List<String>
The tags associated with the Load Balancer.
type String
The type of the Load Balancer. Please check the migration section to upgrade the type.
zone Changes to this property will trigger replacement. String
zone) The zone of the Load Balancer.
assignFlexibleIp Changes to this property will trigger replacement. boolean
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
assignFlexibleIpv6 boolean
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
description string
The description of the Load Balancer.
ipAddress string
The Load Balancer public IPv4 address.
ipId string

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

ipIds string[]

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

ipv6Address string
The Load Balancer public IPv6 address.
name string
The name of the Load Balancer.
organizationId string
The ID of the Organization ID the Load Balancer is associated with.
privateNetworks LoadbalancerPrivateNetwork[]
List of private network to connect with your load balancer.
projectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Load Balancer is associated with.
region string
The region of the resource
releaseIp boolean
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

sslCompatibilityLevel string
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
tags string[]
The tags associated with the Load Balancer.
type string
The type of the Load Balancer. Please check the migration section to upgrade the type.
zone Changes to this property will trigger replacement. string
zone) The zone of the Load Balancer.
assign_flexible_ip Changes to this property will trigger replacement. bool
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
assign_flexible_ipv6 bool
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
description str
The description of the Load Balancer.
ip_address str
The Load Balancer public IPv4 address.
ip_id str

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

ip_ids Sequence[str]

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

ipv6_address str
The Load Balancer public IPv6 address.
name str
The name of the Load Balancer.
organization_id str
The ID of the Organization ID the Load Balancer is associated with.
private_networks Sequence[LoadbalancerPrivateNetworkArgs]
List of private network to connect with your load balancer.
project_id Changes to this property will trigger replacement. str
project_id) The ID of the Project the Load Balancer is associated with.
region str
The region of the resource
release_ip bool
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

ssl_compatibility_level str
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
tags Sequence[str]
The tags associated with the Load Balancer.
type str
The type of the Load Balancer. Please check the migration section to upgrade the type.
zone Changes to this property will trigger replacement. str
zone) The zone of the Load Balancer.
assignFlexibleIp Changes to this property will trigger replacement. Boolean
Defines whether to automatically assign a flexible public IPv4 to the Load Balancer.
assignFlexibleIpv6 Boolean
Defines whether to automatically assign a flexible public IPv6 to the Load Balancer.
description String
The description of the Load Balancer.
ipAddress String
The Load Balancer public IPv4 address.
ipId String

Please use ip_ids. The ID of the associated Load Balancer IP. See below.

Important: Updates to ip_id will recreate the Load Balancer.

Deprecated: Please use ip_ids

ipIds List<String>

The List of IP IDs to attach to the Load Balancer.

Important: Make sure to use a scaleway.loadbalancers.Ip resource to create the IPs.

ipv6Address String
The Load Balancer public IPv6 address.
name String
The name of the Load Balancer.
organizationId String
The ID of the Organization ID the Load Balancer is associated with.
privateNetworks List<Property Map>
List of private network to connect with your load balancer.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the Load Balancer is associated with.
region String
The region of the resource
releaseIp Boolean
The release_ip allow the release of the IP address associated with the Load Balancer.

Deprecated: The resource ip will be destroyed by it's own resource. Please set this to false

sslCompatibilityLevel String
Enforces minimal SSL version (in SSL/TLS offloading context). Please check possible values.
tags List<String>
The tags associated with the Load Balancer.
type String
The type of the Load Balancer. Please check the migration section to upgrade the type.
zone Changes to this property will trigger replacement. String
zone) The zone of the Load Balancer.

Supporting Types

LoadbalancerPrivateNetwork
, LoadbalancerPrivateNetworkArgs

PrivateNetworkId This property is required. string

The ID of the Private Network to attach to.

  • Important: Updates to private_network will recreate the attachment.

DhcpConfig bool
Please use ipam_ids. Set to true if you want to let DHCP assign IP addresses.

Deprecated: dhcp_config field is deprecated, please use private_network_id or ipam_ids instead

IpamIds string
IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
StaticConfig string
Please use ipam_ids. Define a local ip address of your choice for the load balancer instance.

Deprecated: static_config field is deprecated, please use private_network_id or ipam_ids instead

Status string
The status of the private network connection.
Zone string
zone) The zone of the Load Balancer.
PrivateNetworkId This property is required. string

The ID of the Private Network to attach to.

  • Important: Updates to private_network will recreate the attachment.

DhcpConfig bool
Please use ipam_ids. Set to true if you want to let DHCP assign IP addresses.

Deprecated: dhcp_config field is deprecated, please use private_network_id or ipam_ids instead

IpamIds string
IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
StaticConfig string
Please use ipam_ids. Define a local ip address of your choice for the load balancer instance.

Deprecated: static_config field is deprecated, please use private_network_id or ipam_ids instead

Status string
The status of the private network connection.
Zone string
zone) The zone of the Load Balancer.
privateNetworkId This property is required. String

The ID of the Private Network to attach to.

  • Important: Updates to private_network will recreate the attachment.

dhcpConfig Boolean
Please use ipam_ids. Set to true if you want to let DHCP assign IP addresses.

Deprecated: dhcp_config field is deprecated, please use private_network_id or ipam_ids instead

ipamIds String
IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
staticConfig String
Please use ipam_ids. Define a local ip address of your choice for the load balancer instance.

Deprecated: static_config field is deprecated, please use private_network_id or ipam_ids instead

status String
The status of the private network connection.
zone String
zone) The zone of the Load Balancer.
privateNetworkId This property is required. string

The ID of the Private Network to attach to.

  • Important: Updates to private_network will recreate the attachment.

dhcpConfig boolean
Please use ipam_ids. Set to true if you want to let DHCP assign IP addresses.

Deprecated: dhcp_config field is deprecated, please use private_network_id or ipam_ids instead

ipamIds string
IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
staticConfig string
Please use ipam_ids. Define a local ip address of your choice for the load balancer instance.

Deprecated: static_config field is deprecated, please use private_network_id or ipam_ids instead

status string
The status of the private network connection.
zone string
zone) The zone of the Load Balancer.
private_network_id This property is required. str

The ID of the Private Network to attach to.

  • Important: Updates to private_network will recreate the attachment.

dhcp_config bool
Please use ipam_ids. Set to true if you want to let DHCP assign IP addresses.

Deprecated: dhcp_config field is deprecated, please use private_network_id or ipam_ids instead

ipam_ids str
IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
static_config str
Please use ipam_ids. Define a local ip address of your choice for the load balancer instance.

Deprecated: static_config field is deprecated, please use private_network_id or ipam_ids instead

status str
The status of the private network connection.
zone str
zone) The zone of the Load Balancer.
privateNetworkId This property is required. String

The ID of the Private Network to attach to.

  • Important: Updates to private_network will recreate the attachment.

dhcpConfig Boolean
Please use ipam_ids. Set to true if you want to let DHCP assign IP addresses.

Deprecated: dhcp_config field is deprecated, please use private_network_id or ipam_ids instead

ipamIds String
IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
staticConfig String
Please use ipam_ids. Define a local ip address of your choice for the load balancer instance.

Deprecated: static_config field is deprecated, please use private_network_id or ipam_ids instead

status String
The status of the private network connection.
zone String
zone) The zone of the Load Balancer.

Import

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

bash

$ pulumi import scaleway:index/loadbalancer:Loadbalancer main fr-par-1/11111111-1111-1111-1111-111111111111
Copy

Be aware that you will also need to import the scaleway_lb_ip resource.

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