1. Packages
  2. Hcloud Provider
  3. API Docs
  4. getLoadBalancers
Hetzner Cloud v1.22.0 published on Wednesday, Feb 26, 2025 by Pulumi

hcloud.getLoadBalancers

Explore with Pulumi AI

Hetzner Cloud v1.22.0 published on Wednesday, Feb 26, 2025 by Pulumi

Provides details about multiple Hetzner Cloud Load Balancers.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as hcloud from "@pulumi/hcloud";

const lb2 = hcloud.getLoadBalancers({});
const lb3 = hcloud.getLoadBalancers({
    withSelector: "key=value",
});
Copy
import pulumi
import pulumi_hcloud as hcloud

lb2 = hcloud.get_load_balancers()
lb3 = hcloud.get_load_balancers(with_selector="key=value")
Copy
package main

import (
	"github.com/pulumi/pulumi-hcloud/sdk/go/hcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hcloud.GetLoadBalancers(ctx, &hcloud.GetLoadBalancersArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = hcloud.GetLoadBalancers(ctx, &hcloud.GetLoadBalancersArgs{
			WithSelector: pulumi.StringRef("key=value"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using HCloud = Pulumi.HCloud;

return await Deployment.RunAsync(() => 
{
    var lb2 = HCloud.GetLoadBalancers.Invoke();

    var lb3 = HCloud.GetLoadBalancers.Invoke(new()
    {
        WithSelector = "key=value",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hcloud.HcloudFunctions;
import com.pulumi.hcloud.inputs.GetLoadBalancersArgs;
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 lb2 = HcloudFunctions.getLoadBalancers();

        final var lb3 = HcloudFunctions.getLoadBalancers(GetLoadBalancersArgs.builder()
            .withSelector("key=value")
            .build());

    }
}
Copy
variables:
  lb2:
    fn::invoke:
      function: hcloud:getLoadBalancers
      arguments: {}
  lb3:
    fn::invoke:
      function: hcloud:getLoadBalancers
      arguments:
        withSelector: key=value
Copy

Using getLoadBalancers

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 getLoadBalancers(args: GetLoadBalancersArgs, opts?: InvokeOptions): Promise<GetLoadBalancersResult>
function getLoadBalancersOutput(args: GetLoadBalancersOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancersResult>
Copy
def get_load_balancers(with_selector: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetLoadBalancersResult
def get_load_balancers_output(with_selector: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancersResult]
Copy
func GetLoadBalancers(ctx *Context, args *GetLoadBalancersArgs, opts ...InvokeOption) (*GetLoadBalancersResult, error)
func GetLoadBalancersOutput(ctx *Context, args *GetLoadBalancersOutputArgs, opts ...InvokeOption) GetLoadBalancersResultOutput
Copy

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

public static class GetLoadBalancers 
{
    public static Task<GetLoadBalancersResult> InvokeAsync(GetLoadBalancersArgs args, InvokeOptions? opts = null)
    public static Output<GetLoadBalancersResult> Invoke(GetLoadBalancersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLoadBalancersResult> getLoadBalancers(GetLoadBalancersArgs args, InvokeOptions options)
public static Output<GetLoadBalancersResult> getLoadBalancers(GetLoadBalancersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: hcloud:index/getLoadBalancers:getLoadBalancers
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

getLoadBalancers Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
LoadBalancers List<Pulumi.HCloud.Outputs.GetLoadBalancersLoadBalancer>
(list) List of all matching load balancers. See data.hcloud_load_balancer for schema.
WithSelector string
Id string
The provider-assigned unique ID for this managed resource.
LoadBalancers []GetLoadBalancersLoadBalancer
(list) List of all matching load balancers. See data.hcloud_load_balancer for schema.
WithSelector string
id String
The provider-assigned unique ID for this managed resource.
loadBalancers List<GetLoadBalancersLoadBalancer>
(list) List of all matching load balancers. See data.hcloud_load_balancer for schema.
withSelector String
id string
The provider-assigned unique ID for this managed resource.
loadBalancers GetLoadBalancersLoadBalancer[]
(list) List of all matching load balancers. See data.hcloud_load_balancer for schema.
withSelector string
id str
The provider-assigned unique ID for this managed resource.
load_balancers Sequence[GetLoadBalancersLoadBalancer]
(list) List of all matching load balancers. See data.hcloud_load_balancer for schema.
with_selector str
id String
The provider-assigned unique ID for this managed resource.
loadBalancers List<Property Map>
(list) List of all matching load balancers. See data.hcloud_load_balancer for schema.
withSelector String

Supporting Types

GetLoadBalancersLoadBalancer

Algorithms This property is required. List<Pulumi.HCloud.Inputs.GetLoadBalancersLoadBalancerAlgorithm>
DeleteProtection This property is required. bool
Id This property is required. int
Ipv4 This property is required. string
Ipv6 This property is required. string
Labels This property is required. Dictionary<string, string>
LoadBalancerType This property is required. string
Location This property is required. string
NetworkId This property is required. int
NetworkIp This property is required. string
NetworkZone This property is required. string
Services This property is required. List<Pulumi.HCloud.Inputs.GetLoadBalancersLoadBalancerService>
Targets This property is required. List<Pulumi.HCloud.Inputs.GetLoadBalancersLoadBalancerTarget>
Name string
Algorithms This property is required. []GetLoadBalancersLoadBalancerAlgorithm
DeleteProtection This property is required. bool
Id This property is required. int
Ipv4 This property is required. string
Ipv6 This property is required. string
Labels This property is required. map[string]string
LoadBalancerType This property is required. string
Location This property is required. string
NetworkId This property is required. int
NetworkIp This property is required. string
NetworkZone This property is required. string
Services This property is required. []GetLoadBalancersLoadBalancerService
Targets This property is required. []GetLoadBalancersLoadBalancerTarget
Name string
algorithms This property is required. List<GetLoadBalancersLoadBalancerAlgorithm>
deleteProtection This property is required. Boolean
id This property is required. Integer
ipv4 This property is required. String
ipv6 This property is required. String
labels This property is required. Map<String,String>
loadBalancerType This property is required. String
location This property is required. String
networkId This property is required. Integer
networkIp This property is required. String
networkZone This property is required. String
services This property is required. List<GetLoadBalancersLoadBalancerService>
targets This property is required. List<GetLoadBalancersLoadBalancerTarget>
name String
algorithms This property is required. GetLoadBalancersLoadBalancerAlgorithm[]
deleteProtection This property is required. boolean
id This property is required. number
ipv4 This property is required. string
ipv6 This property is required. string
labels This property is required. {[key: string]: string}
loadBalancerType This property is required. string
location This property is required. string
networkId This property is required. number
networkIp This property is required. string
networkZone This property is required. string
services This property is required. GetLoadBalancersLoadBalancerService[]
targets This property is required. GetLoadBalancersLoadBalancerTarget[]
name string
algorithms This property is required. Sequence[GetLoadBalancersLoadBalancerAlgorithm]
delete_protection This property is required. bool
id This property is required. int
ipv4 This property is required. str
ipv6 This property is required. str
labels This property is required. Mapping[str, str]
load_balancer_type This property is required. str
location This property is required. str
network_id This property is required. int
network_ip This property is required. str
network_zone This property is required. str
services This property is required. Sequence[GetLoadBalancersLoadBalancerService]
targets This property is required. Sequence[GetLoadBalancersLoadBalancerTarget]
name str
algorithms This property is required. List<Property Map>
deleteProtection This property is required. Boolean
id This property is required. Number
ipv4 This property is required. String
ipv6 This property is required. String
labels This property is required. Map<String>
loadBalancerType This property is required. String
location This property is required. String
networkId This property is required. Number
networkIp This property is required. String
networkZone This property is required. String
services This property is required. List<Property Map>
targets This property is required. List<Property Map>
name String

GetLoadBalancersLoadBalancerAlgorithm

Type This property is required. string
Type This property is required. string
type This property is required. String
type This property is required. string
type This property is required. str
type This property is required. String

GetLoadBalancersLoadBalancerService

DestinationPort This property is required. int
HealthChecks This property is required. List<Pulumi.HCloud.Inputs.GetLoadBalancersLoadBalancerServiceHealthCheck>
Https This property is required. List<Pulumi.HCloud.Inputs.GetLoadBalancersLoadBalancerServiceHttp>
ListenPort This property is required. int
Protocol This property is required. string
Proxyprotocol This property is required. bool
DestinationPort This property is required. int
HealthChecks This property is required. []GetLoadBalancersLoadBalancerServiceHealthCheck
Https This property is required. []GetLoadBalancersLoadBalancerServiceHttp
ListenPort This property is required. int
Protocol This property is required. string
Proxyprotocol This property is required. bool
destinationPort This property is required. Integer
healthChecks This property is required. List<GetLoadBalancersLoadBalancerServiceHealthCheck>
https This property is required. List<GetLoadBalancersLoadBalancerServiceHttp>
listenPort This property is required. Integer
protocol This property is required. String
proxyprotocol This property is required. Boolean
destinationPort This property is required. number
healthChecks This property is required. GetLoadBalancersLoadBalancerServiceHealthCheck[]
https This property is required. GetLoadBalancersLoadBalancerServiceHttp[]
listenPort This property is required. number
protocol This property is required. string
proxyprotocol This property is required. boolean
destination_port This property is required. int
health_checks This property is required. Sequence[GetLoadBalancersLoadBalancerServiceHealthCheck]
https This property is required. Sequence[GetLoadBalancersLoadBalancerServiceHttp]
listen_port This property is required. int
protocol This property is required. str
proxyprotocol This property is required. bool
destinationPort This property is required. Number
healthChecks This property is required. List<Property Map>
https This property is required. List<Property Map>
listenPort This property is required. Number
protocol This property is required. String
proxyprotocol This property is required. Boolean

GetLoadBalancersLoadBalancerServiceHealthCheck

Https This property is required. List<Pulumi.HCloud.Inputs.GetLoadBalancersLoadBalancerServiceHealthCheckHttp>
Interval This property is required. int
Port This property is required. int
Protocol This property is required. string
Retries This property is required. int
Timeout This property is required. int
Https This property is required. []GetLoadBalancersLoadBalancerServiceHealthCheckHttp
Interval This property is required. int
Port This property is required. int
Protocol This property is required. string
Retries This property is required. int
Timeout This property is required. int
https This property is required. List<GetLoadBalancersLoadBalancerServiceHealthCheckHttp>
interval This property is required. Integer
port This property is required. Integer
protocol This property is required. String
retries This property is required. Integer
timeout This property is required. Integer
https This property is required. GetLoadBalancersLoadBalancerServiceHealthCheckHttp[]
interval This property is required. number
port This property is required. number
protocol This property is required. string
retries This property is required. number
timeout This property is required. number
https This property is required. Sequence[GetLoadBalancersLoadBalancerServiceHealthCheckHttp]
interval This property is required. int
port This property is required. int
protocol This property is required. str
retries This property is required. int
timeout This property is required. int
https This property is required. List<Property Map>
interval This property is required. Number
port This property is required. Number
protocol This property is required. String
retries This property is required. Number
timeout This property is required. Number

GetLoadBalancersLoadBalancerServiceHealthCheckHttp

Domain This property is required. string
Path This property is required. string
Response This property is required. string
StatusCodes This property is required. List<int>
Tls This property is required. bool
Domain This property is required. string
Path This property is required. string
Response This property is required. string
StatusCodes This property is required. []int
Tls This property is required. bool
domain This property is required. String
path This property is required. String
response This property is required. String
statusCodes This property is required. List<Integer>
tls This property is required. Boolean
domain This property is required. string
path This property is required. string
response This property is required. string
statusCodes This property is required. number[]
tls This property is required. boolean
domain This property is required. str
path This property is required. str
response This property is required. str
status_codes This property is required. Sequence[int]
tls This property is required. bool
domain This property is required. String
path This property is required. String
response This property is required. String
statusCodes This property is required. List<Number>
tls This property is required. Boolean

GetLoadBalancersLoadBalancerServiceHttp

Certificates This property is required. List<string>
CookieLifetime This property is required. int
CookieName This property is required. string
RedirectHttp This property is required. bool
StickySessions This property is required. bool
Certificates This property is required. []string
CookieLifetime This property is required. int
CookieName This property is required. string
RedirectHttp This property is required. bool
StickySessions This property is required. bool
certificates This property is required. List<String>
cookieLifetime This property is required. Integer
cookieName This property is required. String
redirectHttp This property is required. Boolean
stickySessions This property is required. Boolean
certificates This property is required. string[]
cookieLifetime This property is required. number
cookieName This property is required. string
redirectHttp This property is required. boolean
stickySessions This property is required. boolean
certificates This property is required. Sequence[str]
cookie_lifetime This property is required. int
cookie_name This property is required. str
redirect_http This property is required. bool
sticky_sessions This property is required. bool
certificates This property is required. List<String>
cookieLifetime This property is required. Number
cookieName This property is required. String
redirectHttp This property is required. Boolean
stickySessions This property is required. Boolean

GetLoadBalancersLoadBalancerTarget

LabelSelector This property is required. string
ServerId This property is required. int
Type This property is required. string
LabelSelector This property is required. string
ServerId This property is required. int
Type This property is required. string
labelSelector This property is required. String
serverId This property is required. Integer
type This property is required. String
labelSelector This property is required. string
serverId This property is required. number
type This property is required. string
label_selector This property is required. str
server_id This property is required. int
type This property is required. str
labelSelector This property is required. String
serverId This property is required. Number
type This property is required. String

Package Details

Repository
Hetzner Cloud pulumi/pulumi-hcloud
License
Apache-2.0
Notes
This Pulumi package is based on the hcloud Terraform Provider.
Hetzner Cloud v1.22.0 published on Wednesday, Feb 26, 2025 by Pulumi