Docs Packages
  1. Packages
  2. Scaleway
  3. API Docs
  4. getLbBackends
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.getLbBackends

Explore with Pulumi AI

scaleway logo
Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-scaleway

    Gets information about multiple Load Balancer Backends.

    Example Usage

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

const byLBID = scaleway.getLbBackends({
    lbId: scaleway_lb.lb01.id,
});
const byLBIDAndName = scaleway.getLbBackends({
    lbId: scaleway_lb.lb01.id,
    name: "tf-backend-datasource",
});

    import pulumi
import pulumi_scaleway as scaleway

by_lbid = scaleway.get_lb_backends(lb_id=scaleway_lb["lb01"]["id"])
by_lbid_and_name = scaleway.get_lb_backends(lb_id=scaleway_lb["lb01"]["id"],
    name="tf-backend-datasource")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scaleway.GetLbBackends(ctx, &scaleway.GetLbBackendsArgs{
			LbId: scaleway_lb.Lb01.Id,
		}, nil)
		if err != nil {
			return err
		}
		_, err = scaleway.GetLbBackends(ctx, &scaleway.GetLbBackendsArgs{
			LbId: scaleway_lb.Lb01.Id,
			Name: pulumi.StringRef("tf-backend-datasource"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;

return await Deployment.RunAsync(() => 
{
    var byLBID = Scaleway.GetLbBackends.Invoke(new()
    {
        LbId = scaleway_lb.Lb01.Id,
    });

    var byLBIDAndName = Scaleway.GetLbBackends.Invoke(new()
    {
        LbId = scaleway_lb.Lb01.Id,
        Name = "tf-backend-datasource",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.ScalewayFunctions;
import com.pulumi.scaleway.inputs.GetLbBackendsArgs;
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 byLBID = ScalewayFunctions.getLbBackends(GetLbBackendsArgs.builder()
            .lbId(scaleway_lb.lb01().id())
            .build());

        final var byLBIDAndName = ScalewayFunctions.getLbBackends(GetLbBackendsArgs.builder()
            .lbId(scaleway_lb.lb01().id())
            .name("tf-backend-datasource")
            .build());

    }
}

    variables:
  byLBID:
    fn::invoke:
      Function: scaleway:getLbBackends
      Arguments:
        lbId: ${scaleway_lb.lb01.id}
  byLBIDAndName:
    fn::invoke:
      Function: scaleway:getLbBackends
      Arguments:
        lbId: ${scaleway_lb.lb01.id}
        name: tf-backend-datasource

    Using getLbBackends

    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 getLbBackends(args: GetLbBackendsArgs, opts?: InvokeOptions): Promise<GetLbBackendsResult>
function getLbBackendsOutput(args: GetLbBackendsOutputArgs, opts?: InvokeOptions): Output<GetLbBackendsResult>
    def get_lb_backends(lb_id: Optional[str] = None,
                    name: Optional[str] = None,
                    project_id: Optional[str] = None,
                    zone: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetLbBackendsResult
def get_lb_backends_output(lb_id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    project_id: Optional[pulumi.Input[str]] = None,
                    zone: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetLbBackendsResult]
    func GetLbBackends(ctx *Context, args *GetLbBackendsArgs, opts ...InvokeOption) (*GetLbBackendsResult, error)
func GetLbBackendsOutput(ctx *Context, args *GetLbBackendsOutputArgs, opts ...InvokeOption) GetLbBackendsResultOutput

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

    public static class GetLbBackends 
{
    public static Task<GetLbBackendsResult> InvokeAsync(GetLbBackendsArgs args, InvokeOptions? opts = null)
    public static Output<GetLbBackendsResult> Invoke(GetLbBackendsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLbBackendsResult> getLbBackends(GetLbBackendsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: scaleway:index/getLbBackends:getLbBackends
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LbId string
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    Name string
    The backend name used as filter. Backends with a name like it are listed.
    ProjectId string
    Zone string
    zone) The zone in which backends exist.
    LbId string
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    Name string
    The backend name used as filter. Backends with a name like it are listed.
    ProjectId string
    Zone string
    zone) The zone in which backends exist.
    lbId String
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    name String
    The backend name used as filter. Backends with a name like it are listed.
    projectId String
    zone String
    zone) The zone in which backends exist.
    lbId string
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    name string
    The backend name used as filter. Backends with a name like it are listed.
    projectId string
    zone string
    zone) The zone in which backends exist.
    lb_id str
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    name str
    The backend name used as filter. Backends with a name like it are listed.
    project_id str
    zone str
    zone) The zone in which backends exist.
    lbId String
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    name String
    The backend name used as filter. Backends with a name like it are listed.
    projectId String
    zone String
    zone) The zone in which backends exist.

    getLbBackends Result

    The following output properties are available:

    Backends List<Pulumiverse.Scaleway.Outputs.GetLbBackendsBackend>
    List of found backends
    Id string
    The provider-assigned unique ID for this managed resource.
    LbId string
    OrganizationId string
    ProjectId string
    Zone string
    Name string
    Backends []GetLbBackendsBackend
    List of found backends
    Id string
    The provider-assigned unique ID for this managed resource.
    LbId string
    OrganizationId string
    ProjectId string
    Zone string
    Name string
    backends List<GetLbBackendsBackend>
    List of found backends
    id String
    The provider-assigned unique ID for this managed resource.
    lbId String
    organizationId String
    projectId String
    zone String
    name String
    backends GetLbBackendsBackend[]
    List of found backends
    id string
    The provider-assigned unique ID for this managed resource.
    lbId string
    organizationId string
    projectId string
    zone string
    name string
    backends Sequence[GetLbBackendsBackend]
    List of found backends
    id str
    The provider-assigned unique ID for this managed resource.
    lb_id str
    organization_id str
    project_id str
    zone str
    name str
    backends List<Property Map>
    List of found backends
    id String
    The provider-assigned unique ID for this managed resource.
    lbId String
    organizationId String
    projectId String
    zone String
    name String

    Supporting Types

    GetLbBackendsBackend

    CreatedAt string
    The date at which the backend was created (RFC 3339 format).
    FailoverHost string
    Scaleway S3 bucket website to be served in case all backend servers are down.
    ForwardPort int
    User sessions will be forwarded to this port of backend servers.
    ForwardPortAlgorithm string
    Load balancing algorithm.
    ForwardProtocol string
    Backend protocol.
    HealthCheckDelay string
    Interval between two HC requests.
    HealthCheckHttp List<Pulumiverse.Scaleway.Inputs.GetLbBackendsBackendHealthCheckHttp>
    This block enable HTTP health check.
    HealthCheckHttps List<Pulumiverse.Scaleway.Inputs.GetLbBackendsBackendHealthCheckHttp>
    This block enable HTTPS health check.
    HealthCheckMaxRetries int
    Number of allowed failed HC requests before the backend server is marked down.
    HealthCheckPort int
    Port the HC requests will be sent to.
    HealthCheckTcps List<Pulumiverse.Scaleway.Inputs.GetLbBackendsBackendHealthCheckTcp>
    This block enable TCP health check.
    HealthCheckTimeout string
    Timeout before we consider a HC request failed.
    Id string
    The associated backend ID.
    IgnoreSslServerVerify bool
    Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
    LbId string
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    Name string
    The backend name used as filter. Backends with a name like it are listed.
    OnMarkedDownAction string
    Modify what occurs when a backend server is marked down.
    ProxyProtocol string
    The type of PROXY protocol.
    ServerIps List<string>
    List of backend server IP addresses.
    SslBridging bool
    Enables SSL between load balancer and backend servers.
    StickySessions string
    Enables cookie-based session persistence.
    StickySessionsCookieName string
    Cookie name for sticky sessions.
    TimeoutConnect string
    Maximum initial server connection establishment time.
    TimeoutServer string
    Maximum server connection inactivity time.
    TimeoutTunnel string
    Maximum tunnel inactivity time.
    UpdateAt string
    The date at which the backend was last updated (RFC 3339 format).
    CreatedAt string
    The date at which the backend was created (RFC 3339 format).
    FailoverHost string
    Scaleway S3 bucket website to be served in case all backend servers are down.
    ForwardPort int
    User sessions will be forwarded to this port of backend servers.
    ForwardPortAlgorithm string
    Load balancing algorithm.
    ForwardProtocol string
    Backend protocol.
    HealthCheckDelay string
    Interval between two HC requests.
    HealthCheckHttp []GetLbBackendsBackendHealthCheckHttp
    This block enable HTTP health check.
    HealthCheckHttps []GetLbBackendsBackendHealthCheckHttp
    This block enable HTTPS health check.
    HealthCheckMaxRetries int
    Number of allowed failed HC requests before the backend server is marked down.
    HealthCheckPort int
    Port the HC requests will be sent to.
    HealthCheckTcps []GetLbBackendsBackendHealthCheckTcp
    This block enable TCP health check.
    HealthCheckTimeout string
    Timeout before we consider a HC request failed.
    Id string
    The associated backend ID.
    IgnoreSslServerVerify bool
    Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
    LbId string
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    Name string
    The backend name used as filter. Backends with a name like it are listed.
    OnMarkedDownAction string
    Modify what occurs when a backend server is marked down.
    ProxyProtocol string
    The type of PROXY protocol.
    ServerIps []string
    List of backend server IP addresses.
    SslBridging bool
    Enables SSL between load balancer and backend servers.
    StickySessions string
    Enables cookie-based session persistence.
    StickySessionsCookieName string
    Cookie name for sticky sessions.
    TimeoutConnect string
    Maximum initial server connection establishment time.
    TimeoutServer string
    Maximum server connection inactivity time.
    TimeoutTunnel string
    Maximum tunnel inactivity time.
    UpdateAt string
    The date at which the backend was last updated (RFC 3339 format).
    createdAt String
    The date at which the backend was created (RFC 3339 format).
    failoverHost String
    Scaleway S3 bucket website to be served in case all backend servers are down.
    forwardPort Integer
    User sessions will be forwarded to this port of backend servers.
    forwardPortAlgorithm String
    Load balancing algorithm.
    forwardProtocol String
    Backend protocol.
    healthCheckDelay String
    Interval between two HC requests.
    healthCheckHttp List<GetLbBackendsBackendHealthCheckHttp>
    This block enable HTTP health check.
    healthCheckHttps List<GetLbBackendsBackendHealthCheckHttp>
    This block enable HTTPS health check.
    healthCheckMaxRetries Integer
    Number of allowed failed HC requests before the backend server is marked down.
    healthCheckPort Integer
    Port the HC requests will be sent to.
    healthCheckTcps List<GetLbBackendsBackendHealthCheckTcp>
    This block enable TCP health check.
    healthCheckTimeout String
    Timeout before we consider a HC request failed.
    id String
    The associated backend ID.
    ignoreSslServerVerify Boolean
    Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
    lbId String
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    name String
    The backend name used as filter. Backends with a name like it are listed.
    onMarkedDownAction String
    Modify what occurs when a backend server is marked down.
    proxyProtocol String
    The type of PROXY protocol.
    serverIps List<String>
    List of backend server IP addresses.
    sslBridging Boolean
    Enables SSL between load balancer and backend servers.
    stickySessions String
    Enables cookie-based session persistence.
    stickySessionsCookieName String
    Cookie name for sticky sessions.
    timeoutConnect String
    Maximum initial server connection establishment time.
    timeoutServer String
    Maximum server connection inactivity time.
    timeoutTunnel String
    Maximum tunnel inactivity time.
    updateAt String
    The date at which the backend was last updated (RFC 3339 format).
    createdAt string
    The date at which the backend was created (RFC 3339 format).
    failoverHost string
    Scaleway S3 bucket website to be served in case all backend servers are down.
    forwardPort number
    User sessions will be forwarded to this port of backend servers.
    forwardPortAlgorithm string
    Load balancing algorithm.
    forwardProtocol string
    Backend protocol.
    healthCheckDelay string
    Interval between two HC requests.
    healthCheckHttp GetLbBackendsBackendHealthCheckHttp[]
    This block enable HTTP health check.
    healthCheckHttps GetLbBackendsBackendHealthCheckHttp[]
    This block enable HTTPS health check.
    healthCheckMaxRetries number
    Number of allowed failed HC requests before the backend server is marked down.
    healthCheckPort number
    Port the HC requests will be sent to.
    healthCheckTcps GetLbBackendsBackendHealthCheckTcp[]
    This block enable TCP health check.
    healthCheckTimeout string
    Timeout before we consider a HC request failed.
    id string
    The associated backend ID.
    ignoreSslServerVerify boolean
    Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
    lbId string
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    name string
    The backend name used as filter. Backends with a name like it are listed.
    onMarkedDownAction string
    Modify what occurs when a backend server is marked down.
    proxyProtocol string
    The type of PROXY protocol.
    serverIps string[]
    List of backend server IP addresses.
    sslBridging boolean
    Enables SSL between load balancer and backend servers.
    stickySessions string
    Enables cookie-based session persistence.
    stickySessionsCookieName string
    Cookie name for sticky sessions.
    timeoutConnect string
    Maximum initial server connection establishment time.
    timeoutServer string
    Maximum server connection inactivity time.
    timeoutTunnel string
    Maximum tunnel inactivity time.
    updateAt string
    The date at which the backend was last updated (RFC 3339 format).
    created_at str
    The date at which the backend was created (RFC 3339 format).
    failover_host str
    Scaleway S3 bucket website to be served in case all backend servers are down.
    forward_port int
    User sessions will be forwarded to this port of backend servers.
    forward_port_algorithm str
    Load balancing algorithm.
    forward_protocol str
    Backend protocol.
    health_check_delay str
    Interval between two HC requests.
    health_check_http Sequence[GetLbBackendsBackendHealthCheckHttp]
    This block enable HTTP health check.
    health_check_https Sequence[GetLbBackendsBackendHealthCheckHttp]
    This block enable HTTPS health check.
    health_check_max_retries int
    Number of allowed failed HC requests before the backend server is marked down.
    health_check_port int
    Port the HC requests will be sent to.
    health_check_tcps Sequence[GetLbBackendsBackendHealthCheckTcp]
    This block enable TCP health check.
    health_check_timeout str
    Timeout before we consider a HC request failed.
    id str
    The associated backend ID.
    ignore_ssl_server_verify bool
    Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
    lb_id str
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    name str
    The backend name used as filter. Backends with a name like it are listed.
    on_marked_down_action str
    Modify what occurs when a backend server is marked down.
    proxy_protocol str
    The type of PROXY protocol.
    server_ips Sequence[str]
    List of backend server IP addresses.
    ssl_bridging bool
    Enables SSL between load balancer and backend servers.
    sticky_sessions str
    Enables cookie-based session persistence.
    sticky_sessions_cookie_name str
    Cookie name for sticky sessions.
    timeout_connect str
    Maximum initial server connection establishment time.
    timeout_server str
    Maximum server connection inactivity time.
    timeout_tunnel str
    Maximum tunnel inactivity time.
    update_at str
    The date at which the backend was last updated (RFC 3339 format).
    createdAt String
    The date at which the backend was created (RFC 3339 format).
    failoverHost String
    Scaleway S3 bucket website to be served in case all backend servers are down.
    forwardPort Number
    User sessions will be forwarded to this port of backend servers.
    forwardPortAlgorithm String
    Load balancing algorithm.
    forwardProtocol String
    Backend protocol.
    healthCheckDelay String
    Interval between two HC requests.
    healthCheckHttp List<Property Map>
    This block enable HTTP health check.
    healthCheckHttps List<Property Map>
    This block enable HTTPS health check.
    healthCheckMaxRetries Number
    Number of allowed failed HC requests before the backend server is marked down.
    healthCheckPort Number
    Port the HC requests will be sent to.
    healthCheckTcps List<Property Map>
    This block enable TCP health check.
    healthCheckTimeout String
    Timeout before we consider a HC request failed.
    id String
    The associated backend ID.
    ignoreSslServerVerify Boolean
    Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
    lbId String
    The load-balancer ID this backend is attached to. backends with a LB ID like it are listed.
    name String
    The backend name used as filter. Backends with a name like it are listed.
    onMarkedDownAction String
    Modify what occurs when a backend server is marked down.
    proxyProtocol String
    The type of PROXY protocol.
    serverIps List<String>
    List of backend server IP addresses.
    sslBridging Boolean
    Enables SSL between load balancer and backend servers.
    stickySessions String
    Enables cookie-based session persistence.
    stickySessionsCookieName String
    Cookie name for sticky sessions.
    timeoutConnect String
    Maximum initial server connection establishment time.
    timeoutServer String
    Maximum server connection inactivity time.
    timeoutTunnel String
    Maximum tunnel inactivity time.
    updateAt String
    The date at which the backend was last updated (RFC 3339 format).

    GetLbBackendsBackendHealthCheckHttp

    Code int
    The expected HTTP status code.
    HostHeader string
    The HTTP host header to use for HC requests.
    Method string
    The HTTP method to use for HC requests.
    Sni string
    The SNI to use for HC requests over SSL.
    Uri string
    The HTTPS endpoint URL to call for HC requests.
    Code int
    The expected HTTP status code.
    HostHeader string
    The HTTP host header to use for HC requests.
    Method string
    The HTTP method to use for HC requests.
    Sni string
    The SNI to use for HC requests over SSL.
    Uri string
    The HTTPS endpoint URL to call for HC requests.
    code Integer
    The expected HTTP status code.
    hostHeader String
    The HTTP host header to use for HC requests.
    method String
    The HTTP method to use for HC requests.
    sni String
    The SNI to use for HC requests over SSL.
    uri String
    The HTTPS endpoint URL to call for HC requests.
    code number
    The expected HTTP status code.
    hostHeader string
    The HTTP host header to use for HC requests.
    method string
    The HTTP method to use for HC requests.
    sni string
    The SNI to use for HC requests over SSL.
    uri string
    The HTTPS endpoint URL to call for HC requests.
    code int
    The expected HTTP status code.
    host_header str
    The HTTP host header to use for HC requests.
    method str
    The HTTP method to use for HC requests.
    sni str
    The SNI to use for HC requests over SSL.
    uri str
    The HTTPS endpoint URL to call for HC requests.
    code Number
    The expected HTTP status code.
    hostHeader String
    The HTTP host header to use for HC requests.
    method String
    The HTTP method to use for HC requests.
    sni String
    The SNI to use for HC requests over SSL.
    uri String
    The HTTPS endpoint URL to call for HC requests.

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.12.1 published on Monday, Apr 15, 2024 by pulumiverse
    pulumiverse/pulumi-scaleway