DigitalOcean v4.22.0, Sep 22 23

DigitalOcean v4.22.0 published on Friday, Sep 22, 2023 by Pulumi

digitalocean.getLoadBalancer

Explore with Pulumi AI

DigitalOcean v4.22.0 published on Friday, Sep 22, 2023 by Pulumi

Get information on a load balancer for use in other resources. This data source provides all of the load balancers properties as configured on your DigitalOcean account. This is useful if the load balancer in question is not managed by the provider or you need to utilize any of the load balancers data.

An error is triggered if the provided load balancer name does not exist.

Example Usage

Get the load balancer by name

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

return await Deployment.RunAsync(() => 
{
    var example = DigitalOcean.GetLoadBalancer.Invoke(new()
    {
        Name = "app",
    });

    return new Dictionary<string, object?>
    {
        ["lbOutput"] = example.Apply(getLoadBalancerResult => getLoadBalancerResult.Ip),
    };
});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := digitalocean.LookupLoadBalancer(ctx, &digitalocean.LookupLoadBalancerArgs{
			Name: pulumi.StringRef("app"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("lbOutput", example.Ip)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.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 example = DigitaloceanFunctions.getLoadBalancer(GetLoadBalancerArgs.builder()
            .name("app")
            .build());

        ctx.export("lbOutput", example.applyValue(getLoadBalancerResult -> getLoadBalancerResult.ip()));
    }
}

import pulumi
import pulumi_digitalocean as digitalocean

example = digitalocean.get_load_balancer(name="app")
pulumi.export("lbOutput", example.ip)

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

const example = digitalocean.getLoadBalancer({
    name: "app",
});
export const lbOutput = example.then(example => example.ip);

variables:
  example:
    fn::invoke:
      Function: digitalocean:getLoadBalancer
      Arguments:
        name: app
outputs:
  lbOutput: ${example.ip}

Get the load balancer by ID

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

return await Deployment.RunAsync(() => 
{
    var example = DigitalOcean.GetLoadBalancer.Invoke(new()
    {
        Id = "loadbalancer_id",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.LookupLoadBalancer(ctx, &digitalocean.LookupLoadBalancerArgs{
			Id: pulumi.StringRef("loadbalancer_id"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.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 example = DigitaloceanFunctions.getLoadBalancer(GetLoadBalancerArgs.builder()
            .id("loadbalancer_id")
            .build());

    }
}

import pulumi
import pulumi_digitalocean as digitalocean

example = digitalocean.get_load_balancer(id="loadbalancer_id")

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

const example = digitalocean.getLoadBalancer({
    id: "loadbalancer_id",
});

variables:
  example:
    fn::invoke:
      Function: digitalocean:getLoadBalancer
      Arguments:
        id: loadbalancer_id

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(id: Optional[str] = None,
                      name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetLoadBalancerResult
def get_load_balancer_output(id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = 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)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Id string: The ID of load balancer.
Name string: The name of load balancer.

Id string: The ID of load balancer.
Name string: The name of load balancer.

id String: The ID of load balancer.
name String: The name of load balancer.

id string: The ID of load balancer.
name string: The name of load balancer.

id str: The ID of load balancer.
name str: The name of load balancer.

id String: The ID of load balancer.
name String: The name of load balancer.

getLoadBalancer Result

The following output properties are available:

Algorithm string
DisableLetsEncryptDnsRecords bool
DropletIds List<int>
DropletTag string
EnableBackendKeepalive bool
EnableProxyProtocol bool
Firewalls List<Pulumi.DigitalOcean.Outputs.GetLoadBalancerFirewall>
ForwardingRules List<Pulumi.DigitalOcean.Outputs.GetLoadBalancerForwardingRule>
Healthchecks List<Pulumi.DigitalOcean.Outputs.GetLoadBalancerHealthcheck>
HttpIdleTimeoutSeconds int
Ip string
LoadBalancerUrn string
ProjectId string
RedirectHttpToHttps bool
Region string
Size string
SizeUnit int
Status string
StickySessions List<Pulumi.DigitalOcean.Outputs.GetLoadBalancerStickySession>
VpcUuid string
Id string
Name string

Algorithm string
DisableLetsEncryptDnsRecords bool
DropletIds []int
DropletTag string
EnableBackendKeepalive bool
EnableProxyProtocol bool
Firewalls []GetLoadBalancerFirewall
ForwardingRules []GetLoadBalancerForwardingRule
Healthchecks []GetLoadBalancerHealthcheck
HttpIdleTimeoutSeconds int
Ip string
LoadBalancerUrn string
ProjectId string
RedirectHttpToHttps bool
Region string
Size string
SizeUnit int
Status string
StickySessions []GetLoadBalancerStickySession
VpcUuid string
Id string
Name string

algorithm String
disableLetsEncryptDnsRecords Boolean
dropletIds List<Integer>
dropletTag String
enableBackendKeepalive Boolean
enableProxyProtocol Boolean
firewalls List<GetLoadBalancerFirewall>
forwardingRules List<GetLoadBalancerForwardingRule>
healthchecks List<GetLoadBalancerHealthcheck>
httpIdleTimeoutSeconds Integer
ip String
loadBalancerUrn String
projectId String
redirectHttpToHttps Boolean
region String
size String
sizeUnit Integer
status String
stickySessions List<GetLoadBalancerStickySession>
vpcUuid String
id String
name String

algorithm string
disableLetsEncryptDnsRecords boolean
dropletIds number[]
dropletTag string
enableBackendKeepalive boolean
enableProxyProtocol boolean
firewalls GetLoadBalancerFirewall[]
forwardingRules GetLoadBalancerForwardingRule[]
healthchecks GetLoadBalancerHealthcheck[]
httpIdleTimeoutSeconds number
ip string
loadBalancerUrn string
projectId string
redirectHttpToHttps boolean
region string
size string
sizeUnit number
status string
stickySessions GetLoadBalancerStickySession[]
vpcUuid string
id string
name string

algorithm str
disable_lets_encrypt_dns_records bool
droplet_ids Sequence[int]
droplet_tag str
enable_backend_keepalive bool
enable_proxy_protocol bool
firewalls Sequence[GetLoadBalancerFirewall]
forwarding_rules Sequence[GetLoadBalancerForwardingRule]
healthchecks Sequence[GetLoadBalancerHealthcheck]
http_idle_timeout_seconds int
ip str
load_balancer_urn str
project_id str
redirect_http_to_https bool
region str
size str
size_unit int
status str
sticky_sessions Sequence[GetLoadBalancerStickySession]
vpc_uuid str
id str
name str

algorithm String
disableLetsEncryptDnsRecords Boolean
dropletIds List<Number>
dropletTag String
enableBackendKeepalive Boolean
enableProxyProtocol Boolean
firewalls List<Property Map>
forwardingRules List<Property Map>
healthchecks List<Property Map>
httpIdleTimeoutSeconds Number
ip String
loadBalancerUrn String
projectId String
redirectHttpToHttps Boolean
region String
size String
sizeUnit Number
status String
stickySessions List<Property Map>
vpcUuid String
id String
name String

Supporting Types

GetLoadBalancerFirewall

Allows List<string>
Denies List<string>

Allows []string
Denies []string

allows List<String>
denies List<String>

allows string[]
denies string[]

allows Sequence[str]
denies Sequence[str]

allows List<String>
denies List<String>

Package Details

Repository: DigitalOcean pulumi/pulumi-digitalocean
License: Apache-2.0
Notes: This Pulumi package is based on the digitalocean Terraform Provider.

DigitalOcean v4.22.0 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-digitalocean

digitalocean.getLoadBalancer

On this page

On this page

Example Usage

Using getLoadBalancer

getLoadBalancer Result

Supporting Types

GetLoadBalancerFirewall

GetLoadBalancerForwardingRule

GetLoadBalancerHealthcheck

GetLoadBalancerStickySession

Package Details

On this page

On this page