1. Packages
  2. Linode
  3. API Docs
  4. getNodeBalancer
Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi

linode.getNodeBalancer

Explore with Pulumi AI

linode logo
Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi

    Provides details about a Linode NodeBalancer.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const my-nodebalancer = linode.getNodeBalancer({
        id: 123,
    });
    
    import pulumi
    import pulumi_linode as linode
    
    my_nodebalancer = linode.get_node_balancer(id=123)
    
    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.LookupNodeBalancer(ctx, &linode.LookupNodeBalancerArgs{
    			Id: 123,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var my_nodebalancer = Linode.GetNodeBalancer.Invoke(new()
        {
            Id = 123,
        });
    
    });
    
    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.GetNodeBalancerArgs;
    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-nodebalancer = LinodeFunctions.getNodeBalancer(GetNodeBalancerArgs.builder()
                .id(123)
                .build());
    
        }
    }
    
    variables:
      my-nodebalancer:
        fn::invoke:
          Function: linode:getNodeBalancer
          Arguments:
            id: 123
    

    Using getNodeBalancer

    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 getNodeBalancer(args: GetNodeBalancerArgs, opts?: InvokeOptions): Promise<GetNodeBalancerResult>
    function getNodeBalancerOutput(args: GetNodeBalancerOutputArgs, opts?: InvokeOptions): Output<GetNodeBalancerResult>
    def get_node_balancer(firewalls: Optional[Sequence[GetNodeBalancerFirewall]] = None,
                          id: Optional[int] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNodeBalancerResult
    def get_node_balancer_output(firewalls: Optional[pulumi.Input[Sequence[pulumi.Input[GetNodeBalancerFirewallArgs]]]] = None,
                          id: Optional[pulumi.Input[int]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetNodeBalancerResult]
    func LookupNodeBalancer(ctx *Context, args *LookupNodeBalancerArgs, opts ...InvokeOption) (*LookupNodeBalancerResult, error)
    func LookupNodeBalancerOutput(ctx *Context, args *LookupNodeBalancerOutputArgs, opts ...InvokeOption) LookupNodeBalancerResultOutput

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

    public static class GetNodeBalancer 
    {
        public static Task<GetNodeBalancerResult> InvokeAsync(GetNodeBalancerArgs args, InvokeOptions? opts = null)
        public static Output<GetNodeBalancerResult> Invoke(GetNodeBalancerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNodeBalancerResult> getNodeBalancer(GetNodeBalancerArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: linode:index/getNodeBalancer:getNodeBalancer
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id int
    The NodeBalancer's ID.
    Firewalls List<GetNodeBalancerFirewall>
    Id int
    The NodeBalancer's ID.
    Firewalls []GetNodeBalancerFirewall
    id Integer
    The NodeBalancer's ID.
    firewalls List<GetNodeBalancerFirewall>
    id number
    The NodeBalancer's ID.
    firewalls GetNodeBalancerFirewall[]
    id Number
    The NodeBalancer's ID.
    firewalls List<Property Map>

    getNodeBalancer Result

    The following output properties are available:

    ClientConnThrottle int
    Throttle connections per second (0-20).
    Created string
    When this firewall was created.
    Hostname string
    This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
    Id int
    The Firewall's ID.
    Ipv4 string
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    Ipv6 string
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    Label string
    Used to identify this rule. For display purposes only.
    Region string
    The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
    Tags List<string>
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    Transfers List<GetNodeBalancerTransfer>
    Updated string
    When this firewall was last updated.
    Firewalls List<GetNodeBalancerFirewall>
    ClientConnThrottle int
    Throttle connections per second (0-20).
    Created string
    When this firewall was created.
    Hostname string
    This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
    Id int
    The Firewall's ID.
    Ipv4 string
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    Ipv6 string
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    Label string
    Used to identify this rule. For display purposes only.
    Region string
    The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
    Tags []string
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    Transfers []GetNodeBalancerTransfer
    Updated string
    When this firewall was last updated.
    Firewalls []GetNodeBalancerFirewall
    clientConnThrottle Integer
    Throttle connections per second (0-20).
    created String
    When this firewall was created.
    hostname String
    This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
    id Integer
    The Firewall's ID.
    ipv4 String
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6 String
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label String
    Used to identify this rule. For display purposes only.
    region String
    The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
    tags List<String>
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    transfers List<GetNodeBalancerTransfer>
    updated String
    When this firewall was last updated.
    firewalls List<GetNodeBalancerFirewall>
    clientConnThrottle number
    Throttle connections per second (0-20).
    created string
    When this firewall was created.
    hostname string
    This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
    id number
    The Firewall's ID.
    ipv4 string
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6 string
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label string
    Used to identify this rule. For display purposes only.
    region string
    The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
    tags string[]
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    transfers GetNodeBalancerTransfer[]
    updated string
    When this firewall was last updated.
    firewalls GetNodeBalancerFirewall[]
    client_conn_throttle int
    Throttle connections per second (0-20).
    created str
    When this firewall was created.
    hostname str
    This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
    id int
    The Firewall's ID.
    ipv4 str
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6 str
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label str
    Used to identify this rule. For display purposes only.
    region str
    The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
    tags Sequence[str]
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    transfers Sequence[GetNodeBalancerTransfer]
    updated str
    When this firewall was last updated.
    firewalls Sequence[GetNodeBalancerFirewall]
    clientConnThrottle Number
    Throttle connections per second (0-20).
    created String
    When this firewall was created.
    hostname String
    This NodeBalancer's hostname, ending with .ip.linodeusercontent.com
    id Number
    The Firewall's ID.
    ipv4 String
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6 String
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label String
    Used to identify this rule. For display purposes only.
    region String
    The Region where this Linode NodeBalancer is located. NodeBalancers only support backends in the same Region.
    tags List<String>
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    transfers List<Property Map>
    updated String
    When this firewall was last updated.
    firewalls List<Property Map>

    Supporting Types

    GetNodeBalancerFirewall

    Created string
    When this firewall was created.
    Id int
    The NodeBalancer's ID.
    InboundPolicy string
    The default behavior for inbound traffic. (ACCEPT, DROP)
    Label string
    Used to identify this rule. For display purposes only.
    OutboundPolicy string
    The default behavior for outbound traffic. (ACCEPT, DROP)
    Status string
    The status of the firewall. (enabled, disabled, deleted)
    Tags List<string>
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    Updated string
    When this firewall was last updated.
    Inbounds List<GetNodeBalancerFirewallInbound>
    A set of firewall rules that specify what inbound network traffic is allowed.
    Outbounds List<GetNodeBalancerFirewallOutbound>
    A set of firewall rules that specify what outbound network traffic is allowed.
    Created string
    When this firewall was created.
    Id int
    The NodeBalancer's ID.
    InboundPolicy string
    The default behavior for inbound traffic. (ACCEPT, DROP)
    Label string
    Used to identify this rule. For display purposes only.
    OutboundPolicy string
    The default behavior for outbound traffic. (ACCEPT, DROP)
    Status string
    The status of the firewall. (enabled, disabled, deleted)
    Tags []string
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    Updated string
    When this firewall was last updated.
    Inbounds []GetNodeBalancerFirewallInbound
    A set of firewall rules that specify what inbound network traffic is allowed.
    Outbounds []GetNodeBalancerFirewallOutbound
    A set of firewall rules that specify what outbound network traffic is allowed.
    created String
    When this firewall was created.
    id Integer
    The NodeBalancer's ID.
    inboundPolicy String
    The default behavior for inbound traffic. (ACCEPT, DROP)
    label String
    Used to identify this rule. For display purposes only.
    outboundPolicy String
    The default behavior for outbound traffic. (ACCEPT, DROP)
    status String
    The status of the firewall. (enabled, disabled, deleted)
    tags List<String>
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    updated String
    When this firewall was last updated.
    inbounds List<GetNodeBalancerFirewallInbound>
    A set of firewall rules that specify what inbound network traffic is allowed.
    outbounds List<GetNodeBalancerFirewallOutbound>
    A set of firewall rules that specify what outbound network traffic is allowed.
    created string
    When this firewall was created.
    id number
    The NodeBalancer's ID.
    inboundPolicy string
    The default behavior for inbound traffic. (ACCEPT, DROP)
    label string
    Used to identify this rule. For display purposes only.
    outboundPolicy string
    The default behavior for outbound traffic. (ACCEPT, DROP)
    status string
    The status of the firewall. (enabled, disabled, deleted)
    tags string[]
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    updated string
    When this firewall was last updated.
    inbounds GetNodeBalancerFirewallInbound[]
    A set of firewall rules that specify what inbound network traffic is allowed.
    outbounds GetNodeBalancerFirewallOutbound[]
    A set of firewall rules that specify what outbound network traffic is allowed.
    created str
    When this firewall was created.
    id int
    The NodeBalancer's ID.
    inbound_policy str
    The default behavior for inbound traffic. (ACCEPT, DROP)
    label str
    Used to identify this rule. For display purposes only.
    outbound_policy str
    The default behavior for outbound traffic. (ACCEPT, DROP)
    status str
    The status of the firewall. (enabled, disabled, deleted)
    tags Sequence[str]
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    updated str
    When this firewall was last updated.
    inbounds Sequence[GetNodeBalancerFirewallInbound]
    A set of firewall rules that specify what inbound network traffic is allowed.
    outbounds Sequence[GetNodeBalancerFirewallOutbound]
    A set of firewall rules that specify what outbound network traffic is allowed.
    created String
    When this firewall was created.
    id Number
    The NodeBalancer's ID.
    inboundPolicy String
    The default behavior for inbound traffic. (ACCEPT, DROP)
    label String
    Used to identify this rule. For display purposes only.
    outboundPolicy String
    The default behavior for outbound traffic. (ACCEPT, DROP)
    status String
    The status of the firewall. (enabled, disabled, deleted)
    tags List<String>
    The tags applied to the firewall. Tags are case-insensitive and are for organizational purposes only.
    updated String
    When this firewall was last updated.
    inbounds List<Property Map>
    A set of firewall rules that specify what inbound network traffic is allowed.
    outbounds List<Property Map>
    A set of firewall rules that specify what outbound network traffic is allowed.

    GetNodeBalancerFirewallInbound

    Action string
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    Ipv4s List<string>
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    Ipv6s List<string>
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    Label string
    Used to identify this rule. For display purposes only.
    Ports string
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    Protocol string
    The network protocol this rule controls. (TCP, UDP, ICMP)
    Action string
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    Ipv4s []string
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    Ipv6s []string
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    Label string
    Used to identify this rule. For display purposes only.
    Ports string
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    Protocol string
    The network protocol this rule controls. (TCP, UDP, ICMP)
    action String
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    ipv4s List<String>
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6s List<String>
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label String
    Used to identify this rule. For display purposes only.
    ports String
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    protocol String
    The network protocol this rule controls. (TCP, UDP, ICMP)
    action string
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    ipv4s string[]
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6s string[]
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label string
    Used to identify this rule. For display purposes only.
    ports string
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    protocol string
    The network protocol this rule controls. (TCP, UDP, ICMP)
    action str
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    ipv4s Sequence[str]
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6s Sequence[str]
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label str
    Used to identify this rule. For display purposes only.
    ports str
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    protocol str
    The network protocol this rule controls. (TCP, UDP, ICMP)
    action String
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    ipv4s List<String>
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6s List<String>
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label String
    Used to identify this rule. For display purposes only.
    ports String
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    protocol String
    The network protocol this rule controls. (TCP, UDP, ICMP)

    GetNodeBalancerFirewallOutbound

    Action string
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    Ipv4s List<string>
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    Ipv6s List<string>
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    Label string
    Used to identify this rule. For display purposes only.
    Ports string
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    Protocol string
    The network protocol this rule controls. (TCP, UDP, ICMP)
    Action string
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    Ipv4s []string
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    Ipv6s []string
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    Label string
    Used to identify this rule. For display purposes only.
    Ports string
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    Protocol string
    The network protocol this rule controls. (TCP, UDP, ICMP)
    action String
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    ipv4s List<String>
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6s List<String>
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label String
    Used to identify this rule. For display purposes only.
    ports String
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    protocol String
    The network protocol this rule controls. (TCP, UDP, ICMP)
    action string
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    ipv4s string[]
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6s string[]
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label string
    Used to identify this rule. For display purposes only.
    ports string
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    protocol string
    The network protocol this rule controls. (TCP, UDP, ICMP)
    action str
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    ipv4s Sequence[str]
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6s Sequence[str]
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label str
    Used to identify this rule. For display purposes only.
    ports str
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    protocol str
    The network protocol this rule controls. (TCP, UDP, ICMP)
    action String
    Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s inbound_policy if this is an inbound rule, or the outbound_policy if this is an outbound rule.
    ipv4s List<String>
    A list of IPv4 addresses or networks. Must be in IP/mask format.
    ipv6s List<String>
    A list of IPv6 addresses or networks. Must be in IP/mask format.
    label String
    Used to identify this rule. For display purposes only.
    ports String
    A string representation of ports and/or port ranges (i.e. "443" or "80-90, 91").
    protocol String
    The network protocol this rule controls. (TCP, UDP, ICMP)

    GetNodeBalancerTransfer

    In double
    The total transfer, in MB, used by this NodeBalancer for the current month
    Out double
    The total inbound transfer, in MB, used for this NodeBalancer for the current month
    Total double
    The total outbound transfer, in MB, used for this NodeBalancer for the current month
    In float64
    The total transfer, in MB, used by this NodeBalancer for the current month
    Out float64
    The total inbound transfer, in MB, used for this NodeBalancer for the current month
    Total float64
    The total outbound transfer, in MB, used for this NodeBalancer for the current month
    in Double
    The total transfer, in MB, used by this NodeBalancer for the current month
    out Double
    The total inbound transfer, in MB, used for this NodeBalancer for the current month
    total Double
    The total outbound transfer, in MB, used for this NodeBalancer for the current month
    in number
    The total transfer, in MB, used by this NodeBalancer for the current month
    out number
    The total inbound transfer, in MB, used for this NodeBalancer for the current month
    total number
    The total outbound transfer, in MB, used for this NodeBalancer for the current month
    in_ float
    The total transfer, in MB, used by this NodeBalancer for the current month
    out float
    The total inbound transfer, in MB, used for this NodeBalancer for the current month
    total float
    The total outbound transfer, in MB, used for this NodeBalancer for the current month
    in Number
    The total transfer, in MB, used by this NodeBalancer for the current month
    out Number
    The total inbound transfer, in MB, used for this NodeBalancer for the current month
    total Number
    The total outbound transfer, in MB, used for this NodeBalancer for the current month

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi