Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  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 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",
}));
Copy
import pulumi
import pulumi_yandex as yandex

foo = yandex.get_lb_network_load_balancer(network_load_balancer_id="my-network-load-balancer")
Copy
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",
        }));
    }

}
Copy
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
	})
}
Copy

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>
Copy
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]
Copy
func LookupLbNetworkLoadBalancer(ctx *Context, args *LookupLbNetworkLoadBalancerArgs, opts ...InvokeOption) (*LookupLbNetworkLoadBalancerResult, error)
func LookupLbNetworkLoadBalancerOutput(ctx *Context, args *LookupLbNetworkLoadBalancerOutputArgs, opts ...InvokeOption) LookupLbNetworkLoadBalancerResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetLbNetworkLoadBalancerResult> getLbNetworkLoadBalancer(GetLbNetworkLoadBalancerArgs args, InvokeOptions options)
public static Output<GetLbNetworkLoadBalancerResult> getLbNetworkLoadBalancer(GetLbNetworkLoadBalancerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: yandex:index/getLbNetworkLoadBalancer:getLbNetworkLoadBalancer
  arguments:
    # arguments dictionary
Copy

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 This property is required. List<GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck>
TargetGroupId This property is required. 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 This property is required. []GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck
TargetGroupId This property is required. 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 This property is required. List<GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck>
targetGroupId This property is required. 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 This property is required. GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck[]
targetGroupId This property is required. 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 This property is required. Sequence[GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheck]
target_group_id This property is required. 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 This property is required. List<Property Map>
targetGroupId This property is required. 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

HealthyThreshold This property is required. int
HttpOptions This property is required. List<GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOption>
Interval This property is required. int
Name This property is required. string
  • Name of the network load balancer.
TcpOptions This property is required. List<GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOption>
Timeout This property is required. int
UnhealthyThreshold This property is required. int
HealthyThreshold This property is required. int
HttpOptions This property is required. []GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOption
Interval This property is required. int
Name This property is required. string
  • Name of the network load balancer.
TcpOptions This property is required. []GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOption
Timeout This property is required. int
UnhealthyThreshold This property is required. int
healthyThreshold This property is required. Integer
httpOptions This property is required. List<GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOption>
interval This property is required. Integer
name This property is required. String
  • Name of the network load balancer.
tcpOptions This property is required. List<GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOption>
timeout This property is required. Integer
unhealthyThreshold This property is required. Integer
healthyThreshold This property is required. number
httpOptions This property is required. GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOption[]
interval This property is required. number
name This property is required. string
  • Name of the network load balancer.
tcpOptions This property is required. GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOption[]
timeout This property is required. number
unhealthyThreshold This property is required. number
healthy_threshold This property is required. int
http_options This property is required. Sequence[GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOption]
interval This property is required. int
name This property is required. str
  • Name of the network load balancer.
tcp_options This property is required. Sequence[GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOption]
timeout This property is required. int
unhealthy_threshold This property is required. int
healthyThreshold This property is required. Number
httpOptions This property is required. List<Property Map>
interval This property is required. Number
name This property is required. String
  • Name of the network load balancer.
tcpOptions This property is required. List<Property Map>
timeout This property is required. Number
unhealthyThreshold This property is required. Number

GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOption

Path This property is required. string
Port This property is required. int
Port for incoming traffic.
Path This property is required. string
Port This property is required. int
Port for incoming traffic.
path This property is required. String
port This property is required. Integer
Port for incoming traffic.
path This property is required. string
port This property is required. number
Port for incoming traffic.
path This property is required. str
port This property is required. int
Port for incoming traffic.
path This property is required. String
port This property is required. Number
Port for incoming traffic.

GetLbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOption

Port This property is required. int
Port for incoming traffic.
Port This property is required. int
Port for incoming traffic.
port This property is required. Integer
Port for incoming traffic.
port This property is required. number
Port for incoming traffic.
port This property is required. int
Port for incoming traffic.
port This property is required. Number
Port for incoming traffic.

GetLbNetworkLoadBalancerListener

ExternalAddressSpecs This property is required. List<GetLbNetworkLoadBalancerListenerExternalAddressSpec>
InternalAddressSpecs This property is required. List<GetLbNetworkLoadBalancerListenerInternalAddressSpec>
Name This property is required. string
  • Name of the network load balancer.
Port This property is required. int
Port for incoming traffic.
Protocol This property is required. string
Protocol for incoming traffic.
TargetPort This property is required. 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 This property is required. []GetLbNetworkLoadBalancerListenerExternalAddressSpec
InternalAddressSpecs This property is required. []GetLbNetworkLoadBalancerListenerInternalAddressSpec
Name This property is required. string
  • Name of the network load balancer.
Port This property is required. int
Port for incoming traffic.
Protocol This property is required. string
Protocol for incoming traffic.
TargetPort This property is required. 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 This property is required. List<GetLbNetworkLoadBalancerListenerExternalAddressSpec>
internalAddressSpecs This property is required. List<GetLbNetworkLoadBalancerListenerInternalAddressSpec>
name This property is required. String
  • Name of the network load balancer.
port This property is required. Integer
Port for incoming traffic.
protocol This property is required. String
Protocol for incoming traffic.
targetPort This property is required. 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 This property is required. GetLbNetworkLoadBalancerListenerExternalAddressSpec[]
internalAddressSpecs This property is required. GetLbNetworkLoadBalancerListenerInternalAddressSpec[]
name This property is required. string
  • Name of the network load balancer.
port This property is required. number
Port for incoming traffic.
protocol This property is required. string
Protocol for incoming traffic.
targetPort This property is required. 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 This property is required. Sequence[GetLbNetworkLoadBalancerListenerExternalAddressSpec]
internal_address_specs This property is required. Sequence[GetLbNetworkLoadBalancerListenerInternalAddressSpec]
name This property is required. str
  • Name of the network load balancer.
port This property is required. int
Port for incoming traffic.
protocol This property is required. str
Protocol for incoming traffic.
target_port This property is required. 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 This property is required. List<Property Map>
internalAddressSpecs This property is required. List<Property Map>
name This property is required. String
  • Name of the network load balancer.
port This property is required. Number
Port for incoming traffic.
protocol This property is required. String
Protocol for incoming traffic.
targetPort This property is required. 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 This property is required. string
IpVersion This property is required. string
Address This property is required. string
IpVersion This property is required. string
address This property is required. String
ipVersion This property is required. String
address This property is required. string
ipVersion This property is required. string
address This property is required. str
ip_version This property is required. str
address This property is required. String
ipVersion This property is required. String

GetLbNetworkLoadBalancerListenerInternalAddressSpec

Address This property is required. string
IpVersion This property is required. string
SubnetId This property is required. string
Address This property is required. string
IpVersion This property is required. string
SubnetId This property is required. string
address This property is required. String
ipVersion This property is required. String
subnetId This property is required. String
address This property is required. string
ipVersion This property is required. string
subnetId This property is required. string
address This property is required. str
ip_version This property is required. str
subnet_id This property is required. str
address This property is required. String
ipVersion This property is required. String
subnetId This property is required. String

Package Details

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