1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. LbPoolV3
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleengine.LbPoolV3

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

    Manages an ELB pool resource within FlexibleEngine.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as flexibleengine from "@pulumi/flexibleengine";
    
    const config = new pulumi.Config();
    const listenerId = config.requireObject("listenerId");
    const pool1 = new flexibleengine.LbPoolV3("pool1", {
        protocol: "HTTP",
        lbMethod: "ROUND_ROBIN",
        listenerId: listenerId,
        persistences: [{
            type: "HTTP_COOKIE",
            cookieName: "testCookie",
        }],
    });
    
    import pulumi
    import pulumi_flexibleengine as flexibleengine
    
    config = pulumi.Config()
    listener_id = config.require_object("listenerId")
    pool1 = flexibleengine.LbPoolV3("pool1",
        protocol="HTTP",
        lb_method="ROUND_ROBIN",
        listener_id=listener_id,
        persistences=[{
            "type": "HTTP_COOKIE",
            "cookie_name": "testCookie",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		listenerId := cfg.RequireObject("listenerId")
    		_, err := flexibleengine.NewLbPoolV3(ctx, "pool1", &flexibleengine.LbPoolV3Args{
    			Protocol:   pulumi.String("HTTP"),
    			LbMethod:   pulumi.String("ROUND_ROBIN"),
    			ListenerId: pulumi.Any(listenerId),
    			Persistences: flexibleengine.LbPoolV3PersistenceArray{
    				&flexibleengine.LbPoolV3PersistenceArgs{
    					Type:       pulumi.String("HTTP_COOKIE"),
    					CookieName: pulumi.String("testCookie"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Flexibleengine = Pulumi.Flexibleengine;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var listenerId = config.RequireObject<dynamic>("listenerId");
        var pool1 = new Flexibleengine.LbPoolV3("pool1", new()
        {
            Protocol = "HTTP",
            LbMethod = "ROUND_ROBIN",
            ListenerId = listenerId,
            Persistences = new[]
            {
                new Flexibleengine.Inputs.LbPoolV3PersistenceArgs
                {
                    Type = "HTTP_COOKIE",
                    CookieName = "testCookie",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.flexibleengine.LbPoolV3;
    import com.pulumi.flexibleengine.LbPoolV3Args;
    import com.pulumi.flexibleengine.inputs.LbPoolV3PersistenceArgs;
    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 config = ctx.config();
            final var listenerId = config.get("listenerId");
            var pool1 = new LbPoolV3("pool1", LbPoolV3Args.builder()
                .protocol("HTTP")
                .lbMethod("ROUND_ROBIN")
                .listenerId(listenerId)
                .persistences(LbPoolV3PersistenceArgs.builder()
                    .type("HTTP_COOKIE")
                    .cookieName("testCookie")
                    .build())
                .build());
    
        }
    }
    
    configuration:
      listenerId:
        type: dynamic
    resources:
      pool1:
        type: flexibleengine:LbPoolV3
        properties:
          protocol: HTTP
          lbMethod: ROUND_ROBIN
          listenerId: ${listenerId}
          persistences:
            - type: HTTP_COOKIE
              cookieName: testCookie
    

    Create LbPoolV3 Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LbPoolV3(name: string, args: LbPoolV3Args, opts?: CustomResourceOptions);
    @overload
    def LbPoolV3(resource_name: str,
                 args: LbPoolV3Args,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def LbPoolV3(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 protocol: Optional[str] = None,
                 lb_method: Optional[str] = None,
                 protection_status: Optional[str] = None,
                 lb_pool_v3_id: Optional[str] = None,
                 loadbalancer_id: Optional[str] = None,
                 name: Optional[str] = None,
                 persistences: Optional[Sequence[LbPoolV3PersistenceArgs]] = None,
                 protection_reason: Optional[str] = None,
                 description: Optional[str] = None,
                 listener_id: Optional[str] = None,
                 region: Optional[str] = None,
                 slow_start_duration: Optional[float] = None,
                 slow_start_enabled: Optional[bool] = None,
                 timeouts: Optional[LbPoolV3TimeoutsArgs] = None,
                 type: Optional[str] = None,
                 vpc_id: Optional[str] = None)
    func NewLbPoolV3(ctx *Context, name string, args LbPoolV3Args, opts ...ResourceOption) (*LbPoolV3, error)
    public LbPoolV3(string name, LbPoolV3Args args, CustomResourceOptions? opts = null)
    public LbPoolV3(String name, LbPoolV3Args args)
    public LbPoolV3(String name, LbPoolV3Args args, CustomResourceOptions options)
    
    type: flexibleengine:LbPoolV3
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args LbPoolV3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LbPoolV3Args
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LbPoolV3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbPoolV3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbPoolV3Args
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var lbPoolV3Resource = new Flexibleengine.LbPoolV3("lbPoolV3Resource", new()
    {
        Protocol = "string",
        LbMethod = "string",
        ProtectionStatus = "string",
        LbPoolV3Id = "string",
        LoadbalancerId = "string",
        Name = "string",
        Persistences = new[]
        {
            new Flexibleengine.Inputs.LbPoolV3PersistenceArgs
            {
                Type = "string",
                CookieName = "string",
                Timeout = 0,
            },
        },
        ProtectionReason = "string",
        Description = "string",
        ListenerId = "string",
        Region = "string",
        SlowStartDuration = 0,
        SlowStartEnabled = false,
        Timeouts = new Flexibleengine.Inputs.LbPoolV3TimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
        Type = "string",
        VpcId = "string",
    });
    
    example, err := flexibleengine.NewLbPoolV3(ctx, "lbPoolV3Resource", &flexibleengine.LbPoolV3Args{
    	Protocol:         pulumi.String("string"),
    	LbMethod:         pulumi.String("string"),
    	ProtectionStatus: pulumi.String("string"),
    	LbPoolV3Id:       pulumi.String("string"),
    	LoadbalancerId:   pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	Persistences: flexibleengine.LbPoolV3PersistenceArray{
    		&flexibleengine.LbPoolV3PersistenceArgs{
    			Type:       pulumi.String("string"),
    			CookieName: pulumi.String("string"),
    			Timeout:    pulumi.Float64(0),
    		},
    	},
    	ProtectionReason:  pulumi.String("string"),
    	Description:       pulumi.String("string"),
    	ListenerId:        pulumi.String("string"),
    	Region:            pulumi.String("string"),
    	SlowStartDuration: pulumi.Float64(0),
    	SlowStartEnabled:  pulumi.Bool(false),
    	Timeouts: &flexibleengine.LbPoolV3TimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	Type:  pulumi.String("string"),
    	VpcId: pulumi.String("string"),
    })
    
    var lbPoolV3Resource = new LbPoolV3("lbPoolV3Resource", LbPoolV3Args.builder()
        .protocol("string")
        .lbMethod("string")
        .protectionStatus("string")
        .lbPoolV3Id("string")
        .loadbalancerId("string")
        .name("string")
        .persistences(LbPoolV3PersistenceArgs.builder()
            .type("string")
            .cookieName("string")
            .timeout(0)
            .build())
        .protectionReason("string")
        .description("string")
        .listenerId("string")
        .region("string")
        .slowStartDuration(0)
        .slowStartEnabled(false)
        .timeouts(LbPoolV3TimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .type("string")
        .vpcId("string")
        .build());
    
    lb_pool_v3_resource = flexibleengine.LbPoolV3("lbPoolV3Resource",
        protocol="string",
        lb_method="string",
        protection_status="string",
        lb_pool_v3_id="string",
        loadbalancer_id="string",
        name="string",
        persistences=[{
            "type": "string",
            "cookie_name": "string",
            "timeout": 0,
        }],
        protection_reason="string",
        description="string",
        listener_id="string",
        region="string",
        slow_start_duration=0,
        slow_start_enabled=False,
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        },
        type="string",
        vpc_id="string")
    
    const lbPoolV3Resource = new flexibleengine.LbPoolV3("lbPoolV3Resource", {
        protocol: "string",
        lbMethod: "string",
        protectionStatus: "string",
        lbPoolV3Id: "string",
        loadbalancerId: "string",
        name: "string",
        persistences: [{
            type: "string",
            cookieName: "string",
            timeout: 0,
        }],
        protectionReason: "string",
        description: "string",
        listenerId: "string",
        region: "string",
        slowStartDuration: 0,
        slowStartEnabled: false,
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
        type: "string",
        vpcId: "string",
    });
    
    type: flexibleengine:LbPoolV3
    properties:
        description: string
        lbMethod: string
        lbPoolV3Id: string
        listenerId: string
        loadbalancerId: string
        name: string
        persistences:
            - cookieName: string
              timeout: 0
              type: string
        protectionReason: string
        protectionStatus: string
        protocol: string
        region: string
        slowStartDuration: 0
        slowStartEnabled: false
        timeouts:
            create: string
            delete: string
            update: string
        type: string
        vpcId: string
    

    LbPoolV3 Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LbPoolV3 resource accepts the following input properties:

    LbMethod string
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    Protocol string
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    Description string
    Specifies the description for the pool.
    LbPoolV3Id string
    The unique ID for the pool.
    ListenerId string
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    LoadbalancerId string
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    Name string
    Specifies the name for the pool.
    Persistences List<LbPoolV3Persistence>

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    ProtectionReason string
    ProtectionStatus string
    Region string
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    SlowStartDuration double
    SlowStartEnabled bool
    Timeouts LbPoolV3Timeouts
    Type string
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    VpcId string
    LbMethod string
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    Protocol string
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    Description string
    Specifies the description for the pool.
    LbPoolV3Id string
    The unique ID for the pool.
    ListenerId string
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    LoadbalancerId string
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    Name string
    Specifies the name for the pool.
    Persistences []LbPoolV3PersistenceArgs

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    ProtectionReason string
    ProtectionStatus string
    Region string
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    SlowStartDuration float64
    SlowStartEnabled bool
    Timeouts LbPoolV3TimeoutsArgs
    Type string
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    VpcId string
    lbMethod String
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    protocol String
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    description String
    Specifies the description for the pool.
    lbPoolV3Id String
    The unique ID for the pool.
    listenerId String
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    loadbalancerId String
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    name String
    Specifies the name for the pool.
    persistences List<LbPoolV3Persistence>

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    protectionReason String
    protectionStatus String
    region String
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    slowStartDuration Double
    slowStartEnabled Boolean
    timeouts LbPoolV3Timeouts
    type String
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    vpcId String
    lbMethod string
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    protocol string
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    description string
    Specifies the description for the pool.
    lbPoolV3Id string
    The unique ID for the pool.
    listenerId string
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    loadbalancerId string
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    name string
    Specifies the name for the pool.
    persistences LbPoolV3Persistence[]

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    protectionReason string
    protectionStatus string
    region string
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    slowStartDuration number
    slowStartEnabled boolean
    timeouts LbPoolV3Timeouts
    type string
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    vpcId string
    lb_method str
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    protocol str
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    description str
    Specifies the description for the pool.
    lb_pool_v3_id str
    The unique ID for the pool.
    listener_id str
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    loadbalancer_id str
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    name str
    Specifies the name for the pool.
    persistences Sequence[LbPoolV3PersistenceArgs]

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    protection_reason str
    protection_status str
    region str
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    slow_start_duration float
    slow_start_enabled bool
    timeouts LbPoolV3TimeoutsArgs
    type str
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    vpc_id str
    lbMethod String
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    protocol String
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    description String
    Specifies the description for the pool.
    lbPoolV3Id String
    The unique ID for the pool.
    listenerId String
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    loadbalancerId String
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    name String
    Specifies the name for the pool.
    persistences List<Property Map>

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    protectionReason String
    protectionStatus String
    region String
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    slowStartDuration Number
    slowStartEnabled Boolean
    timeouts Property Map
    type String
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    vpcId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LbPoolV3 resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IpVersion string
    Id string
    The provider-assigned unique ID for this managed resource.
    IpVersion string
    id String
    The provider-assigned unique ID for this managed resource.
    ipVersion String
    id string
    The provider-assigned unique ID for this managed resource.
    ipVersion string
    id str
    The provider-assigned unique ID for this managed resource.
    ip_version str
    id String
    The provider-assigned unique ID for this managed resource.
    ipVersion String

    Look up Existing LbPoolV3 Resource

    Get an existing LbPoolV3 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LbPoolV3State, opts?: CustomResourceOptions): LbPoolV3
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            ip_version: Optional[str] = None,
            lb_method: Optional[str] = None,
            lb_pool_v3_id: Optional[str] = None,
            listener_id: Optional[str] = None,
            loadbalancer_id: Optional[str] = None,
            name: Optional[str] = None,
            persistences: Optional[Sequence[LbPoolV3PersistenceArgs]] = None,
            protection_reason: Optional[str] = None,
            protection_status: Optional[str] = None,
            protocol: Optional[str] = None,
            region: Optional[str] = None,
            slow_start_duration: Optional[float] = None,
            slow_start_enabled: Optional[bool] = None,
            timeouts: Optional[LbPoolV3TimeoutsArgs] = None,
            type: Optional[str] = None,
            vpc_id: Optional[str] = None) -> LbPoolV3
    func GetLbPoolV3(ctx *Context, name string, id IDInput, state *LbPoolV3State, opts ...ResourceOption) (*LbPoolV3, error)
    public static LbPoolV3 Get(string name, Input<string> id, LbPoolV3State? state, CustomResourceOptions? opts = null)
    public static LbPoolV3 get(String name, Output<String> id, LbPoolV3State state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:LbPoolV3    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Specifies the description for the pool.
    IpVersion string
    LbMethod string
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    LbPoolV3Id string
    The unique ID for the pool.
    ListenerId string
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    LoadbalancerId string
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    Name string
    Specifies the name for the pool.
    Persistences List<LbPoolV3Persistence>

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    ProtectionReason string
    ProtectionStatus string
    Protocol string
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    Region string
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    SlowStartDuration double
    SlowStartEnabled bool
    Timeouts LbPoolV3Timeouts
    Type string
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    VpcId string
    Description string
    Specifies the description for the pool.
    IpVersion string
    LbMethod string
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    LbPoolV3Id string
    The unique ID for the pool.
    ListenerId string
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    LoadbalancerId string
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    Name string
    Specifies the name for the pool.
    Persistences []LbPoolV3PersistenceArgs

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    ProtectionReason string
    ProtectionStatus string
    Protocol string
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    Region string
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    SlowStartDuration float64
    SlowStartEnabled bool
    Timeouts LbPoolV3TimeoutsArgs
    Type string
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    VpcId string
    description String
    Specifies the description for the pool.
    ipVersion String
    lbMethod String
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    lbPoolV3Id String
    The unique ID for the pool.
    listenerId String
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    loadbalancerId String
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    name String
    Specifies the name for the pool.
    persistences List<LbPoolV3Persistence>

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    protectionReason String
    protectionStatus String
    protocol String
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    region String
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    slowStartDuration Double
    slowStartEnabled Boolean
    timeouts LbPoolV3Timeouts
    type String
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    vpcId String
    description string
    Specifies the description for the pool.
    ipVersion string
    lbMethod string
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    lbPoolV3Id string
    The unique ID for the pool.
    listenerId string
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    loadbalancerId string
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    name string
    Specifies the name for the pool.
    persistences LbPoolV3Persistence[]

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    protectionReason string
    protectionStatus string
    protocol string
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    region string
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    slowStartDuration number
    slowStartEnabled boolean
    timeouts LbPoolV3Timeouts
    type string
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    vpcId string
    description str
    Specifies the description for the pool.
    ip_version str
    lb_method str
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    lb_pool_v3_id str
    The unique ID for the pool.
    listener_id str
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    loadbalancer_id str
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    name str
    Specifies the name for the pool.
    persistences Sequence[LbPoolV3PersistenceArgs]

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    protection_reason str
    protection_status str
    protocol str
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    region str
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    slow_start_duration float
    slow_start_enabled bool
    timeouts LbPoolV3TimeoutsArgs
    type str
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    vpc_id str
    description String
    Specifies the description for the pool.
    ipVersion String
    lbMethod String
    Specifies the load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP.
    lbPoolV3Id String
    The unique ID for the pool.
    listenerId String
    Specifies the listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    loadbalancerId String
    Specifies the load balancer on which to provision this pool. Changing this creates a new pool. Note: Exactly one of LoadbalancerID or ListenerID must be provided.
    name String
    Specifies the name for the pool.
    persistences List<Property Map>

    Specifies the omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. The persistence object structure is documented below. Changing this creates a new pool.

    The persistence argument supports:

    protectionReason String
    protectionStatus String
    protocol String
    Specifies the protocol used by the pool. The value can be TCP, UDP, HTTP, HTTPS or QUIC.

    • When the protocol used by the listener is UDP, the protocol of the backend pool must be UDP or QUIC.
    • When the protocol used by the listener is TCP, the protocol of the backend pool must be TCP.
    • When the protocol used by the listener is HTTP, the protocol of the backend pool must be HTTP.
    • When the protocol used by the listener is HTTPS, the protocol of the backend pool must be HTTPS.
    • When the protocol used by the listener is TERMINATED_HTTPS, the protocol of the backend pool must be HTTP. Changing this creates a new pool.
    region String
    Specifies the region in which to create the ELB pool resource. If omitted, the provider-level region will be used. Changing this will create a new ELB pool resource.
    slowStartDuration Number
    slowStartEnabled Boolean
    timeouts Property Map
    type String
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    vpcId String

    Supporting Types

    LbPoolV3Persistence, LbPoolV3PersistenceArgs

    Type string
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    CookieName string
    Specifies the name of the cookie if persistence mode is set appropriately. Required if type = APP_COOKIE.
    Timeout double
    Specifies the sticky session timeout duration in minutes. This parameter is invalid when type is set to APP_COOKIE. The value range varies depending on the protocol of the backend server group:

    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
    Type string
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    CookieName string
    Specifies the name of the cookie if persistence mode is set appropriately. Required if type = APP_COOKIE.
    Timeout float64
    Specifies the sticky session timeout duration in minutes. This parameter is invalid when type is set to APP_COOKIE. The value range varies depending on the protocol of the backend server group:

    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
    type String
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    cookieName String
    Specifies the name of the cookie if persistence mode is set appropriately. Required if type = APP_COOKIE.
    timeout Double
    Specifies the sticky session timeout duration in minutes. This parameter is invalid when type is set to APP_COOKIE. The value range varies depending on the protocol of the backend server group:

    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
    type string
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    cookieName string
    Specifies the name of the cookie if persistence mode is set appropriately. Required if type = APP_COOKIE.
    timeout number
    Specifies the sticky session timeout duration in minutes. This parameter is invalid when type is set to APP_COOKIE. The value range varies depending on the protocol of the backend server group:

    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
    type str
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    cookie_name str
    Specifies the name of the cookie if persistence mode is set appropriately. Required if type = APP_COOKIE.
    timeout float
    Specifies the sticky session timeout duration in minutes. This parameter is invalid when type is set to APP_COOKIE. The value range varies depending on the protocol of the backend server group:

    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
    type String
    Specifies the type of persistence mode. The current specification supports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE.
    cookieName String
    Specifies the name of the cookie if persistence mode is set appropriately. Required if type = APP_COOKIE.
    timeout Number
    Specifies the sticky session timeout duration in minutes. This parameter is invalid when type is set to APP_COOKIE. The value range varies depending on the protocol of the backend server group:

    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.

    LbPoolV3Timeouts, LbPoolV3TimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    ELB pool can be imported using the pool ID, e.g.

    $ pulumi import flexibleengine:index/lbPoolV3:LbPoolV3 pool_1 5c20fdad-7288-11eb-b817-0255ac10158b
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud