Scaleway v1.15.0 published on Tuesday, Jul 30, 2024 by pulumiverse
scaleway.getLbBackends
Explore with Pulumi AI
Gets information about multiple Load Balancer Backends.
For more information, see the main documentation or API documentation.
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:
- lb_
id str - The Load Balancer ID this backend is attached to. Backends with a matching ID are listed.
- name str
- The backend name to filter for. Backends with a matching name are listed.
- project_
id str - zone str
zone
) The zone in which backends exist.
getLbBackends Result
The following output properties are available:
- Backends
List<Pulumiverse.
Scaleway. Outputs. Get Lb Backends Backend> - List of retrieved backends
- Id string
- The provider-assigned unique ID for this managed resource.
- Lb
Id string - Organization
Id string - Project
Id string - Zone string
- Name string
- Backends
[]Get
Lb Backends Backend - List of retrieved backends
- Id string
- The provider-assigned unique ID for this managed resource.
- Lb
Id string - Organization
Id string - Project
Id string - Zone string
- Name string
- backends
List<Get
Lb Backends Backend> - List of retrieved backends
- id String
- The provider-assigned unique ID for this managed resource.
- lb
Id String - organization
Id String - project
Id String - zone String
- name String
- backends
Get
Lb Backends Backend[] - List of retrieved backends
- id string
- The provider-assigned unique ID for this managed resource.
- lb
Id string - organization
Id string - project
Id string - zone string
- name string
- backends
Sequence[Get
Lb Backends Backend] - List of retrieved 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 retrieved backends
- id String
- The provider-assigned unique ID for this managed resource.
- lb
Id String - organization
Id String - project
Id String - zone String
- name String
Supporting Types
GetLbBackendsBackend
- Created
At string - The date on which the backend was created (RFC 3339 format).
- Failover
Host string - Scaleway S3 bucket website to be served if all backend servers are down.
- Forward
Port int - User sessions will be forwarded to this backend server port.
- Forward
Port stringAlgorithm - Load balancing algorithm.
- Forward
Protocol string - Backend protocol.
- Health
Check stringDelay - Interval between two health check requests.
- Health
Check List<Pulumiverse.Http Scaleway. Inputs. Get Lb Backends Backend Health Check Http> - This block enables HTTP health checks.
- Health
Check List<Pulumiverse.Https Scaleway. Inputs. Get Lb Backends Backend Health Check Http> - This block enables HTTPS health checks.
- Health
Check intMax Retries - Number of allowed failed health check requests before the backend server is marked as down.
- Health
Check intPort - Port the health check requests will be sent to.
- Health
Check List<Pulumiverse.Tcps Scaleway. Inputs. Get Lb Backends Backend Health Check Tcp> - This block enables TCP health checks.
- Health
Check stringTimeout - Timeout before a health check request is considered failed.
- Id string
- The associated backend ID.
- Ignore
Ssl boolServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- Lb
Id string - The Load Balancer ID this backend is attached to. Backends with a matching ID are listed.
- Name string
- The backend name to filter for. Backends with a matching name are listed.
- On
Marked stringDown Action - Modify what occurs when a backend server is marked down.
- Proxy
Protocol string - The type of PROXY protocol.
- Server
Ips List<string> - List of backend server IP addresses.
- Ssl
Bridging bool - Enables SSL between Load Balancer and backend servers.
- Sticky
Sessions string - Enables cookie-based session persistence.
- string
- Cookie name for sticky sessions.
- Timeout
Connect string - Maximum initial server connection establishment time.
- Timeout
Server string - Maximum server connection inactivity time.
- Timeout
Tunnel string - Maximum tunnel inactivity time.
- Update
At string - The date on which the backend was last updated (RFC 3339 format).
- Created
At string - The date on which the backend was created (RFC 3339 format).
- Failover
Host string - Scaleway S3 bucket website to be served if all backend servers are down.
- Forward
Port int - User sessions will be forwarded to this backend server port.
- Forward
Port stringAlgorithm - Load balancing algorithm.
- Forward
Protocol string - Backend protocol.
- Health
Check stringDelay - Interval between two health check requests.
- Health
Check []GetHttp Lb Backends Backend Health Check Http - This block enables HTTP health checks.
- Health
Check []GetHttps Lb Backends Backend Health Check Http - This block enables HTTPS health checks.
- Health
Check intMax Retries - Number of allowed failed health check requests before the backend server is marked as down.
- Health
Check intPort - Port the health check requests will be sent to.
- Health
Check []GetTcps Lb Backends Backend Health Check Tcp - This block enables TCP health checks.
- Health
Check stringTimeout - Timeout before a health check request is considered failed.
- Id string
- The associated backend ID.
- Ignore
Ssl boolServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- Lb
Id string - The Load Balancer ID this backend is attached to. Backends with a matching ID are listed.
- Name string
- The backend name to filter for. Backends with a matching name are listed.
- On
Marked stringDown Action - Modify what occurs when a backend server is marked down.
- Proxy
Protocol string - The type of PROXY protocol.
- Server
Ips []string - List of backend server IP addresses.
- Ssl
Bridging bool - Enables SSL between Load Balancer and backend servers.
- Sticky
Sessions string - Enables cookie-based session persistence.
- string
- Cookie name for sticky sessions.
- Timeout
Connect string - Maximum initial server connection establishment time.
- Timeout
Server string - Maximum server connection inactivity time.
- Timeout
Tunnel string - Maximum tunnel inactivity time.
- Update
At string - The date on which the backend was last updated (RFC 3339 format).
- created
At String - The date on which the backend was created (RFC 3339 format).
- failover
Host String - Scaleway S3 bucket website to be served if all backend servers are down.
- forward
Port Integer - User sessions will be forwarded to this backend server port.
- forward
Port StringAlgorithm - Load balancing algorithm.
- forward
Protocol String - Backend protocol.
- health
Check StringDelay - Interval between two health check requests.
- health
Check List<GetHttp Lb Backends Backend Health Check Http> - This block enables HTTP health checks.
- health
Check List<GetHttps Lb Backends Backend Health Check Http> - This block enables HTTPS health checks.
- health
Check IntegerMax Retries - Number of allowed failed health check requests before the backend server is marked as down.
- health
Check IntegerPort - Port the health check requests will be sent to.
- health
Check List<GetTcps Lb Backends Backend Health Check Tcp> - This block enables TCP health checks.
- health
Check StringTimeout - Timeout before a health check request is considered failed.
- id String
- The associated backend ID.
- ignore
Ssl BooleanServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- lb
Id String - The Load Balancer ID this backend is attached to. Backends with a matching ID are listed.
- name String
- The backend name to filter for. Backends with a matching name are listed.
- on
Marked StringDown Action - Modify what occurs when a backend server is marked down.
- proxy
Protocol String - The type of PROXY protocol.
- server
Ips List<String> - List of backend server IP addresses.
- ssl
Bridging Boolean - Enables SSL between Load Balancer and backend servers.
- sticky
Sessions String - Enables cookie-based session persistence.
- String
- Cookie name for sticky sessions.
- timeout
Connect String - Maximum initial server connection establishment time.
- timeout
Server String - Maximum server connection inactivity time.
- timeout
Tunnel String - Maximum tunnel inactivity time.
- update
At String - The date on which the backend was last updated (RFC 3339 format).
- created
At string - The date on which the backend was created (RFC 3339 format).
- failover
Host string - Scaleway S3 bucket website to be served if all backend servers are down.
- forward
Port number - User sessions will be forwarded to this backend server port.
- forward
Port stringAlgorithm - Load balancing algorithm.
- forward
Protocol string - Backend protocol.
- health
Check stringDelay - Interval between two health check requests.
- health
Check GetHttp Lb Backends Backend Health Check Http[] - This block enables HTTP health checks.
- health
Check GetHttps Lb Backends Backend Health Check Http[] - This block enables HTTPS health checks.
- health
Check numberMax Retries - Number of allowed failed health check requests before the backend server is marked as down.
- health
Check numberPort - Port the health check requests will be sent to.
- health
Check GetTcps Lb Backends Backend Health Check Tcp[] - This block enables TCP health checks.
- health
Check stringTimeout - Timeout before a health check request is considered failed.
- id string
- The associated backend ID.
- ignore
Ssl booleanServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- lb
Id string - The Load Balancer ID this backend is attached to. Backends with a matching ID are listed.
- name string
- The backend name to filter for. Backends with a matching name are listed.
- on
Marked stringDown Action - Modify what occurs when a backend server is marked down.
- proxy
Protocol string - The type of PROXY protocol.
- server
Ips string[] - List of backend server IP addresses.
- ssl
Bridging boolean - Enables SSL between Load Balancer and backend servers.
- sticky
Sessions string - Enables cookie-based session persistence.
- string
- Cookie name for sticky sessions.
- timeout
Connect string - Maximum initial server connection establishment time.
- timeout
Server string - Maximum server connection inactivity time.
- timeout
Tunnel string - Maximum tunnel inactivity time.
- update
At string - The date on which the backend was last updated (RFC 3339 format).
- created_
at str - The date on which the backend was created (RFC 3339 format).
- failover_
host str - Scaleway S3 bucket website to be served if all backend servers are down.
- forward_
port int - User sessions will be forwarded to this backend server port.
- forward_
port_ stralgorithm - Load balancing algorithm.
- forward_
protocol str - Backend protocol.
- health_
check_ strdelay - Interval between two health check requests.
- health_
check_ Sequence[Gethttp Lb Backends Backend Health Check Http] - This block enables HTTP health checks.
- health_
check_ Sequence[Gethttps Lb Backends Backend Health Check Http] - This block enables HTTPS health checks.
- health_
check_ intmax_ retries - Number of allowed failed health check requests before the backend server is marked as down.
- health_
check_ intport - Port the health check requests will be sent to.
- health_
check_ Sequence[Gettcps Lb Backends Backend Health Check Tcp] - This block enables TCP health checks.
- health_
check_ strtimeout - Timeout before a health check request is considered failed.
- id str
- The associated backend ID.
- ignore_
ssl_ boolserver_ verify - 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 matching ID are listed.
- name str
- The backend name to filter for. Backends with a matching name are listed.
- on_
marked_ strdown_ action - 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.
- 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 on which the backend was last updated (RFC 3339 format).
- created
At String - The date on which the backend was created (RFC 3339 format).
- failover
Host String - Scaleway S3 bucket website to be served if all backend servers are down.
- forward
Port Number - User sessions will be forwarded to this backend server port.
- forward
Port StringAlgorithm - Load balancing algorithm.
- forward
Protocol String - Backend protocol.
- health
Check StringDelay - Interval between two health check requests.
- health
Check List<Property Map>Http - This block enables HTTP health checks.
- health
Check List<Property Map>Https - This block enables HTTPS health checks.
- health
Check NumberMax Retries - Number of allowed failed health check requests before the backend server is marked as down.
- health
Check NumberPort - Port the health check requests will be sent to.
- health
Check List<Property Map>Tcps - This block enables TCP health checks.
- health
Check StringTimeout - Timeout before a health check request is considered failed.
- id String
- The associated backend ID.
- ignore
Ssl BooleanServer Verify - Specifies whether the Load Balancer should check the backend server’s certificate before initiating a connection.
- lb
Id String - The Load Balancer ID this backend is attached to. Backends with a matching ID are listed.
- name String
- The backend name to filter for. Backends with a matching name are listed.
- on
Marked StringDown Action - Modify what occurs when a backend server is marked down.
- proxy
Protocol String - The type of PROXY protocol.
- server
Ips List<String> - List of backend server IP addresses.
- ssl
Bridging Boolean - Enables SSL between Load Balancer and backend servers.
- sticky
Sessions String - Enables cookie-based session persistence.
- String
- Cookie name for sticky sessions.
- timeout
Connect String - Maximum initial server connection establishment time.
- timeout
Server String - Maximum server connection inactivity time.
- timeout
Tunnel String - Maximum tunnel inactivity time.
- update
At String - The date on which the backend was last updated (RFC 3339 format).
GetLbBackendsBackendHealthCheckHttp
- Code int
- The expected HTTP status code.
- Host
Header string - The HTTP host header to use for health check requests.
- Method string
- The HTTP method to use for health check requests.
- Sni string
- The SNI to use for HC requests over SSL.
- Uri string
- The HTTPS endpoint URL to call for health check requests.
- Code int
- The expected HTTP status code.
- Host
Header string - The HTTP host header to use for health check requests.
- Method string
- The HTTP method to use for health check requests.
- Sni string
- The SNI to use for HC requests over SSL.
- Uri string
- The HTTPS endpoint URL to call for health check requests.
- code Integer
- The expected HTTP status code.
- host
Header String - The HTTP host header to use for health check requests.
- method String
- The HTTP method to use for health check requests.
- sni String
- The SNI to use for HC requests over SSL.
- uri String
- The HTTPS endpoint URL to call for health check requests.
- code number
- The expected HTTP status code.
- host
Header string - The HTTP host header to use for health check requests.
- method string
- The HTTP method to use for health check requests.
- sni string
- The SNI to use for HC requests over SSL.
- uri string
- The HTTPS endpoint URL to call for health check requests.
- code int
- The expected HTTP status code.
- host_
header str - The HTTP host header to use for health check requests.
- method str
- The HTTP method to use for health check requests.
- sni str
- The SNI to use for HC requests over SSL.
- uri str
- The HTTPS endpoint URL to call for health check requests.
- code Number
- The expected HTTP status code.
- host
Header String - The HTTP host header to use for health check requests.
- method String
- The HTTP method to use for health check requests.
- sni String
- The SNI to use for HC requests over SSL.
- uri String
- The HTTPS endpoint URL to call for health check requests.
Package Details
- Repository
- scaleway pulumiverse/pulumi-scaleway
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scaleway
Terraform Provider.