1. Packages
  2. AWS
  3. API Docs
  4. lb
  5. getLoadBalancer
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
aws logo
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi

    Note: aws.alb.LoadBalancer is known as aws.lb.LoadBalancer. The functionality is identical.

    Provides information about a Load Balancer.

    This data source can prove useful when a module accepts an LB as an input variable and needs to, for example, determine the security groups associated with it, etc.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var lbArn = config.Get("lbArn") ?? "";
        var lbName = config.Get("lbName") ?? "";
        var test = Aws.LB.GetLoadBalancer.Invoke(new()
        {
            Arn = lbArn,
            Name = lbName,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/lb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		lbArn := ""
    		if param := cfg.Get("lbArn"); param != "" {
    			lbArn = param
    		}
    		lbName := ""
    		if param := cfg.Get("lbName"); param != "" {
    			lbName = param
    		}
    		_, err := lb.LookupLoadBalancer(ctx, &lb.LookupLoadBalancerArgs{
    			Arn:  pulumi.StringRef(lbArn),
    			Name: pulumi.StringRef(lbName),
    		}, 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.aws.lb.LbFunctions;
    import com.pulumi.aws.lb.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 config = ctx.config();
            final var lbArn = config.get("lbArn").orElse("");
            final var lbName = config.get("lbName").orElse("");
            final var test = LbFunctions.getLoadBalancer(GetLoadBalancerArgs.builder()
                .arn(lbArn)
                .name(lbName)
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const config = new pulumi.Config();
    const lbArn = config.get("lbArn") || "";
    const lbName = config.get("lbName") || "";
    const test = aws.lb.getLoadBalancer({
        arn: lbArn,
        name: lbName,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    config = pulumi.Config()
    lb_arn = config.get("lbArn")
    if lb_arn is None:
        lb_arn = ""
    lb_name = config.get("lbName")
    if lb_name is None:
        lb_name = ""
    test = aws.lb.get_load_balancer(arn=lb_arn,
        name=lb_name)
    
    configuration:
      lbArn:
        type: string
        default:
      lbName:
        type: string
        default:
    variables:
      test:
        fn::invoke:
          Function: aws:lb:getLoadBalancer
          Arguments:
            arn: ${lbArn}
            name: ${lbName}
    

    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(arn: Optional[str] = None,
                          name: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetLoadBalancerResult
    def get_load_balancer_output(arn: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          tags: Optional[pulumi.Input[Mapping[str, 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)
    public static Output<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws:lb/getLoadBalancer:getLoadBalancer
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Arn string
    Full ARN of the load balancer.
    Name string
    Unique name of the load balancer.
    Tags Dictionary<string, string>

    Mapping of tags, each pair of which must exactly match a pair on the desired load balancer.

    NOTE: When both arn and name are specified, arn takes precedence. tags has lowest precedence.

    Arn string
    Full ARN of the load balancer.
    Name string
    Unique name of the load balancer.
    Tags map[string]string

    Mapping of tags, each pair of which must exactly match a pair on the desired load balancer.

    NOTE: When both arn and name are specified, arn takes precedence. tags has lowest precedence.

    arn String
    Full ARN of the load balancer.
    name String
    Unique name of the load balancer.
    tags Map<String,String>

    Mapping of tags, each pair of which must exactly match a pair on the desired load balancer.

    NOTE: When both arn and name are specified, arn takes precedence. tags has lowest precedence.

    arn string
    Full ARN of the load balancer.
    name string
    Unique name of the load balancer.
    tags {[key: string]: string}

    Mapping of tags, each pair of which must exactly match a pair on the desired load balancer.

    NOTE: When both arn and name are specified, arn takes precedence. tags has lowest precedence.

    arn str
    Full ARN of the load balancer.
    name str
    Unique name of the load balancer.
    tags Mapping[str, str]

    Mapping of tags, each pair of which must exactly match a pair on the desired load balancer.

    NOTE: When both arn and name are specified, arn takes precedence. tags has lowest precedence.

    arn String
    Full ARN of the load balancer.
    name String
    Unique name of the load balancer.
    tags Map<String>

    Mapping of tags, each pair of which must exactly match a pair on the desired load balancer.

    NOTE: When both arn and name are specified, arn takes precedence. tags has lowest precedence.

    getLoadBalancer Result

    The following output properties are available:

    Supporting Types

    GetLoadBalancerAccessLogs

    Bucket string
    Enabled bool
    Prefix string
    Bucket string
    Enabled bool
    Prefix string
    bucket String
    enabled Boolean
    prefix String
    bucket string
    enabled boolean
    prefix string
    bucket str
    enabled bool
    prefix str
    bucket String
    enabled Boolean
    prefix String

    GetLoadBalancerSubnetMapping

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v5.43.0 (Older version)
    published on Tuesday, Mar 10, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.