1. Packages
  2. AWS Native
  3. API Docs
  4. elasticloadbalancingv2
  5. getLoadBalancer

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.98.0 published on Thursday, Feb 29, 2024 by Pulumi

aws-native.elasticloadbalancingv2.getLoadBalancer

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.98.0 published on Thursday, Feb 29, 2024 by Pulumi

    Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.

    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(load_balancer_arn: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetLoadBalancerResult
    def get_load_balancer_output(load_balancer_arn: 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: aws-native:elasticloadbalancingv2:getLoadBalancer
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getLoadBalancer Result

    The following output properties are available:

    CanonicalHostedZoneId string
    DnsName string
    EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic string
    Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
    IpAddressType string
    The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
    LoadBalancerArn string
    LoadBalancerAttributes List<Pulumi.AwsNative.ElasticLoadBalancingV2.Outputs.LoadBalancerAttribute>
    The load balancer attributes.
    LoadBalancerFullName string
    LoadBalancerName string
    SecurityGroups List<string>
    [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
    SubnetMappings List<Pulumi.AwsNative.ElasticLoadBalancingV2.Outputs.LoadBalancerSubnetMapping>
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP
    Subnets List<string>
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags to assign to the load balancer.
    CanonicalHostedZoneId string
    DnsName string
    EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic string
    Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
    IpAddressType string
    The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
    LoadBalancerArn string
    LoadBalancerAttributes []LoadBalancerAttribute
    The load balancer attributes.
    LoadBalancerFullName string
    LoadBalancerName string
    SecurityGroups []string
    [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
    SubnetMappings []LoadBalancerSubnetMapping
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP
    Subnets []string
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
    Tags Tag
    The tags to assign to the load balancer.
    canonicalHostedZoneId String
    dnsName String
    enforceSecurityGroupInboundRulesOnPrivateLinkTraffic String
    Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
    ipAddressType String
    The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
    loadBalancerArn String
    loadBalancerAttributes List<LoadBalancerAttribute>
    The load balancer attributes.
    loadBalancerFullName String
    loadBalancerName String
    securityGroups List<String>
    [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
    subnetMappings List<LoadBalancerSubnetMapping>
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP
    subnets List<String>
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
    tags List<Tag>
    The tags to assign to the load balancer.
    canonicalHostedZoneId string
    dnsName string
    enforceSecurityGroupInboundRulesOnPrivateLinkTraffic string
    Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
    ipAddressType string
    The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
    loadBalancerArn string
    loadBalancerAttributes LoadBalancerAttribute[]
    The load balancer attributes.
    loadBalancerFullName string
    loadBalancerName string
    securityGroups string[]
    [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
    subnetMappings LoadBalancerSubnetMapping[]
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP
    subnets string[]
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
    tags Tag[]
    The tags to assign to the load balancer.
    canonical_hosted_zone_id str
    dns_name str
    enforce_security_group_inbound_rules_on_private_link_traffic str
    Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
    ip_address_type str
    The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
    load_balancer_arn str
    load_balancer_attributes Sequence[LoadBalancerAttribute]
    The load balancer attributes.
    load_balancer_full_name str
    load_balancer_name str
    security_groups Sequence[str]
    [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
    subnet_mappings Sequence[LoadBalancerSubnetMapping]
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP
    subnets Sequence[str]
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
    tags Sequence[_root_Tag]
    The tags to assign to the load balancer.
    canonicalHostedZoneId String
    dnsName String
    enforceSecurityGroupInboundRulesOnPrivateLinkTraffic String
    Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
    ipAddressType String
    The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
    loadBalancerArn String
    loadBalancerAttributes List<Property Map>
    The load balancer attributes.
    loadBalancerFullName String
    loadBalancerName String
    securityGroups List<String>
    [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
    subnetMappings List<Property Map>
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP
    subnets List<String>
    The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
    tags List<Property Map>
    The tags to assign to the load balancer.

    Supporting Types

    LoadBalancerAttribute

    Key string

    The name of the attribute. The following attributes are supported by all load balancers:

    • deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
    • load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.

    The following attributes are supported by both Application Load Balancers and Network Load Balancers:

    • access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
    • access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and h
    Value string
    The value of the attribute.
    Key string

    The name of the attribute. The following attributes are supported by all load balancers:

    • deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
    • load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.

    The following attributes are supported by both Application Load Balancers and Network Load Balancers:

    • access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
    • access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and h
    Value string
    The value of the attribute.
    key String

    The name of the attribute. The following attributes are supported by all load balancers:

    • deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
    • load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.

    The following attributes are supported by both Application Load Balancers and Network Load Balancers:

    • access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
    • access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and h
    value String
    The value of the attribute.
    key string

    The name of the attribute. The following attributes are supported by all load balancers:

    • deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
    • load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.

    The following attributes are supported by both Application Load Balancers and Network Load Balancers:

    • access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
    • access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and h
    value string
    The value of the attribute.
    key str

    The name of the attribute. The following attributes are supported by all load balancers:

    • deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
    • load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.

    The following attributes are supported by both Application Load Balancers and Network Load Balancers:

    • access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
    • access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and h
    value str
    The value of the attribute.
    key String

    The name of the attribute. The following attributes are supported by all load balancers:

    • deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
    • load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.

    The following attributes are supported by both Application Load Balancers and Network Load Balancers:

    • access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
    • access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and h
    value String
    The value of the attribute.

    LoadBalancerSubnetMapping

    SubnetId string
    The ID of the subnet.
    AllocationId string
    [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
    IPv6Address string
    [Network Load Balancers] The IPv6 address.
    PrivateIPv4Address string
    [Network Load Balancers] The private IPv4 address for an internal load balancer.
    SubnetId string
    The ID of the subnet.
    AllocationId string
    [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
    IPv6Address string
    [Network Load Balancers] The IPv6 address.
    PrivateIPv4Address string
    [Network Load Balancers] The private IPv4 address for an internal load balancer.
    subnetId String
    The ID of the subnet.
    allocationId String
    [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
    iPv6Address String
    [Network Load Balancers] The IPv6 address.
    privateIPv4Address String
    [Network Load Balancers] The private IPv4 address for an internal load balancer.
    subnetId string
    The ID of the subnet.
    allocationId string
    [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
    iPv6Address string
    [Network Load Balancers] The IPv6 address.
    privateIPv4Address string
    [Network Load Balancers] The private IPv4 address for an internal load balancer.
    subnet_id str
    The ID of the subnet.
    allocation_id str
    [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
    i_pv6_address str
    [Network Load Balancers] The IPv6 address.
    private_i_pv4_address str
    [Network Load Balancers] The private IPv4 address for an internal load balancer.
    subnetId String
    The ID of the subnet.
    allocationId String
    [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
    iPv6Address String
    [Network Load Balancers] The IPv6 address.
    privateIPv4Address String
    [Network Load Balancers] The private IPv4 address for an internal load balancer.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.98.0 published on Thursday, Feb 29, 2024 by Pulumi