1. Packages
  2. Scaleway
  3. API Docs
  4. getLbs
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse

scaleway.getLbs

Explore with Pulumi AI

scaleway logo
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse

    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",
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    my_key = scaleway.get_lbs(name="foobar",
        zone="fr-par-2")
    
    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
    		}
    		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",
        });
    
    });
    
    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());
    
        }
    }
    
    variables:
      myKey:
        fn::invoke:
          Function: scaleway:getLbs
          Arguments:
            name: foobar
            zone: fr-par-2
    

    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,
                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,
                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 dictionary

    The following arguments are supported:

    Name string
    The load balancer name used as a filter. LBs with a name like it are listed.
    ProjectId string
    The ID of the project the load-balancer is associated with.
    Zone string
    zone) The zone in which LBs exist.
    Name string
    The load balancer name used as a filter. LBs with a name like it are listed.
    ProjectId string
    The ID of the project the load-balancer is associated with.
    Zone string
    zone) The zone in which LBs exist.
    name String
    The load balancer name used as a filter. LBs with a name like it are listed.
    projectId String
    The ID of the project the load-balancer is associated with.
    zone String
    zone) The zone in which LBs exist.
    name string
    The load balancer name used as a filter. LBs with a name like it are listed.
    projectId string
    The ID of the project the load-balancer is associated with.
    zone string
    zone) The zone in which LBs exist.
    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.
    zone str
    zone) The zone in which LBs exist.
    name String
    The load balancer name used as a filter. LBs with a name like it are listed.
    projectId String
    The ID of the project the load-balancer is associated with.
    zone String
    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.GetLbsLb>
    List of found LBs
    OrganizationId string
    The organization ID the load-balancer is associated with.
    ProjectId 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Lbs []GetLbsLb
    List of found LBs
    OrganizationId string
    The organization ID the load-balancer is associated with.
    ProjectId 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.
    id String
    The provider-assigned unique ID for this managed resource.
    lbs List<GetLbsLb>
    List of found LBs
    organizationId String
    The organization ID the load-balancer is associated with.
    projectId 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.
    id string
    The provider-assigned unique ID for this managed resource.
    lbs GetLbsLb[]
    List of found LBs
    organizationId string
    The organization ID the load-balancer is associated with.
    projectId 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.
    id str
    The provider-assigned unique ID for this managed resource.
    lbs Sequence[GetLbsLb]
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    lbs List<Property Map>
    List of found LBs
    organizationId String
    The organization ID the load-balancer is associated with.
    projectId 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.

    Supporting Types

    GetLbsLb

    BackendCount int
    Number of backends the Load balancer has.
    CreatedAt string
    Date at which the Load balancer was created.
    Description string
    The description of the load-balancer.
    FrontendCount int
    Number of frontends the Load balancer has.
    Id string
    The ID of the load-balancer.
    Instances List<Pulumiverse.Scaleway.Inputs.GetLbsLbInstance>
    List of underlying instances.
    Ips List<Pulumiverse.Scaleway.Inputs.GetLbsLbIp>
    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.
    OrganizationId string
    The organization ID the load-balancer is associated with.
    PrivateNetworkCount int
    Number of private networks attached to the Load balancer.
    ProjectId string
    The ID of the project the load-balancer is associated with.
    RouteCount int
    Number of routes the Load balancer has.
    SslCompatibilityLevel string
    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, locked and migrating.
    Subscriber string
    The subscriber information.
    Tags List<string>
    The tags associated with the load-balancer.
    Type string
    The offer type of the load-balancer.
    UpdatedAt string
    Date at which the Load balancer was updated.
    Zone string
    zone) The zone in which LBs exist.
    BackendCount int
    Number of backends the Load balancer has.
    CreatedAt string
    Date at which the Load balancer was created.
    Description string
    The description of the load-balancer.
    FrontendCount int
    Number of frontends the Load balancer has.
    Id string
    The ID of the load-balancer.
    Instances []GetLbsLbInstance
    List of underlying instances.
    Ips []GetLbsLbIp
    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.
    OrganizationId string
    The organization ID the load-balancer is associated with.
    PrivateNetworkCount int
    Number of private networks attached to the Load balancer.
    ProjectId string
    The ID of the project the load-balancer is associated with.
    RouteCount int
    Number of routes the Load balancer has.
    SslCompatibilityLevel string
    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, locked and migrating.
    Subscriber string
    The subscriber information.
    Tags []string
    The tags associated with the load-balancer.
    Type string
    The offer type of the load-balancer.
    UpdatedAt string
    Date at which the Load balancer was updated.
    Zone string
    zone) The zone in which LBs exist.
    backendCount Integer
    Number of backends the Load balancer has.
    createdAt String
    Date at which the Load balancer was created.
    description String
    The description of the load-balancer.
    frontendCount Integer
    Number of frontends the Load balancer has.
    id String
    The ID of the load-balancer.
    instances List<GetLbsLbInstance>
    List of underlying instances.
    ips List<GetLbsLbIp>
    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.
    organizationId String
    The organization ID the load-balancer is associated with.
    privateNetworkCount Integer
    Number of private networks attached to the Load balancer.
    projectId String
    The ID of the project the load-balancer is associated with.
    routeCount Integer
    Number of routes the Load balancer has.
    sslCompatibilityLevel String
    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, locked and migrating.
    subscriber String
    The subscriber information.
    tags List<String>
    The tags associated with the load-balancer.
    type String
    The offer type of the load-balancer.
    updatedAt String
    Date at which the Load balancer was updated.
    zone String
    zone) The zone in which LBs exist.
    backendCount number
    Number of backends the Load balancer has.
    createdAt string
    Date at which the Load balancer was created.
    description string
    The description of the load-balancer.
    frontendCount number
    Number of frontends the Load balancer has.
    id string
    The ID of the load-balancer.
    instances GetLbsLbInstance[]
    List of underlying instances.
    ips GetLbsLbIp[]
    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.
    organizationId string
    The organization ID the load-balancer is associated with.
    privateNetworkCount number
    Number of private networks attached to the Load balancer.
    projectId string
    The ID of the project the load-balancer is associated with.
    routeCount number
    Number of routes the Load balancer has.
    sslCompatibilityLevel string
    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, locked and migrating.
    subscriber string
    The subscriber information.
    tags string[]
    The tags associated with the load-balancer.
    type string
    The offer type of the load-balancer.
    updatedAt 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[GetLbsLbInstance]
    List of underlying instances.
    ips Sequence[GetLbsLbIp]
    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_count int
    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_level str
    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, locked and migrating.
    subscriber str
    The subscriber information.
    tags Sequence[str]
    The tags associated with the load-balancer.
    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.
    backendCount Number
    Number of backends the Load balancer has.
    createdAt String
    Date at which the Load balancer was created.
    description String
    The description of the load-balancer.
    frontendCount 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.
    organizationId String
    The organization ID the load-balancer is associated with.
    privateNetworkCount Number
    Number of private networks attached to the Load balancer.
    projectId String
    The ID of the project the load-balancer is associated with.
    routeCount Number
    Number of routes the Load balancer has.
    sslCompatibilityLevel String
    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, locked and migrating.
    subscriber String
    The subscriber information.
    tags List<String>
    The tags associated with the load-balancer.
    type String
    The offer type of the load-balancer.
    updatedAt String
    Date at which the Load balancer was updated.
    zone String
    zone) The zone in which LBs exist.

    GetLbsLbInstance

    CreatedAt string
    Date at which the Load balancer was created.
    Id string
    The ID of the load-balancer.
    IpAddress string
    Status string
    The state of the LB's instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
    UpdatedAt string
    Date at which the Load balancer was updated.
    Zone string
    zone) The zone in which LBs exist.
    CreatedAt string
    Date at which the Load balancer was created.
    Id string
    The ID of the load-balancer.
    IpAddress string
    Status string
    The state of the LB's instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
    UpdatedAt string
    Date at which the Load balancer was updated.
    Zone string
    zone) The zone in which LBs exist.
    createdAt String
    Date at which the Load balancer was created.
    id String
    The ID of the load-balancer.
    ipAddress String
    status String
    The state of the LB's instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
    updatedAt String
    Date at which the Load balancer was updated.
    zone String
    zone) The zone in which LBs exist.
    createdAt string
    Date at which the Load balancer was created.
    id string
    The ID of the load-balancer.
    ipAddress string
    status string
    The state of the LB's instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
    updatedAt 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, locked and migrating.
    updated_at str
    Date at which the Load balancer was updated.
    zone str
    zone) The zone in which LBs exist.
    createdAt String
    Date at which the Load balancer was created.
    id String
    The ID of the load-balancer.
    ipAddress String
    status String
    The state of the LB's instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
    updatedAt String
    Date at which the Load balancer was updated.
    zone String
    zone) The zone in which LBs exist.

    GetLbsLbIp

    Id string
    The ID of the load-balancer.
    IpAddress string
    LbId string
    OrganizationId string
    The organization ID the load-balancer is associated with.
    ProjectId string
    The ID of the project the load-balancer is associated with.
    Reverse string
    Zone string
    zone) The zone in which LBs exist.
    Id string
    The ID of the load-balancer.
    IpAddress string
    LbId string
    OrganizationId string
    The organization ID the load-balancer is associated with.
    ProjectId string
    The ID of the project the load-balancer is associated with.
    Reverse string
    Zone string
    zone) The zone in which LBs exist.
    id String
    The ID of the load-balancer.
    ipAddress String
    lbId String
    organizationId String
    The organization ID the load-balancer is associated with.
    projectId String
    The ID of the project the load-balancer is associated with.
    reverse String
    zone String
    zone) The zone in which LBs exist.
    id string
    The ID of the load-balancer.
    ipAddress string
    lbId string
    organizationId string
    The organization ID the load-balancer is associated with.
    projectId string
    The ID of the project the load-balancer is associated with.
    reverse string
    zone string
    zone) The zone in which LBs exist.
    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.
    id String
    The ID of the load-balancer.
    ipAddress String
    lbId String
    organizationId String
    The organization ID the load-balancer is associated with.
    projectId String
    The ID of the project the load-balancer is associated with.
    reverse String
    zone String
    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 scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse