Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse
scaleway.getLbs
Explore with Pulumi AI
Gets information about multiple Load Balancers.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/scaleway";
const myKey = scaleway.getLbs({
    name: "foobar",
    zone: "fr-par-2",
});
const lbsByTags = scaleway.getLbs({
    tags: ["a tag"],
});
import pulumi
import pulumi_scaleway as scaleway
my_key = scaleway.get_lbs(name="foobar",
    zone="fr-par-2")
lbs_by_tags = scaleway.get_lbs(tags=["a tag"])
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.GetLbs(ctx, &scaleway.GetLbsArgs{
			Name: pulumi.StringRef("foobar"),
			Zone: pulumi.StringRef("fr-par-2"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = scaleway.GetLbs(ctx, &scaleway.GetLbsArgs{
			Tags: []string{
				"a tag",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;
return await Deployment.RunAsync(() => 
{
    var myKey = Scaleway.GetLbs.Invoke(new()
    {
        Name = "foobar",
        Zone = "fr-par-2",
    });
    var lbsByTags = Scaleway.GetLbs.Invoke(new()
    {
        Tags = new[]
        {
            "a tag",
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.ScalewayFunctions;
import com.pulumi.scaleway.inputs.GetLbsArgs;
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) {
        final var myKey = ScalewayFunctions.getLbs(GetLbsArgs.builder()
            .name("foobar")
            .zone("fr-par-2")
            .build());
        final var lbsByTags = ScalewayFunctions.getLbs(GetLbsArgs.builder()
            .tags("a tag")
            .build());
    }
}
variables:
  myKey:
    fn::invoke:
      Function: scaleway:getLbs
      Arguments:
        name: foobar
        zone: fr-par-2
  lbsByTags:
    fn::invoke:
      Function: scaleway:getLbs
      Arguments:
        tags:
          - a tag
Using getLbs
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getLbs(args: GetLbsArgs, opts?: InvokeOptions): Promise<GetLbsResult>
function getLbsOutput(args: GetLbsOutputArgs, opts?: InvokeOptions): Output<GetLbsResult>def get_lbs(name: Optional[str] = None,
            project_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            zone: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetLbsResult
def get_lbs_output(name: Optional[pulumi.Input[str]] = None,
            project_id: Optional[pulumi.Input[str]] = None,
            tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
            zone: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetLbsResult]func GetLbs(ctx *Context, args *GetLbsArgs, opts ...InvokeOption) (*GetLbsResult, error)
func GetLbsOutput(ctx *Context, args *GetLbsOutputArgs, opts ...InvokeOption) GetLbsResultOutput> Note: This function is named GetLbs in the Go SDK.
public static class GetLbs 
{
    public static Task<GetLbsResult> InvokeAsync(GetLbsArgs args, InvokeOptions? opts = null)
    public static Output<GetLbsResult> Invoke(GetLbsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetLbsResult> getLbs(GetLbsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: scaleway:index/getLbs:getLbs
  arguments:
    # arguments dictionaryThe following arguments are supported:
- name str
 - The load balancer name used as a filter. LBs with a name like it are listed.
 - project_
id str - The ID of the project the load-balancer is associated with.
 - Sequence[str]
 - List of tags used as filter. LBs with these exact tags are listed.
 - zone str
 zone) The zone in which LBs exist.
getLbs Result
The following output properties are available:
- Id string
 - The provider-assigned unique ID for this managed resource.
 - Lbs
List<Pulumiverse.
Scaleway. Outputs. Get Lbs Lb>  - List of found LBs
 - Organization
Id string - The organization ID the load-balancer is associated with.
 - Project
Id string - The ID of the project the load-balancer is associated with.
 - Zone string
 - The zone in which the load-balancer is.
 - Name string
 - The name of the load-balancer.
 - List<string>
 - The tags associated with the load-balancer.
 
- Id string
 - The provider-assigned unique ID for this managed resource.
 - Lbs
[]Get
Lbs Lb  - List of found LBs
 - Organization
Id string - The organization ID the load-balancer is associated with.
 - Project
Id string - The ID of the project the load-balancer is associated with.
 - Zone string
 - The zone in which the load-balancer is.
 - Name string
 - The name of the load-balancer.
 - []string
 - The tags associated with the load-balancer.
 
- id String
 - The provider-assigned unique ID for this managed resource.
 - lbs
List<Get
Lbs Lb>  - List of found LBs
 - organization
Id String - The organization ID the load-balancer is associated with.
 - project
Id String - The ID of the project the load-balancer is associated with.
 - zone String
 - The zone in which the load-balancer is.
 - name String
 - The name of the load-balancer.
 - List<String>
 - The tags associated with the load-balancer.
 
- id string
 - The provider-assigned unique ID for this managed resource.
 - lbs
Get
Lbs Lb[]  - List of found LBs
 - organization
Id string - The organization ID the load-balancer is associated with.
 - project
Id string - The ID of the project the load-balancer is associated with.
 - zone string
 - The zone in which the load-balancer is.
 - name string
 - The name of the load-balancer.
 - string[]
 - The tags associated with the load-balancer.
 
- id str
 - The provider-assigned unique ID for this managed resource.
 - lbs
Sequence[Get
Lbs Lb]  - List of found LBs
 - organization_
id str - The organization ID the load-balancer is associated with.
 - project_
id str - The ID of the project the load-balancer is associated with.
 - zone str
 - The zone in which the load-balancer is.
 - name str
 - The name of the load-balancer.
 - Sequence[str]
 - The tags associated with the load-balancer.
 
- id String
 - The provider-assigned unique ID for this managed resource.
 - lbs List<Property Map>
 - List of found LBs
 - organization
Id String - The organization ID the load-balancer is associated with.
 - project
Id String - The ID of the project the load-balancer is associated with.
 - zone String
 - The zone in which the load-balancer is.
 - name String
 - The name of the load-balancer.
 - List<String>
 - The tags associated with the load-balancer.
 
Supporting Types
GetLbsLb  
- Backend
Count int - Number of backends the Load balancer has.
 - Created
At string - Date at which the Load balancer was created.
 - Description string
 - The description of the load-balancer.
 - Frontend
Count int - Number of frontends the Load balancer has.
 - Id string
 - The ID of the load-balancer.
 - Instances
List<Pulumiverse.
Scaleway. Inputs. Get Lbs Lb Instance>  - List of underlying instances.
 - Ips
List<Pulumiverse.
Scaleway. Inputs. Get Lbs Lb Ip>  - List of IPs attached to the Load balancer.
 - Name string
 - The load balancer name used as a filter. LBs with a name like it are listed.
 - Organization
Id string - The organization ID the load-balancer is associated with.
 - Private
Network intCount  - Number of private networks attached to the Load balancer.
 - Project
Id string - The ID of the project the load-balancer is associated with.
 - Route
Count int - Number of routes the Load balancer has.
 - Ssl
Compatibility stringLevel  - Determines the minimal SSL version which needs to be supported on client side.
 - Status string
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - Subscriber string
 - The subscriber information.
 - List<string>
 - List of tags used as filter. LBs with these exact tags are listed.
 - Type string
 - The offer type of the load-balancer.
 - Updated
At string - Date at which the Load balancer was updated.
 - Zone string
 zone) The zone in which LBs exist.
- Backend
Count int - Number of backends the Load balancer has.
 - Created
At string - Date at which the Load balancer was created.
 - Description string
 - The description of the load-balancer.
 - Frontend
Count int - Number of frontends the Load balancer has.
 - Id string
 - The ID of the load-balancer.
 - Instances
[]Get
Lbs Lb Instance  - List of underlying instances.
 - Ips
[]Get
Lbs Lb Ip  - List of IPs attached to the Load balancer.
 - Name string
 - The load balancer name used as a filter. LBs with a name like it are listed.
 - Organization
Id string - The organization ID the load-balancer is associated with.
 - Private
Network intCount  - Number of private networks attached to the Load balancer.
 - Project
Id string - The ID of the project the load-balancer is associated with.
 - Route
Count int - Number of routes the Load balancer has.
 - Ssl
Compatibility stringLevel  - Determines the minimal SSL version which needs to be supported on client side.
 - Status string
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - Subscriber string
 - The subscriber information.
 - []string
 - List of tags used as filter. LBs with these exact tags are listed.
 - Type string
 - The offer type of the load-balancer.
 - Updated
At string - Date at which the Load balancer was updated.
 - Zone string
 zone) The zone in which LBs exist.
- backend
Count Integer - Number of backends the Load balancer has.
 - created
At String - Date at which the Load balancer was created.
 - description String
 - The description of the load-balancer.
 - frontend
Count Integer - Number of frontends the Load balancer has.
 - id String
 - The ID of the load-balancer.
 - instances
List<Get
Lbs Lb Instance>  - List of underlying instances.
 - ips
List<Get
Lbs Lb Ip>  - List of IPs attached to the Load balancer.
 - name String
 - The load balancer name used as a filter. LBs with a name like it are listed.
 - organization
Id String - The organization ID the load-balancer is associated with.
 - private
Network IntegerCount  - Number of private networks attached to the Load balancer.
 - project
Id String - The ID of the project the load-balancer is associated with.
 - route
Count Integer - Number of routes the Load balancer has.
 - ssl
Compatibility StringLevel  - Determines the minimal SSL version which needs to be supported on client side.
 - status String
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - subscriber String
 - The subscriber information.
 - List<String>
 - List of tags used as filter. LBs with these exact tags are listed.
 - type String
 - The offer type of the load-balancer.
 - updated
At String - Date at which the Load balancer was updated.
 - zone String
 zone) The zone in which LBs exist.
- backend
Count number - Number of backends the Load balancer has.
 - created
At string - Date at which the Load balancer was created.
 - description string
 - The description of the load-balancer.
 - frontend
Count number - Number of frontends the Load balancer has.
 - id string
 - The ID of the load-balancer.
 - instances
Get
Lbs Lb Instance[]  - List of underlying instances.
 - ips
Get
Lbs Lb Ip[]  - List of IPs attached to the Load balancer.
 - name string
 - The load balancer name used as a filter. LBs with a name like it are listed.
 - organization
Id string - The organization ID the load-balancer is associated with.
 - private
Network numberCount  - Number of private networks attached to the Load balancer.
 - project
Id string - The ID of the project the load-balancer is associated with.
 - route
Count number - Number of routes the Load balancer has.
 - ssl
Compatibility stringLevel  - Determines the minimal SSL version which needs to be supported on client side.
 - status string
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - subscriber string
 - The subscriber information.
 - string[]
 - List of tags used as filter. LBs with these exact tags are listed.
 - type string
 - The offer type of the load-balancer.
 - updated
At string - Date at which the Load balancer was updated.
 - zone string
 zone) The zone in which LBs exist.
- backend_
count int - Number of backends the Load balancer has.
 - created_
at str - Date at which the Load balancer was created.
 - description str
 - The description of the load-balancer.
 - frontend_
count int - Number of frontends the Load balancer has.
 - id str
 - The ID of the load-balancer.
 - instances
Sequence[Get
Lbs Lb Instance]  - List of underlying instances.
 - ips
Sequence[Get
Lbs Lb Ip]  - List of IPs attached to the Load balancer.
 - name str
 - The load balancer name used as a filter. LBs with a name like it are listed.
 - organization_
id str - The organization ID the load-balancer is associated with.
 - private_
network_ intcount  - Number of private networks attached to the Load balancer.
 - project_
id str - The ID of the project the load-balancer is associated with.
 - route_
count int - Number of routes the Load balancer has.
 - ssl_
compatibility_ strlevel  - Determines the minimal SSL version which needs to be supported on client side.
 - status str
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - subscriber str
 - The subscriber information.
 - Sequence[str]
 - List of tags used as filter. LBs with these exact tags are listed.
 - type str
 - The offer type of the load-balancer.
 - updated_
at str - Date at which the Load balancer was updated.
 - zone str
 zone) The zone in which LBs exist.
- backend
Count Number - Number of backends the Load balancer has.
 - created
At String - Date at which the Load balancer was created.
 - description String
 - The description of the load-balancer.
 - frontend
Count Number - Number of frontends the Load balancer has.
 - id String
 - The ID of the load-balancer.
 - instances List<Property Map>
 - List of underlying instances.
 - ips List<Property Map>
 - List of IPs attached to the Load balancer.
 - name String
 - The load balancer name used as a filter. LBs with a name like it are listed.
 - organization
Id String - The organization ID the load-balancer is associated with.
 - private
Network NumberCount  - Number of private networks attached to the Load balancer.
 - project
Id String - The ID of the project the load-balancer is associated with.
 - route
Count Number - Number of routes the Load balancer has.
 - ssl
Compatibility StringLevel  - Determines the minimal SSL version which needs to be supported on client side.
 - status String
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - subscriber String
 - The subscriber information.
 - List<String>
 - List of tags used as filter. LBs with these exact tags are listed.
 - type String
 - The offer type of the load-balancer.
 - updated
At String - Date at which the Load balancer was updated.
 - zone String
 zone) The zone in which LBs exist.
GetLbsLbInstance   
- Created
At string - Date at which the Load balancer was created.
 - Id string
 - The ID of the load-balancer.
 - Ip
Address string - Status string
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - Updated
At string - Date at which the Load balancer was updated.
 - Zone string
 zone) The zone in which LBs exist.
- Created
At string - Date at which the Load balancer was created.
 - Id string
 - The ID of the load-balancer.
 - Ip
Address string - Status string
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - Updated
At string - Date at which the Load balancer was updated.
 - Zone string
 zone) The zone in which LBs exist.
- created
At String - Date at which the Load balancer was created.
 - id String
 - The ID of the load-balancer.
 - ip
Address String - status String
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - updated
At String - Date at which the Load balancer was updated.
 - zone String
 zone) The zone in which LBs exist.
- created
At string - Date at which the Load balancer was created.
 - id string
 - The ID of the load-balancer.
 - ip
Address string - status string
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - updated
At string - Date at which the Load balancer was updated.
 - zone string
 zone) The zone in which LBs exist.
- created_
at str - Date at which the Load balancer was created.
 - id str
 - The ID of the load-balancer.
 - ip_
address str - status str
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - updated_
at str - Date at which the Load balancer was updated.
 - zone str
 zone) The zone in which LBs exist.
- created
At String - Date at which the Load balancer was created.
 - id String
 - The ID of the load-balancer.
 - ip
Address String - status String
 - The state of the LB's instance. Possible values are: 
unknown,ready,pending,stopped,error,lockedandmigrating. - updated
At String - Date at which the Load balancer was updated.
 - zone String
 zone) The zone in which LBs exist.
GetLbsLbIp   
- id str
 - The ID of the load-balancer.
 - ip_
address str - lb_
id str - organization_
id str - The organization ID the load-balancer is associated with.
 - project_
id str - The ID of the project the load-balancer is associated with.
 - reverse str
 - zone str
 zone) The zone in which LBs exist.
Package Details
- Repository
 - scaleway pulumiverse/pulumi-scaleway
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
scalewayTerraform Provider.