Docs Packages
  1. Packages
  2. Yandex
  3. API Docs
  4. getLbNetworkLoadBalancer
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
pulumi/pulumi-yandex

yandex.getLbNetworkLoadBalancer

Explore with Pulumi AI

yandex logo
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
pulumi/pulumi-yandex

    Get information about a Yandex Load Balancer network load balancer. For more information, see Yandex.Cloud Network Load Balancer.

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

const foo = pulumi.output(yandex.getLbNetworkLoadBalancer({
    networkLoadBalancerId: "my-network-load-balancer",
}));

    import pulumi
import pulumi_yandex as yandex

foo = yandex.get_lb_network_load_balancer(network_load_balancer_id="my-network-load-balancer")

    using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Yandex.GetLbNetworkLoadBalancer.InvokeAsync(new Yandex.GetLbNetworkLoadBalancerArgs
        {
            NetworkLoadBalancerId = "my-network-load-balancer",
        }));
    }

}

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "my-network-load-balancer"
		_, err := yandex.LookupLbNetworkLoadBalancer(ctx, &GetLbNetworkLoadBalancerArgs{
			NetworkLoadBalancerId: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    This data source is used to define [Load Balancer Network Load Balancers] that can be used by other resources.

    Using getLbNetworkLoadBalancer

    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 getLbNetworkLoadBalancer(args: GetLbNetworkLoadBalancerArgs, opts?: InvokeOptions): Promise<GetLbNetworkLoadBalancerResult>
function getLbNetworkLoadBalancerOutput(args: GetLbNetworkLoadBalancerOutputArgs, opts?: InvokeOptions): Output<GetLbNetworkLoadBalancerResult>
    def get_lb_network_load_balancer(folder_id: Optional[str] = None,
                                 name: Optional[str] = None,
                                 network_load_balancer_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetLbNetworkLoadBalancerResult
def get_lb_network_load_balancer_output(folder_id: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 network_load_balancer_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetLbNetworkLoadBalancerResult]
    func LookupLbNetworkLoadBalancer(ctx *Context, args *LookupLbNetworkLoadBalancerArgs, opts ...InvokeOption) (*LookupLbNetworkLoadBalancerResult, error)
func LookupLbNetworkLoadBalancerOutput(ctx *Context, args *LookupLbNetworkLoadBalancerOutputArgs, opts ...InvokeOption) LookupLbNetworkLoadBalancerResultOutput

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

    public static class GetLbNetworkLoadBalancer 
{
    public static Task<GetLbNetworkLoadBalancerResult> InvokeAsync(GetLbNetworkLoadBalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetLbNetworkLoadBalancerResult> Invoke(GetLbNetworkLoadBalancerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLbNetworkLoadBalancerResult> getLbNetworkLoadBalancer(GetLbNetworkLoadBalancerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: yandex:index/getLbNetworkLoadBalancer:getLbNetworkLoadBalancer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FolderId string
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    Name string
    • Name of the network load balancer.
    NetworkLoadBalancerId string
    Network load balancer ID.
    FolderId string
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    Name string
    • Name of the network load balancer.
    NetworkLoadBalancerId string
    Network load balancer ID.
    folderId String
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    name String
    • Name of the network load balancer.
    networkLoadBalancerId String
    Network load balancer ID.
    folderId string
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    name string
    • Name of the network load balancer.
    networkLoadBalancerId string
    Network load balancer ID.
    folder_id str
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    name str
    • Name of the network load balancer.
    network_load_balancer_id str
    Network load balancer ID.
    folderId String
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    name String
    • Name of the network load balancer.
    networkLoadBalancerId String
    Network load balancer ID.

    getLbNetworkLoadBalancer Result

    The following output properties are available:

    AttachedTargetGroups List<GetLbNetworkLoadBalancerAttachedTargetGroup>
    An attached target group is a group of targets that is attached to a load balancer. Structure is documented below.
    CreatedAt string
    Creation timestamp of this network load balancer.
    Description string
    Description of the network load balancer.
    FolderId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, string>
    Labels to assign to this network load balancer.
    Listeners List<GetLbNetworkLoadBalancerListener>
    Listener specification that will be used by a network load balancer. Structure is documented below.
    Name string
    Name of the listener.
    NetworkLoadBalancerId string
    RegionId string
    ID of the region where the network load balancer resides.
    Type string
    Type of the network load balancer.
    AttachedTargetGroups []GetLbNetworkLoadBalancerAttachedTargetGroup
    An attached target group is a group of targets that is attached to a load balancer. Structure is documented below.
    CreatedAt string
    Creation timestamp of this network load balancer.
    Description string
    Description of the network load balancer.
    FolderId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]string
    Labels to assign to this network load balancer.
    Listeners []GetLbNetworkLoadBalancerListener
    Listener specification that will be used by a network load balancer. Structure is documented below.
    Name string
    Name of the listener.
    NetworkLoadBalancerId string
    RegionId string
    ID of the region where the network load balancer resides.
    Type string
    Type of the network load balancer.
    attachedTargetGroups List<GetLbNetworkLoadBalancerAttachedTargetGroup>
    An attached target group is a group of targets that is attached to a load balancer. Structure is documented below.
    createdAt String
    Creation timestamp of this network load balancer.
    description String
    Description of the network load balancer.
    folderId String
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,String>
    Labels to assign to this network load balancer.
    listeners List<GetLbNetworkLoadBalancerListener>
    Listener specification that will be used by a network load balancer. Structure is documented below.
    name String
    Name of the listener.
    networkLoadBalancerId String
    regionId String
    ID of the region where the network load balancer resides.
    type String
    Type of the network load balancer.
    attachedTargetGroups GetLbNetworkLoadBalancerAttachedTargetGroup[]
    An attached target group is a group of targets that is attached to a load balancer. Structure is documented below.
    createdAt string
    Creation timestamp of this network load balancer.
    description string
    Description of the network load balancer.
    folderId string
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: string}
    Labels to assign to this network load balancer.
    listeners GetLbNetworkLoadBalancerListener[]
    Listener specification that will be used by a network load balancer. Structure is documented below.
    name string
    Name of the listener.
    networkLoadBalancerId string
    regionId string
    ID of the region where the network load balancer resides.
    type string
    Type of the network load balancer.
    attached_target_groups Sequence[GetLbNetworkLoadBalancerAttachedTargetGroup]
    An attached target group is a group of targets that is attached to a load balancer. Structure is documented below.
    created_at str
    Creation timestamp of this network load balancer.
    description str
    Description of the network load balancer.
    folder_id str
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, str]
    Labels to assign to this network load balancer.
    listeners Sequence[GetLbNetworkLoadBalancerListener]
    Listener specification that will be used by a network load balancer. Structure is documented below.
    name str
    Name of the listener.
    network_load_balancer_id str
    region_id str
    ID of the region where the network load balancer resides.
    type str
    Type of the network load balancer.
    attachedTargetGroups List<Property Map>
    An attached target group is a group of targets that is attached to a load balancer. Structure is documented below.
    createdAt String
    Creation timestamp of this network load balancer.
    description String
    Description of the network load balancer.
    folderId String
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String>
    Labels to assign to this network load balancer.
    listeners List<Property Map>
    Listener specification that will be used by a network load balancer. Structure is documented below.
    name String
    Name of the listener.
    networkLoadBalancerId String
    regionId String
    ID of the region where the network load balancer resides.
    type String
    Type of the network load balancer.

    Supporting Types

    GetLbNetworkLoadBalancerAttachedTargetGroup

    Healthchecks List<GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck>
    TargetGroupId string
    ID of the target group that attached to the network load balancer.

    • healthcheck.0.name - Name of the health check.
    • healthcheck.0.interval - The interval between health checks.
    • healthcheck.0.timeout - Timeout for a target to return a response for the health check.
    • healthcheck.0.unhealthy_threshold - Number of failed health checks before changing the status to UNHEALTHY.
    • healthcheck.0.healthy_threshold - Number of successful health checks required in order to set the HEALTHY status for the target.
    • healthcheck.0.tcp_options.0.port - Port to use for TCP health checks.
    • healthcheck.0.http_options.0.port - Port to use for HTTP health checks.
    • healthcheck.0.http_options.0.path - URL path to use for HTTP health checks.
    Healthchecks []GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck
    TargetGroupId string
    ID of the target group that attached to the network load balancer.

    • healthcheck.0.name - Name of the health check.
    • healthcheck.0.interval - The interval between health checks.
    • healthcheck.0.timeout - Timeout for a target to return a response for the health check.
    • healthcheck.0.unhealthy_threshold - Number of failed health checks before changing the status to UNHEALTHY.
    • healthcheck.0.healthy_threshold - Number of successful health checks required in order to set the HEALTHY status for the target.
    • healthcheck.0.tcp_options.0.port - Port to use for TCP health checks.
    • healthcheck.0.http_options.0.port - Port to use for HTTP health checks.
    • healthcheck.0.http_options.0.path - URL path to use for HTTP health checks.
    healthchecks List<GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck>
    targetGroupId String
    ID of the target group that attached to the network load balancer.

    • healthcheck.0.name - Name of the health check.
    • healthcheck.0.interval - The interval between health checks.
    • healthcheck.0.timeout - Timeout for a target to return a response for the health check.
    • healthcheck.0.unhealthy_threshold - Number of failed health checks before changing the status to UNHEALTHY.
    • healthcheck.0.healthy_threshold - Number of successful health checks required in order to set the HEALTHY status for the target.
    • healthcheck.0.tcp_options.0.port - Port to use for TCP health checks.
    • healthcheck.0.http_options.0.port - Port to use for HTTP health checks.
    • healthcheck.0.http_options.0.path - URL path to use for HTTP health checks.
    healthchecks GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck[]
    targetGroupId string
    ID of the target group that attached to the network load balancer.

    • healthcheck.0.name - Name of the health check.
    • healthcheck.0.interval - The interval between health checks.
    • healthcheck.0.timeout - Timeout for a target to return a response for the health check.
    • healthcheck.0.unhealthy_threshold - Number of failed health checks before changing the status to UNHEALTHY.
    • healthcheck.0.healthy_threshold - Number of successful health checks required in order to set the HEALTHY status for the target.
    • healthcheck.0.tcp_options.0.port - Port to use for TCP health checks.
    • healthcheck.0.http_options.0.port - Port to use for HTTP health checks.
    • healthcheck.0.http_options.0.path - URL path to use for HTTP health checks.
    healthchecks Sequence[GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck]
    target_group_id str
    ID of the target group that attached to the network load balancer.

    • healthcheck.0.name - Name of the health check.
    • healthcheck.0.interval - The interval between health checks.
    • healthcheck.0.timeout - Timeout for a target to return a response for the health check.
    • healthcheck.0.unhealthy_threshold - Number of failed health checks before changing the status to UNHEALTHY.
    • healthcheck.0.healthy_threshold - Number of successful health checks required in order to set the HEALTHY status for the target.
    • healthcheck.0.tcp_options.0.port - Port to use for TCP health checks.
    • healthcheck.0.http_options.0.port - Port to use for HTTP health checks.
    • healthcheck.0.http_options.0.path - URL path to use for HTTP health checks.
    healthchecks List<Property Map>
    targetGroupId String
    ID of the target group that attached to the network load balancer.

    • healthcheck.0.name - Name of the health check.
    • healthcheck.0.interval - The interval between health checks.
    • healthcheck.0.timeout - Timeout for a target to return a response for the health check.
    • healthcheck.0.unhealthy_threshold - Number of failed health checks before changing the status to UNHEALTHY.
    • healthcheck.0.healthy_threshold - Number of successful health checks required in order to set the HEALTHY status for the target.
    • healthcheck.0.tcp_options.0.port - Port to use for TCP health checks.
    • healthcheck.0.http_options.0.port - Port to use for HTTP health checks.
    • healthcheck.0.http_options.0.path - URL path to use for HTTP health checks.

    GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck

    GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOption

    Path string
    Port int
    Port for incoming traffic.
    Path string
    Port int
    Port for incoming traffic.
    path String
    port Integer
    Port for incoming traffic.
    path string
    port number
    Port for incoming traffic.
    path str
    port int
    Port for incoming traffic.
    path String
    port Number
    Port for incoming traffic.

    GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOption

    Port int
    Port for incoming traffic.
    Port int
    Port for incoming traffic.
    port Integer
    Port for incoming traffic.
    port number
    Port for incoming traffic.
    port int
    Port for incoming traffic.
    port Number
    Port for incoming traffic.

    GetLbNetworkLoadBalancerListener

    ExternalAddressSpecs List<GetLbNetworkLoadBalancerListenerExternalAddressSpec>
    InternalAddressSpecs List<GetLbNetworkLoadBalancerListenerInternalAddressSpec>
    Name string
    • Name of the network load balancer.
    Port int
    Port for incoming traffic.
    Protocol string
    Protocol for incoming traffic.
    TargetPort int
    Port of a target.

    • external_address_spec.0.address - External IP address of a listener.
    • external_address_spec.0.ip_version - IP version of the external addresses.
    • internal_address_spec.0.subnet_id - Subnet ID to which the internal IP address belongs
    • internal_address_spec.0.address - Internal IP address of a listener.
    • internal_address_spec.0.ip_version - IP version of the internal addresses.
    ExternalAddressSpecs []GetLbNetworkLoadBalancerListenerExternalAddressSpec
    InternalAddressSpecs []GetLbNetworkLoadBalancerListenerInternalAddressSpec
    Name string
    • Name of the network load balancer.
    Port int
    Port for incoming traffic.
    Protocol string
    Protocol for incoming traffic.
    TargetPort int
    Port of a target.

    • external_address_spec.0.address - External IP address of a listener.
    • external_address_spec.0.ip_version - IP version of the external addresses.
    • internal_address_spec.0.subnet_id - Subnet ID to which the internal IP address belongs
    • internal_address_spec.0.address - Internal IP address of a listener.
    • internal_address_spec.0.ip_version - IP version of the internal addresses.
    externalAddressSpecs List<GetLbNetworkLoadBalancerListenerExternalAddressSpec>
    internalAddressSpecs List<GetLbNetworkLoadBalancerListenerInternalAddressSpec>
    name String
    • Name of the network load balancer.
    port Integer
    Port for incoming traffic.
    protocol String
    Protocol for incoming traffic.
    targetPort Integer
    Port of a target.

    • external_address_spec.0.address - External IP address of a listener.
    • external_address_spec.0.ip_version - IP version of the external addresses.
    • internal_address_spec.0.subnet_id - Subnet ID to which the internal IP address belongs
    • internal_address_spec.0.address - Internal IP address of a listener.
    • internal_address_spec.0.ip_version - IP version of the internal addresses.
    externalAddressSpecs GetLbNetworkLoadBalancerListenerExternalAddressSpec[]
    internalAddressSpecs GetLbNetworkLoadBalancerListenerInternalAddressSpec[]
    name string
    • Name of the network load balancer.
    port number
    Port for incoming traffic.
    protocol string
    Protocol for incoming traffic.
    targetPort number
    Port of a target.

    • external_address_spec.0.address - External IP address of a listener.
    • external_address_spec.0.ip_version - IP version of the external addresses.
    • internal_address_spec.0.subnet_id - Subnet ID to which the internal IP address belongs
    • internal_address_spec.0.address - Internal IP address of a listener.
    • internal_address_spec.0.ip_version - IP version of the internal addresses.
    external_address_specs Sequence[GetLbNetworkLoadBalancerListenerExternalAddressSpec]
    internal_address_specs Sequence[GetLbNetworkLoadBalancerListenerInternalAddressSpec]
    name str
    • Name of the network load balancer.
    port int
    Port for incoming traffic.
    protocol str
    Protocol for incoming traffic.
    target_port int
    Port of a target.

    • external_address_spec.0.address - External IP address of a listener.
    • external_address_spec.0.ip_version - IP version of the external addresses.
    • internal_address_spec.0.subnet_id - Subnet ID to which the internal IP address belongs
    • internal_address_spec.0.address - Internal IP address of a listener.
    • internal_address_spec.0.ip_version - IP version of the internal addresses.
    externalAddressSpecs List<Property Map>
    internalAddressSpecs List<Property Map>
    name String
    • Name of the network load balancer.
    port Number
    Port for incoming traffic.
    protocol String
    Protocol for incoming traffic.
    targetPort Number
    Port of a target.

    • external_address_spec.0.address - External IP address of a listener.
    • external_address_spec.0.ip_version - IP version of the external addresses.
    • internal_address_spec.0.subnet_id - Subnet ID to which the internal IP address belongs
    • internal_address_spec.0.address - Internal IP address of a listener.
    • internal_address_spec.0.ip_version - IP version of the internal addresses.

    GetLbNetworkLoadBalancerListenerExternalAddressSpec

    Address string
    IpVersion string
    Address string
    IpVersion string
    address String
    ipVersion String
    address string
    ipVersion string
    address String
    ipVersion String

    GetLbNetworkLoadBalancerListenerInternalAddressSpec

    Address string
    IpVersion string
    SubnetId string
    Address string
    IpVersion string
    SubnetId string
    address String
    ipVersion String
    subnetId String
    address string
    ipVersion string
    subnetId string
    address String
    ipVersion String
    subnetId String

    Package Details

    Repository
    Yandex pulumi/pulumi-yandex
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the yandex Terraform Provider.
    yandex logo
    Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
    pulumi/pulumi-yandex