Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Linode Provider
  3. API Docs
  4. getNodeBalancerNode
Linode v4.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-linode

linode.getNodeBalancerNode

Explore with Pulumi AI

Linode v4.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-linode

Provides details about a Linode NodeBalancer node. For more information, see the Linode APIv4 docs.

Example Usage

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

const my_node = linode.getNodeBalancerNode({
    id: 123,
    nodebalancerId: 456,
    configId: 789,
});
Copy
import pulumi
import pulumi_linode as linode

my_node = linode.get_node_balancer_node(id=123,
    nodebalancer_id=456,
    config_id=789)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := linode.LookupNodeBalancerNode(ctx, &linode.LookupNodeBalancerNodeArgs{
			Id:             123,
			NodebalancerId: 456,
			ConfigId:       789,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var my_node = Linode.GetNodeBalancerNode.Invoke(new()
    {
        Id = 123,
        NodebalancerId = 456,
        ConfigId = 789,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetNodeBalancerNodeArgs;
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 my-node = LinodeFunctions.getNodeBalancerNode(GetNodeBalancerNodeArgs.builder()
            .id(123)
            .nodebalancerId(456)
            .configId(789)
            .build());

    }
}
Copy
variables:
  my-node:
    fn::invoke:
      function: linode:getNodeBalancerNode
      arguments:
        id: 123
        nodebalancerId: 456
        configId: 789
Copy

Using getNodeBalancerNode

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 getNodeBalancerNode(args: GetNodeBalancerNodeArgs, opts?: InvokeOptions): Promise<GetNodeBalancerNodeResult>
function getNodeBalancerNodeOutput(args: GetNodeBalancerNodeOutputArgs, opts?: InvokeOptions): Output<GetNodeBalancerNodeResult>
Copy
def get_node_balancer_node(config_id: Optional[int] = None,
                           id: Optional[int] = None,
                           nodebalancer_id: Optional[int] = None,
                           opts: Optional[InvokeOptions] = None) -> GetNodeBalancerNodeResult
def get_node_balancer_node_output(config_id: Optional[pulumi.Input[int]] = None,
                           id: Optional[pulumi.Input[int]] = None,
                           nodebalancer_id: Optional[pulumi.Input[int]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetNodeBalancerNodeResult]
Copy
func LookupNodeBalancerNode(ctx *Context, args *LookupNodeBalancerNodeArgs, opts ...InvokeOption) (*LookupNodeBalancerNodeResult, error)
func LookupNodeBalancerNodeOutput(ctx *Context, args *LookupNodeBalancerNodeOutputArgs, opts ...InvokeOption) LookupNodeBalancerNodeResultOutput
Copy

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

public static class GetNodeBalancerNode 
{
    public static Task<GetNodeBalancerNodeResult> InvokeAsync(GetNodeBalancerNodeArgs args, InvokeOptions? opts = null)
    public static Output<GetNodeBalancerNodeResult> Invoke(GetNodeBalancerNodeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNodeBalancerNodeResult> getNodeBalancerNode(GetNodeBalancerNodeArgs args, InvokeOptions options)
public static Output<GetNodeBalancerNodeResult> getNodeBalancerNode(GetNodeBalancerNodeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: linode:index/getNodeBalancerNode:getNodeBalancerNode
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConfigId This property is required. int
The ID of the config that contains the Node.
Id This property is required. int
The node's ID.
NodebalancerId This property is required. int
The ID of the NodeBalancer that contains the node.
ConfigId This property is required. int
The ID of the config that contains the Node.
Id This property is required. int
The node's ID.
NodebalancerId This property is required. int
The ID of the NodeBalancer that contains the node.
configId This property is required. Integer
The ID of the config that contains the Node.
id This property is required. Integer
The node's ID.
nodebalancerId This property is required. Integer
The ID of the NodeBalancer that contains the node.
configId This property is required. number
The ID of the config that contains the Node.
id This property is required. number
The node's ID.
nodebalancerId This property is required. number
The ID of the NodeBalancer that contains the node.
config_id This property is required. int
The ID of the config that contains the Node.
id This property is required. int
The node's ID.
nodebalancer_id This property is required. int
The ID of the NodeBalancer that contains the node.
configId This property is required. Number
The ID of the config that contains the Node.
id This property is required. Number
The node's ID.
nodebalancerId This property is required. Number
The ID of the NodeBalancer that contains the node.

getNodeBalancerNode Result

The following output properties are available:

Address string
The private IP Address where this backend can be reached.
ConfigId int
Id int
Label string
The label of the Linode NodeBalancer Node. This is for display purposes only.
Mode string
The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
NodebalancerId int
Status string
The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
Weight int
Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
Address string
The private IP Address where this backend can be reached.
ConfigId int
Id int
Label string
The label of the Linode NodeBalancer Node. This is for display purposes only.
Mode string
The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
NodebalancerId int
Status string
The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
Weight int
Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
address String
The private IP Address where this backend can be reached.
configId Integer
id Integer
label String
The label of the Linode NodeBalancer Node. This is for display purposes only.
mode String
The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
nodebalancerId Integer
status String
The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
weight Integer
Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
address string
The private IP Address where this backend can be reached.
configId number
id number
label string
The label of the Linode NodeBalancer Node. This is for display purposes only.
mode string
The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
nodebalancerId number
status string
The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
weight number
Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
address str
The private IP Address where this backend can be reached.
config_id int
id int
label str
The label of the Linode NodeBalancer Node. This is for display purposes only.
mode str
The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
nodebalancer_id int
status str
The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
weight int
Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
address String
The private IP Address where this backend can be reached.
configId Number
id Number
label String
The label of the Linode NodeBalancer Node. This is for display purposes only.
mode String
The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (accept, reject, drain, backup)
nodebalancerId Number
status String
The current status of this node, based on the configured checks of its NodeBalancer Config. (unknown, UP, DOWN).
weight Number
Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).

Package Details

Repository
Linode pulumi/pulumi-linode
License
Apache-2.0
Notes
This Pulumi package is based on the linode Terraform Provider.
Linode v4.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-linode