Linode

Pulumi Official
Package maintained by Pulumi
v3.10.0 published on Tuesday, Aug 16, 2022 by Pulumi

getNodeBalancerConfig

Provides details about a Linode NodeBalancer Config.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var my_config = Linode.GetNodeBalancerConfig.Invoke(new()
    {
        Id = 123,
        NodebalancerId = 456,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := linode.LookupNodeBalancerConfig(ctx, &GetNodeBalancerConfigArgs{
			Id:             123,
			NodebalancerId: 456,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
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.GetNodeBalancerConfigArgs;
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-config = LinodeFunctions.getNodeBalancerConfig(GetNodeBalancerConfigArgs.builder()
            .id(123)
            .nodebalancerId(456)
            .build());

    }
}
import pulumi
import pulumi_linode as linode

my_config = linode.get_node_balancer_config(id=123,
    nodebalancer_id=456)
import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

const my_config = pulumi.output(linode.getNodeBalancerConfig({
    id: 123,
    nodebalancerId: 456,
}));
variables:
  my-config:
    Fn::Invoke:
      Function: linode:getNodeBalancerConfig
      Arguments:
        id: 123
        nodebalancerId: 456

Using getNodeBalancerConfig

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 getNodeBalancerConfig(args: GetNodeBalancerConfigArgs, opts?: InvokeOptions): Promise<GetNodeBalancerConfigResult>
function getNodeBalancerConfigOutput(args: GetNodeBalancerConfigOutputArgs, opts?: InvokeOptions): Output<GetNodeBalancerConfigResult>
def get_node_balancer_config(id: Optional[int] = None,
                             nodebalancer_id: Optional[int] = None,
                             opts: Optional[InvokeOptions] = None) -> GetNodeBalancerConfigResult
def get_node_balancer_config_output(id: Optional[pulumi.Input[int]] = None,
                             nodebalancer_id: Optional[pulumi.Input[int]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetNodeBalancerConfigResult]
func LookupNodeBalancerConfig(ctx *Context, args *LookupNodeBalancerConfigArgs, opts ...InvokeOption) (*LookupNodeBalancerConfigResult, error)
func LookupNodeBalancerConfigOutput(ctx *Context, args *LookupNodeBalancerConfigOutputArgs, opts ...InvokeOption) LookupNodeBalancerConfigResultOutput

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

public static class GetNodeBalancerConfig 
{
    public static Task<GetNodeBalancerConfigResult> InvokeAsync(GetNodeBalancerConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetNodeBalancerConfigResult> Invoke(GetNodeBalancerConfigInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNodeBalancerConfigResult> getNodeBalancerConfig(GetNodeBalancerConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: linode:index/getNodeBalancerConfig:getNodeBalancerConfig
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Id int

The config's ID.

NodebalancerId int

The ID of the NodeBalancer that contains the config.

Id int

The config's ID.

NodebalancerId int

The ID of the NodeBalancer that contains the config.

id Integer

The config's ID.

nodebalancerId Integer

The ID of the NodeBalancer that contains the config.

id number

The config's ID.

nodebalancerId number

The ID of the NodeBalancer that contains the config.

id int

The config's ID.

nodebalancer_id int

The ID of the NodeBalancer that contains the config.

id Number

The config's ID.

nodebalancerId Number

The ID of the NodeBalancer that contains the config.

getNodeBalancerConfig Result

The following output properties are available:

Algorithm string

What algorithm this NodeBalancer should use for routing traffic to backends (roundrobin, leastconn, source)

Check string

The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected. (none, connection, http, http_body)

CheckAttempts int

How many times to attempt a check before considering a backend to be down. (1-30)

CheckBody string
CheckInterval int

How often, in seconds, to check that backends are up and serving requests.

CheckPassive bool

If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.

CheckPath string

The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.

CheckTimeout int

How long, in seconds, to wait for a check attempt before considering it failed. (1-30)

CipherSuite string

What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary. (recommended, legacy)

Id int
NodeStatuses List<GetNodeBalancerConfigNodeStatus>
NodebalancerId int
Port int

The TCP port this Config is for.

Protocol string

The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key. (http, https, tcp) (Defaults to http)

ProxyProtocol string

The version of ProxyProtocol to use for the underlying NodeBalancer. This requires protocol to be tcp. (none, v1, and v2) (Defaults to none)

SslCommonname string

The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

SslFingerprint string

The read-only fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

Stickiness string

Controls how session stickiness is handled on this port. (none, table, http_cookie)

Algorithm string

What algorithm this NodeBalancer should use for routing traffic to backends (roundrobin, leastconn, source)

Check string

The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected. (none, connection, http, http_body)

CheckAttempts int

How many times to attempt a check before considering a backend to be down. (1-30)

CheckBody string
CheckInterval int

How often, in seconds, to check that backends are up and serving requests.

CheckPassive bool

If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.

CheckPath string

The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.

CheckTimeout int

How long, in seconds, to wait for a check attempt before considering it failed. (1-30)

CipherSuite string

What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary. (recommended, legacy)

Id int
NodeStatuses []GetNodeBalancerConfigNodeStatus
NodebalancerId int
Port int

The TCP port this Config is for.

Protocol string

The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key. (http, https, tcp) (Defaults to http)

ProxyProtocol string

The version of ProxyProtocol to use for the underlying NodeBalancer. This requires protocol to be tcp. (none, v1, and v2) (Defaults to none)

SslCommonname string

The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

SslFingerprint string

The read-only fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

Stickiness string

Controls how session stickiness is handled on this port. (none, table, http_cookie)

algorithm String

What algorithm this NodeBalancer should use for routing traffic to backends (roundrobin, leastconn, source)

check String

The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected. (none, connection, http, http_body)

checkAttempts Integer

How many times to attempt a check before considering a backend to be down. (1-30)

checkBody String
checkInterval Integer

How often, in seconds, to check that backends are up and serving requests.

checkPassive Boolean

If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.

checkPath String

The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.

checkTimeout Integer

How long, in seconds, to wait for a check attempt before considering it failed. (1-30)

cipherSuite String

What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary. (recommended, legacy)

id Integer
nodeStatuses List<GetNodeBalancerConfigNodeStatus>
nodebalancerId Integer
port Integer

The TCP port this Config is for.

protocol String

The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key. (http, https, tcp) (Defaults to http)

proxyProtocol String

The version of ProxyProtocol to use for the underlying NodeBalancer. This requires protocol to be tcp. (none, v1, and v2) (Defaults to none)

sslCommonname String

The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

sslFingerprint String

The read-only fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

stickiness String

Controls how session stickiness is handled on this port. (none, table, http_cookie)

algorithm string

What algorithm this NodeBalancer should use for routing traffic to backends (roundrobin, leastconn, source)

check string

The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected. (none, connection, http, http_body)

checkAttempts number

How many times to attempt a check before considering a backend to be down. (1-30)

checkBody string
checkInterval number

How often, in seconds, to check that backends are up and serving requests.

checkPassive boolean

If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.

checkPath string

The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.

checkTimeout number

How long, in seconds, to wait for a check attempt before considering it failed. (1-30)

cipherSuite string

What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary. (recommended, legacy)

id number
nodeStatuses GetNodeBalancerConfigNodeStatus[]
nodebalancerId number
port number

The TCP port this Config is for.

protocol string

The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key. (http, https, tcp) (Defaults to http)

proxyProtocol string

The version of ProxyProtocol to use for the underlying NodeBalancer. This requires protocol to be tcp. (none, v1, and v2) (Defaults to none)

sslCommonname string

The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

sslFingerprint string

The read-only fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

stickiness string

Controls how session stickiness is handled on this port. (none, table, http_cookie)

algorithm str

What algorithm this NodeBalancer should use for routing traffic to backends (roundrobin, leastconn, source)

check str

The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected. (none, connection, http, http_body)

check_attempts int

How many times to attempt a check before considering a backend to be down. (1-30)

check_body str
check_interval int

How often, in seconds, to check that backends are up and serving requests.

check_passive bool

If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.

check_path str

The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.

check_timeout int

How long, in seconds, to wait for a check attempt before considering it failed. (1-30)

cipher_suite str

What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary. (recommended, legacy)

id int
node_statuses Sequence[GetNodeBalancerConfigNodeStatus]
nodebalancer_id int
port int

The TCP port this Config is for.

protocol str

The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key. (http, https, tcp) (Defaults to http)

proxy_protocol str

The version of ProxyProtocol to use for the underlying NodeBalancer. This requires protocol to be tcp. (none, v1, and v2) (Defaults to none)

ssl_commonname str

The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

ssl_fingerprint str

The read-only fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

stickiness str

Controls how session stickiness is handled on this port. (none, table, http_cookie)

algorithm String

What algorithm this NodeBalancer should use for routing traffic to backends (roundrobin, leastconn, source)

check String

The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected. (none, connection, http, http_body)

checkAttempts Number

How many times to attempt a check before considering a backend to be down. (1-30)

checkBody String
checkInterval Number

How often, in seconds, to check that backends are up and serving requests.

checkPassive Boolean

If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.

checkPath String

The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.

checkTimeout Number

How long, in seconds, to wait for a check attempt before considering it failed. (1-30)

cipherSuite String

What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary. (recommended, legacy)

id Number
nodeStatuses List<Property Map>
nodebalancerId Number
port Number

The TCP port this Config is for.

protocol String

The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key. (http, https, tcp) (Defaults to http)

proxyProtocol String

The version of ProxyProtocol to use for the underlying NodeBalancer. This requires protocol to be tcp. (none, v1, and v2) (Defaults to none)

sslCommonname String

The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

sslFingerprint String

The read-only fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.

stickiness String

Controls how session stickiness is handled on this port. (none, table, http_cookie)

Supporting Types

GetNodeBalancerConfigNodeStatus

Down int

The number of backends considered to be 'DOWN' and unhealthy. These are not in rotation, and not serving requests.

Up int

The number of backends considered to be 'UP' and healthy, and that are serving requests.

Down int

The number of backends considered to be 'DOWN' and unhealthy. These are not in rotation, and not serving requests.

Up int

The number of backends considered to be 'UP' and healthy, and that are serving requests.

down Integer

The number of backends considered to be 'DOWN' and unhealthy. These are not in rotation, and not serving requests.

up Integer

The number of backends considered to be 'UP' and healthy, and that are serving requests.

down number

The number of backends considered to be 'DOWN' and unhealthy. These are not in rotation, and not serving requests.

up number

The number of backends considered to be 'UP' and healthy, and that are serving requests.

down int

The number of backends considered to be 'DOWN' and unhealthy. These are not in rotation, and not serving requests.

up int

The number of backends considered to be 'UP' and healthy, and that are serving requests.

down Number

The number of backends considered to be 'DOWN' and unhealthy. These are not in rotation, and not serving requests.

up Number

The number of backends considered to be 'UP' and healthy, and that are serving requests.

Package Details

Repository
https://github.com/pulumi/pulumi-linode
License
Apache-2.0
Notes

This Pulumi package is based on the linode Terraform Provider.