1. Packages
  2. Edgecenter Provider
  3. API Docs
  4. getLbpool
edgecenter 0.8.0 published on Wednesday, Apr 30, 2025 by edge-center

edgecenter.getLbpool

Explore with Pulumi AI

edgecenter logo
edgecenter 0.8.0 published on Wednesday, Apr 30, 2025 by edge-center

    Represent information about load balancer listener pool. A pool is a list of virtual machines to which the listener will redirect incoming traffic.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as edgecenter from "@pulumi/edgecenter";
    
    const pr = edgecenter.getProject({
        name: "test",
    });
    const rg = edgecenter.getRegion({
        name: "ED-10 Preprod",
    });
    const pool = Promise.all([rg, pr]).then(([rg, pr]) => edgecenter.getLbpool({
        name: "test-pool",
        regionId: rg.id,
        projectId: pr.id,
    }));
    export const view = pool;
    
    import pulumi
    import pulumi_edgecenter as edgecenter
    
    pr = edgecenter.get_project(name="test")
    rg = edgecenter.get_region(name="ED-10 Preprod")
    pool = edgecenter.get_lbpool(name="test-pool",
        region_id=rg.id,
        project_id=pr.id)
    pulumi.export("view", pool)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/edgecenter/edgecenter"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		pr, err := edgecenter.LookupProject(ctx, &edgecenter.LookupProjectArgs{
    			Name: pulumi.StringRef("test"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		rg, err := edgecenter.GetRegion(ctx, &edgecenter.GetRegionArgs{
    			Name: "ED-10 Preprod",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		pool, err := edgecenter.LookupLbpool(ctx, &edgecenter.LookupLbpoolArgs{
    			Name:      "test-pool",
    			RegionId:  pulumi.Float64Ref(rg.Id),
    			ProjectId: pulumi.Float64Ref(pr.Id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("view", pool)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Edgecenter = Pulumi.Edgecenter;
    
    return await Deployment.RunAsync(() => 
    {
        var pr = Edgecenter.GetProject.Invoke(new()
        {
            Name = "test",
        });
    
        var rg = Edgecenter.GetRegion.Invoke(new()
        {
            Name = "ED-10 Preprod",
        });
    
        var pool = Edgecenter.GetLbpool.Invoke(new()
        {
            Name = "test-pool",
            RegionId = rg.Apply(getRegionResult => getRegionResult.Id),
            ProjectId = pr.Apply(getProjectResult => getProjectResult.Id),
        });
    
        return new Dictionary<string, object?>
        {
            ["view"] = pool,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.edgecenter.EdgecenterFunctions;
    import com.pulumi.edgecenter.inputs.GetProjectArgs;
    import com.pulumi.edgecenter.inputs.GetRegionArgs;
    import com.pulumi.edgecenter.inputs.GetLbpoolArgs;
    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 pr = EdgecenterFunctions.getProject(GetProjectArgs.builder()
                .name("test")
                .build());
    
            final var rg = EdgecenterFunctions.getRegion(GetRegionArgs.builder()
                .name("ED-10 Preprod")
                .build());
    
            final var pool = EdgecenterFunctions.getLbpool(GetLbpoolArgs.builder()
                .name("test-pool")
                .regionId(rg.applyValue(getRegionResult -> getRegionResult.id()))
                .projectId(pr.applyValue(getProjectResult -> getProjectResult.id()))
                .build());
    
            ctx.export("view", pool.applyValue(getLbpoolResult -> getLbpoolResult));
        }
    }
    
    variables:
      pr:
        fn::invoke:
          function: edgecenter:getProject
          arguments:
            name: test
      rg:
        fn::invoke:
          function: edgecenter:getRegion
          arguments:
            name: ED-10 Preprod
      pool:
        fn::invoke:
          function: edgecenter:getLbpool
          arguments:
            name: test-pool
            regionId: ${rg.id}
            projectId: ${pr.id}
    outputs:
      view: ${pool}
    

    Using getLbpool

    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 getLbpool(args: GetLbpoolArgs, opts?: InvokeOptions): Promise<GetLbpoolResult>
    function getLbpoolOutput(args: GetLbpoolOutputArgs, opts?: InvokeOptions): Output<GetLbpoolResult>
    def get_lbpool(id: Optional[str] = None,
                   listener_id: Optional[str] = None,
                   loadbalancer_id: Optional[str] = None,
                   name: Optional[str] = None,
                   project_id: Optional[float] = None,
                   project_name: Optional[str] = None,
                   region_id: Optional[float] = None,
                   region_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetLbpoolResult
    def get_lbpool_output(id: Optional[pulumi.Input[str]] = None,
                   listener_id: Optional[pulumi.Input[str]] = None,
                   loadbalancer_id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   project_id: Optional[pulumi.Input[float]] = None,
                   project_name: Optional[pulumi.Input[str]] = None,
                   region_id: Optional[pulumi.Input[float]] = None,
                   region_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetLbpoolResult]
    func LookupLbpool(ctx *Context, args *LookupLbpoolArgs, opts ...InvokeOption) (*LookupLbpoolResult, error)
    func LookupLbpoolOutput(ctx *Context, args *LookupLbpoolOutputArgs, opts ...InvokeOption) LookupLbpoolResultOutput

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

    public static class GetLbpool 
    {
        public static Task<GetLbpoolResult> InvokeAsync(GetLbpoolArgs args, InvokeOptions? opts = null)
        public static Output<GetLbpoolResult> Invoke(GetLbpoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLbpoolResult> getLbpool(GetLbpoolArgs args, InvokeOptions options)
    public static Output<GetLbpoolResult> getLbpool(GetLbpoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: edgecenter:index/getLbpool:getLbpool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the load balancer pool.
    Id string
    The ID of this resource.
    ListenerId string
    The uuid for the load balancer listener.
    LoadbalancerId string
    The uuid for the load balancer.
    ProjectId double
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    ProjectName string
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    RegionId double
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    RegionName string
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    Name string
    The name of the load balancer pool.
    Id string
    The ID of this resource.
    ListenerId string
    The uuid for the load balancer listener.
    LoadbalancerId string
    The uuid for the load balancer.
    ProjectId float64
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    ProjectName string
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    RegionId float64
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    RegionName string
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    name String
    The name of the load balancer pool.
    id String
    The ID of this resource.
    listenerId String
    The uuid for the load balancer listener.
    loadbalancerId String
    The uuid for the load balancer.
    projectId Double
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    projectName String
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    regionId Double
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    regionName String
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    name string
    The name of the load balancer pool.
    id string
    The ID of this resource.
    listenerId string
    The uuid for the load balancer listener.
    loadbalancerId string
    The uuid for the load balancer.
    projectId number
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    projectName string
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    regionId number
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    regionName string
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    name str
    The name of the load balancer pool.
    id str
    The ID of this resource.
    listener_id str
    The uuid for the load balancer listener.
    loadbalancer_id str
    The uuid for the load balancer.
    project_id float
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    project_name str
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    region_id float
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    region_name str
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    name String
    The name of the load balancer pool.
    id String
    The ID of this resource.
    listenerId String
    The uuid for the load balancer listener.
    loadbalancerId String
    The uuid for the load balancer.
    projectId Number
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    projectName String
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    regionId Number
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    regionName String
    The name of the region. Either 'regionid' or 'regionname' must be specified.

    getLbpool Result

    The following output properties are available:

    HealthMonitors List<GetLbpoolHealthMonitor>
    Configuration for health checks to test the health and state of the backend members. It determines how the load balancer identifies whether the backend members are healthy or unhealthy.
    Id string
    The ID of this resource.
    LbAlgorithm string
    Available values are ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP.
    ListenerId string
    The uuid for the load balancer listener.
    LoadbalancerId string
    The uuid for the load balancer.
    Name string
    The name of the load balancer pool.
    Protocol string
    Available values are HTTP (currently work, others do not work on ed-8), HTTPS, TCP, UDP.
    SessionPersistences List<GetLbpoolSessionPersistence>
    Configuration that enables the load balancer to bind a user's session to a specific backend member. This ensures that all requests from the user during the session are sent to the same member.
    ProjectId double
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    ProjectName string
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    RegionId double
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    RegionName string
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    HealthMonitors []GetLbpoolHealthMonitor
    Configuration for health checks to test the health and state of the backend members. It determines how the load balancer identifies whether the backend members are healthy or unhealthy.
    Id string
    The ID of this resource.
    LbAlgorithm string
    Available values are ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP.
    ListenerId string
    The uuid for the load balancer listener.
    LoadbalancerId string
    The uuid for the load balancer.
    Name string
    The name of the load balancer pool.
    Protocol string
    Available values are HTTP (currently work, others do not work on ed-8), HTTPS, TCP, UDP.
    SessionPersistences []GetLbpoolSessionPersistence
    Configuration that enables the load balancer to bind a user's session to a specific backend member. This ensures that all requests from the user during the session are sent to the same member.
    ProjectId float64
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    ProjectName string
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    RegionId float64
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    RegionName string
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    healthMonitors List<GetLbpoolHealthMonitor>
    Configuration for health checks to test the health and state of the backend members. It determines how the load balancer identifies whether the backend members are healthy or unhealthy.
    id String
    The ID of this resource.
    lbAlgorithm String
    Available values are ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP.
    listenerId String
    The uuid for the load balancer listener.
    loadbalancerId String
    The uuid for the load balancer.
    name String
    The name of the load balancer pool.
    protocol String
    Available values are HTTP (currently work, others do not work on ed-8), HTTPS, TCP, UDP.
    sessionPersistences List<GetLbpoolSessionPersistence>
    Configuration that enables the load balancer to bind a user's session to a specific backend member. This ensures that all requests from the user during the session are sent to the same member.
    projectId Double
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    projectName String
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    regionId Double
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    regionName String
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    healthMonitors GetLbpoolHealthMonitor[]
    Configuration for health checks to test the health and state of the backend members. It determines how the load balancer identifies whether the backend members are healthy or unhealthy.
    id string
    The ID of this resource.
    lbAlgorithm string
    Available values are ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP.
    listenerId string
    The uuid for the load balancer listener.
    loadbalancerId string
    The uuid for the load balancer.
    name string
    The name of the load balancer pool.
    protocol string
    Available values are HTTP (currently work, others do not work on ed-8), HTTPS, TCP, UDP.
    sessionPersistences GetLbpoolSessionPersistence[]
    Configuration that enables the load balancer to bind a user's session to a specific backend member. This ensures that all requests from the user during the session are sent to the same member.
    projectId number
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    projectName string
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    regionId number
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    regionName string
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    health_monitors Sequence[GetLbpoolHealthMonitor]
    Configuration for health checks to test the health and state of the backend members. It determines how the load balancer identifies whether the backend members are healthy or unhealthy.
    id str
    The ID of this resource.
    lb_algorithm str
    Available values are ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP.
    listener_id str
    The uuid for the load balancer listener.
    loadbalancer_id str
    The uuid for the load balancer.
    name str
    The name of the load balancer pool.
    protocol str
    Available values are HTTP (currently work, others do not work on ed-8), HTTPS, TCP, UDP.
    session_persistences Sequence[GetLbpoolSessionPersistence]
    Configuration that enables the load balancer to bind a user's session to a specific backend member. This ensures that all requests from the user during the session are sent to the same member.
    project_id float
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    project_name str
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    region_id float
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    region_name str
    The name of the region. Either 'regionid' or 'regionname' must be specified.
    healthMonitors List<Property Map>
    Configuration for health checks to test the health and state of the backend members. It determines how the load balancer identifies whether the backend members are healthy or unhealthy.
    id String
    The ID of this resource.
    lbAlgorithm String
    Available values are ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP.
    listenerId String
    The uuid for the load balancer listener.
    loadbalancerId String
    The uuid for the load balancer.
    name String
    The name of the load balancer pool.
    protocol String
    Available values are HTTP (currently work, others do not work on ed-8), HTTPS, TCP, UDP.
    sessionPersistences List<Property Map>
    Configuration that enables the load balancer to bind a user's session to a specific backend member. This ensures that all requests from the user during the session are sent to the same member.
    projectId Number
    The uuid of the project. Either 'projectid' or 'projectname' must be specified.
    projectName String
    The name of the project. Either 'projectid' or 'projectname' must be specified.
    regionId Number
    The uuid of the region. Either 'regionid' or 'regionname' must be specified.
    regionName String
    The name of the region. Either 'regionid' or 'regionname' must be specified.

    Supporting Types

    GetLbpoolHealthMonitor

    Delay double
    ExpectedCodes string
    HttpMethod string
    Id string
    MaxRetries double
    MaxRetriesDown double
    Timeout double
    Type string
    UrlPath string
    Delay float64
    ExpectedCodes string
    HttpMethod string
    Id string
    MaxRetries float64
    MaxRetriesDown float64
    Timeout float64
    Type string
    UrlPath string
    delay Double
    expectedCodes String
    httpMethod String
    id String
    maxRetries Double
    maxRetriesDown Double
    timeout Double
    type String
    urlPath String
    delay number
    expectedCodes string
    httpMethod string
    id string
    maxRetries number
    maxRetriesDown number
    timeout number
    type string
    urlPath string
    delay Number
    expectedCodes String
    httpMethod String
    id String
    maxRetries Number
    maxRetriesDown Number
    timeout Number
    type String
    urlPath String

    GetLbpoolSessionPersistence

    Package Details

    Repository
    edgecenter edge-center/terraform-provider-edgecenter
    License
    Notes
    This Pulumi package is based on the edgecenter Terraform Provider.
    edgecenter logo
    edgecenter 0.8.0 published on Wednesday, Apr 30, 2025 by edge-center