getLoadBalancer

Vultr v2.27.1, Sep 30 25

Viewing docs for Vultr v2.27.1
published on Tuesday, Sep 30, 2025 by dirien

Schema (JSON)

dirien/pulumi-vultr

Viewing docs for Vultr v2.27.1
published on Tuesday, Sep 30, 2025 by dirien

Schema (JSON)

dirien/pulumi-vultr

Example Usage

Get the information for a load balancer by label:

import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const myLb = vultr.getLoadBalancer({
    filters: [{
        name: "label",
        values: ["my-lb-label"],
    }],
});

import pulumi
import pulumi_vultr as vultr

my_lb = vultr.get_load_balancer(filters=[{
    "name": "label",
    "values": ["my-lb-label"],
}])

package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.LookupLoadBalancer(ctx, &vultr.LookupLoadBalancerArgs{
			Filters: []vultr.GetLoadBalancerFilter{
				{
					Name: "label",
					Values: []string{
						"my-lb-label",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = Pulumi.Vultr;

return await Deployment.RunAsync(() => 
{
    var myLb = Vultr.GetLoadBalancer.Invoke(new()
    {
        Filters = new[]
        {
            new Vultr.Inputs.GetLoadBalancerFilterInputArgs
            {
                Name = "label",
                Values = new[]
                {
                    "my-lb-label",
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.VultrFunctions;
import com.pulumi.vultr.inputs.GetLoadBalancerArgs;
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 myLb = VultrFunctions.getLoadBalancer(GetLoadBalancerArgs.builder()
            .filters(GetLoadBalancerFilterArgs.builder()
                .name("label")
                .values("my-lb-label")
                .build())
            .build());

    }
}

variables:
  myLb:
    fn::invoke:
      function: vultr:getLoadBalancer
      arguments:
        filters:
          - name: label
            values:
              - my-lb-label

Using getLoadBalancer

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 getLoadBalancer(args: GetLoadBalancerArgs, opts?: InvokeOptions): Promise<GetLoadBalancerResult>
function getLoadBalancerOutput(args: GetLoadBalancerOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancerResult>

def get_load_balancer(filters: Optional[Sequence[GetLoadBalancerFilter]] = None,
                      proxy_protocol: Optional[bool] = None,
                      opts: Optional[InvokeOptions] = None) -> GetLoadBalancerResult
def get_load_balancer_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetLoadBalancerFilterArgs]]]] = None,
                      proxy_protocol: Optional[pulumi.Input[bool]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancerResult]

func LookupLoadBalancer(ctx *Context, args *LookupLoadBalancerArgs, opts ...InvokeOption) (*LookupLoadBalancerResult, error)
func LookupLoadBalancerOutput(ctx *Context, args *LookupLoadBalancerOutputArgs, opts ...InvokeOption) LookupLoadBalancerResultOutput

> Note: This function is named LookupLoadBalancer in the Go SDK.

public static class GetLoadBalancer 
{
    public static Task<GetLoadBalancerResult> InvokeAsync(GetLoadBalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetLoadBalancerResult> Invoke(GetLoadBalancerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)
public static Output<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)

fn::invoke:
  function: vultr:index/getLoadBalancer:getLoadBalancer
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<ediri.Vultr.Inputs.GetLoadBalancerFilter>: Query parameters for finding load balancers.
ProxyProtocol bool: Boolean value that indicates if Proxy Protocol is enabled.

Filters []GetLoadBalancerFilter: Query parameters for finding load balancers.
ProxyProtocol bool: Boolean value that indicates if Proxy Protocol is enabled.

filters List<GetLoadBalancerFilter>: Query parameters for finding load balancers.
proxyProtocol Boolean: Boolean value that indicates if Proxy Protocol is enabled.

filters GetLoadBalancerFilter[]: Query parameters for finding load balancers.
proxyProtocol boolean: Boolean value that indicates if Proxy Protocol is enabled.

filters Sequence[GetLoadBalancerFilter]: Query parameters for finding load balancers.
proxy_protocol bool: Boolean value that indicates if Proxy Protocol is enabled.

filters List<Property Map>: Query parameters for finding load balancers.
proxyProtocol Boolean: Boolean value that indicates if Proxy Protocol is enabled.