AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
aws.alb.getLoadBalancer
Explore with Pulumi AI
Note:
aws.alb.LoadBalanceris known asaws.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
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)
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}
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 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());
    }
}
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:alb/getLoadBalancer:getLoadBalancer
  arguments:
    # arguments dictionaryThe following arguments are supported:
getLoadBalancer Result
The following output properties are available:
- AccessLogs GetLoad Balancer Access Logs 
- Arn string
- ArnSuffix string
- ClientKeep intAlive 
- ConnectionLogs List<GetLoad Balancer Connection Log> 
- CustomerOwned stringIpv4Pool 
- DesyncMitigation stringMode 
- DnsName string
- DnsRecord stringClient Routing Policy 
- DropInvalid boolHeader Fields 
- EnableCross boolZone Load Balancing 
- EnableDeletion boolProtection 
- EnableHttp2 bool
- EnableTls boolVersion And Cipher Suite Headers 
- EnableWaf boolFail Open 
- EnableXff boolClient Port 
- EnableZonal boolShift 
- EnforceSecurity stringGroup Inbound Rules On Private Link Traffic 
- Id string
- The provider-assigned unique ID for this managed resource.
- IdleTimeout int
- Internal bool
- IpAddress stringType 
- LoadBalancer stringType 
- Name string
- PreserveHost boolHeader 
- SecurityGroups List<string>
- SubnetMappings List<GetLoad Balancer Subnet Mapping> 
- Subnets List<string>
- Dictionary<string, string>
- VpcId string
- XffHeader stringProcessing Mode 
- ZoneId string
- AccessLogs GetLoad Balancer Access Logs 
- Arn string
- ArnSuffix string
- ClientKeep intAlive 
- ConnectionLogs []GetLoad Balancer Connection Log 
- CustomerOwned stringIpv4Pool 
- DesyncMitigation stringMode 
- DnsName string
- DnsRecord stringClient Routing Policy 
- DropInvalid boolHeader Fields 
- EnableCross boolZone Load Balancing 
- EnableDeletion boolProtection 
- EnableHttp2 bool
- EnableTls boolVersion And Cipher Suite Headers 
- EnableWaf boolFail Open 
- EnableXff boolClient Port 
- EnableZonal boolShift 
- EnforceSecurity stringGroup Inbound Rules On Private Link Traffic 
- Id string
- The provider-assigned unique ID for this managed resource.
- IdleTimeout int
- Internal bool
- IpAddress stringType 
- LoadBalancer stringType 
- Name string
- PreserveHost boolHeader 
- SecurityGroups []string
- SubnetMappings []GetLoad Balancer Subnet Mapping 
- Subnets []string
- map[string]string
- VpcId string
- XffHeader stringProcessing Mode 
- ZoneId string
- accessLogs GetLoad Balancer Access Logs 
- arn String
- arnSuffix String
- clientKeep IntegerAlive 
- connectionLogs List<GetLoad Balancer Connection Log> 
- customerOwned StringIpv4Pool 
- desyncMitigation StringMode 
- dnsName String
- dnsRecord StringClient Routing Policy 
- dropInvalid BooleanHeader Fields 
- enableCross BooleanZone Load Balancing 
- enableDeletion BooleanProtection 
- enableHttp2 Boolean
- enableTls BooleanVersion And Cipher Suite Headers 
- enableWaf BooleanFail Open 
- enableXff BooleanClient Port 
- enableZonal BooleanShift 
- enforceSecurity StringGroup Inbound Rules On Private Link Traffic 
- id String
- The provider-assigned unique ID for this managed resource.
- idleTimeout Integer
- internal Boolean
- ipAddress StringType 
- loadBalancer StringType 
- name String
- preserveHost BooleanHeader 
- securityGroups List<String>
- subnetMappings List<GetLoad Balancer Subnet Mapping> 
- subnets List<String>
- Map<String,String>
- vpcId String
- xffHeader StringProcessing Mode 
- zoneId String
- accessLogs GetLoad Balancer Access Logs 
- arn string
- arnSuffix string
- clientKeep numberAlive 
- connectionLogs GetLoad Balancer Connection Log[] 
- customerOwned stringIpv4Pool 
- desyncMitigation stringMode 
- dnsName string
- dnsRecord stringClient Routing Policy 
- dropInvalid booleanHeader Fields 
- enableCross booleanZone Load Balancing 
- enableDeletion booleanProtection 
- enableHttp2 boolean
- enableTls booleanVersion And Cipher Suite Headers 
- enableWaf booleanFail Open 
- enableXff booleanClient Port 
- enableZonal booleanShift 
- enforceSecurity stringGroup Inbound Rules On Private Link Traffic 
- id string
- The provider-assigned unique ID for this managed resource.
- idleTimeout number
- internal boolean
- ipAddress stringType 
- loadBalancer stringType 
- name string
- preserveHost booleanHeader 
- securityGroups string[]
- subnetMappings GetLoad Balancer Subnet Mapping[] 
- subnets string[]
- {[key: string]: string}
- vpcId string
- xffHeader stringProcessing Mode 
- zoneId string
- access_logs GetLoad Balancer Access Logs 
- arn str
- arn_suffix str
- client_keep_ intalive 
- connection_logs Sequence[GetLoad Balancer Connection Log] 
- customer_owned_ stripv4_ pool 
- desync_mitigation_ strmode 
- dns_name str
- dns_record_ strclient_ routing_ policy 
- drop_invalid_ boolheader_ fields 
- enable_cross_ boolzone_ load_ balancing 
- enable_deletion_ boolprotection 
- enable_http2 bool
- enable_tls_ boolversion_ and_ cipher_ suite_ headers 
- enable_waf_ boolfail_ open 
- enable_xff_ boolclient_ port 
- enable_zonal_ boolshift 
- enforce_security_ strgroup_ inbound_ rules_ on_ private_ link_ traffic 
- id str
- The provider-assigned unique ID for this managed resource.
- idle_timeout int
- internal bool
- ip_address_ strtype 
- load_balancer_ strtype 
- name str
- preserve_host_ boolheader 
- security_groups Sequence[str]
- subnet_mappings Sequence[GetLoad Balancer Subnet Mapping] 
- subnets Sequence[str]
- Mapping[str, str]
- vpc_id str
- xff_header_ strprocessing_ mode 
- zone_id str
- accessLogs Property Map
- arn String
- arnSuffix String
- clientKeep NumberAlive 
- connectionLogs List<Property Map>
- customerOwned StringIpv4Pool 
- desyncMitigation StringMode 
- dnsName String
- dnsRecord StringClient Routing Policy 
- dropInvalid BooleanHeader Fields 
- enableCross BooleanZone Load Balancing 
- enableDeletion BooleanProtection 
- enableHttp2 Boolean
- enableTls BooleanVersion And Cipher Suite Headers 
- enableWaf BooleanFail Open 
- enableXff BooleanClient Port 
- enableZonal BooleanShift 
- enforceSecurity StringGroup Inbound Rules On Private Link Traffic 
- id String
- The provider-assigned unique ID for this managed resource.
- idleTimeout Number
- internal Boolean
- ipAddress StringType 
- loadBalancer StringType 
- name String
- preserveHost BooleanHeader 
- securityGroups List<String>
- subnetMappings List<Property Map>
- subnets List<String>
- Map<String>
- vpcId String
- xffHeader StringProcessing Mode 
- zoneId String
Supporting Types
GetLoadBalancerAccessLogs    
GetLoadBalancerConnectionLog    
GetLoadBalancerSubnetMapping    
- AllocationId string
- Ipv6Address string
- OutpostId string
- PrivateIpv4Address string
- SubnetId string
- AllocationId string
- Ipv6Address string
- OutpostId string
- PrivateIpv4Address string
- SubnetId string
- allocationId String
- ipv6Address String
- outpostId String
- privateIpv4Address String
- subnetId String
- allocationId string
- ipv6Address string
- outpostId string
- privateIpv4Address string
- subnetId string
- allocation_id str
- ipv6_address str
- outpost_id str
- private_ipv4_ straddress 
- subnet_id str
- allocationId String
- ipv6Address String
- outpostId String
- privateIpv4Address String
- subnetId String
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.