Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ucloud Provider
  3. API Docs
  4. LbListener
ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
ucloud/terraform-provider-ucloud

ucloud.LbListener

Explore with Pulumi AI

ucloud logo
ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
ucloud/terraform-provider-ucloud

    Provides a Load Balancer Listener resource.

    Note This listen_type only support when protocol is tcp in the extranet mode and the default value is request_proxy. In addition, in the extranet mode, the listen_type is request_proxy if protocolis http or https, the listen_type is packets_transmit if protocolis udp. In the intranet mode, the listen_type is packets_transmit.

    Example Usage

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

const web = new ucloud.Lb("web", {tag: "tf-example"});
const example = new ucloud.LbListener("example", {
    loadBalancerId: web.lbId,
    protocol: "http",
});

    import pulumi
import pulumi_ucloud as ucloud

web = ucloud.Lb("web", tag="tf-example")
example = ucloud.LbListener("example",
    load_balancer_id=web.lb_id,
    protocol="http")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ucloud/ucloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		web, err := ucloud.NewLb(ctx, "web", &ucloud.LbArgs{
			Tag: pulumi.String("tf-example"),
		})
		if err != nil {
			return err
		}
		_, err = ucloud.NewLbListener(ctx, "example", &ucloud.LbListenerArgs{
			LoadBalancerId: web.LbId,
			Protocol:       pulumi.String("http"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var web = new Ucloud.Lb("web", new()
    {
        Tag = "tf-example",
    });

    var example = new Ucloud.LbListener("example", new()
    {
        LoadBalancerId = web.LbId,
        Protocol = "http",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ucloud.Lb;
import com.pulumi.ucloud.LbArgs;
import com.pulumi.ucloud.LbListener;
import com.pulumi.ucloud.LbListenerArgs;
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) {
        var web = new Lb("web", LbArgs.builder()
            .tag("tf-example")
            .build());

        var example = new LbListener("example", LbListenerArgs.builder()
            .loadBalancerId(web.lbId())
            .protocol("http")
            .build());

    }
}

    resources:
  web:
    type: ucloud:Lb
    properties:
      tag: tf-example
  example:
    type: ucloud:LbListener
    properties:
      loadBalancerId: ${web.lbId}
      protocol: http

    Create LbListener Resource

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

    Constructor syntax

    new LbListener(name: string, args: LbListenerArgs, opts?: CustomResourceOptions);
    @overload
def LbListener(resource_name: str,
               args: LbListenerArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def LbListener(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               load_balancer_id: Optional[str] = None,
               protocol: Optional[str] = None,
               method: Optional[str] = None,
               lb_listener_id: Optional[str] = None,
               listen_type: Optional[str] = None,
               idle_timeout: Optional[float] = None,
               domain: Optional[str] = None,
               name: Optional[str] = None,
               path: Optional[str] = None,
               persistence: Optional[str] = None,
               persistence_type: Optional[str] = None,
               port: Optional[float] = None,
               health_check_type: Optional[str] = None)
    func NewLbListener(ctx *Context, name string, args LbListenerArgs, opts ...ResourceOption) (*LbListener, error)
    public LbListener(string name, LbListenerArgs args, CustomResourceOptions? opts = null)
    public LbListener(String name, LbListenerArgs args)
public LbListener(String name, LbListenerArgs args, CustomResourceOptions options)

    type: ucloud:LbListener
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 LbListenerArgs
    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 LbListenerArgs
    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 LbListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbListenerArgs
    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 lbListenerResource = new Ucloud.LbListener("lbListenerResource", new()
{
    LoadBalancerId = "string",
    Protocol = "string",
    Method = "string",
    LbListenerId = "string",
    ListenType = "string",
    IdleTimeout = 0,
    Domain = "string",
    Name = "string",
    Path = "string",
    Persistence = "string",
    PersistenceType = "string",
    Port = 0,
    HealthCheckType = "string",
});

    example, err := ucloud.NewLbListener(ctx, "lbListenerResource", &ucloud.LbListenerArgs{
	LoadBalancerId:  pulumi.String("string"),
	Protocol:        pulumi.String("string"),
	Method:          pulumi.String("string"),
	LbListenerId:    pulumi.String("string"),
	ListenType:      pulumi.String("string"),
	IdleTimeout:     pulumi.Float64(0),
	Domain:          pulumi.String("string"),
	Name:            pulumi.String("string"),
	Path:            pulumi.String("string"),
	Persistence:     pulumi.String("string"),
	PersistenceType: pulumi.String("string"),
	Port:            pulumi.Float64(0),
	HealthCheckType: pulumi.String("string"),
})

    var lbListenerResource = new LbListener("lbListenerResource", LbListenerArgs.builder()
    .loadBalancerId("string")
    .protocol("string")
    .method("string")
    .lbListenerId("string")
    .listenType("string")
    .idleTimeout(0)
    .domain("string")
    .name("string")
    .path("string")
    .persistence("string")
    .persistenceType("string")
    .port(0)
    .healthCheckType("string")
    .build());

    lb_listener_resource = ucloud.LbListener("lbListenerResource",
    load_balancer_id="string",
    protocol="string",
    method="string",
    lb_listener_id="string",
    listen_type="string",
    idle_timeout=0,
    domain="string",
    name="string",
    path="string",
    persistence="string",
    persistence_type="string",
    port=0,
    health_check_type="string")

    const lbListenerResource = new ucloud.LbListener("lbListenerResource", {
    loadBalancerId: "string",
    protocol: "string",
    method: "string",
    lbListenerId: "string",
    listenType: "string",
    idleTimeout: 0,
    domain: "string",
    name: "string",
    path: "string",
    persistence: "string",
    persistenceType: "string",
    port: 0,
    healthCheckType: "string",
});

    type: ucloud:LbListener
properties:
    domain: string
    healthCheckType: string
    idleTimeout: 0
    lbListenerId: string
    listenType: string
    loadBalancerId: string
    method: string
    name: string
    path: string
    persistence: string
    persistenceType: string
    port: 0
    protocol: string

    LbListener 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 LbListener resource accepts the following input properties:

    LoadBalancerId string
    The ID of load balancer instance.
    Protocol string
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    Domain string
    Health check domain checking.
    HealthCheckType string
    Health check method. Possible values are port as port checking and path as http checking.
    IdleTimeout double
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    LbListenerId string
    The ID of the resource lb listener.
    ListenType string
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    Method string
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    Name string
    Path string
    Health check path checking.
    Persistence string
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    PersistenceType string
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    Port double
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    LoadBalancerId string
    The ID of load balancer instance.
    Protocol string
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    Domain string
    Health check domain checking.
    HealthCheckType string
    Health check method. Possible values are port as port checking and path as http checking.
    IdleTimeout float64
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    LbListenerId string
    The ID of the resource lb listener.
    ListenType string
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    Method string
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    Name string
    Path string
    Health check path checking.
    Persistence string
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    PersistenceType string
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    Port float64
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    loadBalancerId String
    The ID of load balancer instance.
    protocol String
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    domain String
    Health check domain checking.
    healthCheckType String
    Health check method. Possible values are port as port checking and path as http checking.
    idleTimeout Double
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    lbListenerId String
    The ID of the resource lb listener.
    listenType String
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    method String
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    name String
    path String
    Health check path checking.
    persistence String
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    persistenceType String
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    port Double
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    loadBalancerId string
    The ID of load balancer instance.
    protocol string
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    domain string
    Health check domain checking.
    healthCheckType string
    Health check method. Possible values are port as port checking and path as http checking.
    idleTimeout number
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    lbListenerId string
    The ID of the resource lb listener.
    listenType string
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    method string
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    name string
    path string
    Health check path checking.
    persistence string
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    persistenceType string
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    port number
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    load_balancer_id str
    The ID of load balancer instance.
    protocol str
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    domain str
    Health check domain checking.
    health_check_type str
    Health check method. Possible values are port as port checking and path as http checking.
    idle_timeout float
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    lb_listener_id str
    The ID of the resource lb listener.
    listen_type str
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    method str
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    name str
    path str
    Health check path checking.
    persistence str
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    persistence_type str
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    port float
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    loadBalancerId String
    The ID of load balancer instance.
    protocol String
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    domain String
    Health check domain checking.
    healthCheckType String
    Health check method. Possible values are port as port checking and path as http checking.
    idleTimeout Number
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    lbListenerId String
    The ID of the resource lb listener.
    listenType String
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    method String
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    name String
    path String
    Health check path checking.
    persistence String
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    persistenceType String
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    port Number
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.

    Look up Existing LbListener Resource

    Get an existing LbListener 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?: LbListenerState, opts?: CustomResourceOptions): LbListener
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain: Optional[str] = None,
        health_check_type: Optional[str] = None,
        idle_timeout: Optional[float] = None,
        lb_listener_id: Optional[str] = None,
        listen_type: Optional[str] = None,
        load_balancer_id: Optional[str] = None,
        method: Optional[str] = None,
        name: Optional[str] = None,
        path: Optional[str] = None,
        persistence: Optional[str] = None,
        persistence_type: Optional[str] = None,
        port: Optional[float] = None,
        protocol: Optional[str] = None,
        status: Optional[str] = None) -> LbListener
    func GetLbListener(ctx *Context, name string, id IDInput, state *LbListenerState, opts ...ResourceOption) (*LbListener, error)
    public static LbListener Get(string name, Input<string> id, LbListenerState? state, CustomResourceOptions? opts = null)
    public static LbListener get(String name, Output<String> id, LbListenerState state, CustomResourceOptions options)
    resources:  _:    type: ucloud:LbListener    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:
    Domain string
    Health check domain checking.
    HealthCheckType string
    Health check method. Possible values are port as port checking and path as http checking.
    IdleTimeout double
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    LbListenerId string
    The ID of the resource lb listener.
    ListenType string
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    LoadBalancerId string
    The ID of load balancer instance.
    Method string
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    Name string
    Path string
    Health check path checking.
    Persistence string
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    PersistenceType string
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    Port double
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    Protocol string
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    Status string
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    Domain string
    Health check domain checking.
    HealthCheckType string
    Health check method. Possible values are port as port checking and path as http checking.
    IdleTimeout float64
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    LbListenerId string
    The ID of the resource lb listener.
    ListenType string
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    LoadBalancerId string
    The ID of load balancer instance.
    Method string
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    Name string
    Path string
    Health check path checking.
    Persistence string
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    PersistenceType string
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    Port float64
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    Protocol string
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    Status string
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    domain String
    Health check domain checking.
    healthCheckType String
    Health check method. Possible values are port as port checking and path as http checking.
    idleTimeout Double
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    lbListenerId String
    The ID of the resource lb listener.
    listenType String
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    loadBalancerId String
    The ID of load balancer instance.
    method String
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    name String
    path String
    Health check path checking.
    persistence String
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    persistenceType String
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    port Double
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    protocol String
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    status String
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    domain string
    Health check domain checking.
    healthCheckType string
    Health check method. Possible values are port as port checking and path as http checking.
    idleTimeout number
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    lbListenerId string
    The ID of the resource lb listener.
    listenType string
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    loadBalancerId string
    The ID of load balancer instance.
    method string
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    name string
    path string
    Health check path checking.
    persistence string
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    persistenceType string
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    port number
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    protocol string
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    status string
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    domain str
    Health check domain checking.
    health_check_type str
    Health check method. Possible values are port as port checking and path as http checking.
    idle_timeout float
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    lb_listener_id str
    The ID of the resource lb listener.
    listen_type str
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    load_balancer_id str
    The ID of load balancer instance.
    method str
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    name str
    path str
    Health check path checking.
    persistence str
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    persistence_type str
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    port float
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    protocol str
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    status str
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.
    domain String
    Health check domain checking.
    healthCheckType String
    Health check method. Possible values are port as port checking and path as http checking.
    idleTimeout Number
    Keep alive timeout of the connection between the client and LB, measured in second. Range: 0-86400 when listen_type is request_proxy, range: 60-900 when listen_type is packets_transmit (Default: 60). The connection will be closed as soon as no response between the client and LB if it set by 0.
    lbListenerId String
    The ID of the resource lb listener.
    listenType String
    The type of listener. Possible values are request_proxy and packets_transmit. When packets_transmit was specified, you need to config the instances by yourself if the instances attach to the load balancer. You may refer to configuration instruction.
    loadBalancerId String
    The ID of load balancer instance.
    method String
    The load balancer method in which the listener is. Possible values are: roundrobin, source, consistent_hash, source_port , consistent_hash_port, weight_roundrobin and leastconn. (Default: roundrobin).

    • The consistent_hash, source_port , consistent_hash_port, roundrobin, source and weight_roundrobin are valid if listen_type is packets_transmit.
    • The roundrobin, source and weight_roundrobin and leastconn are valid if listen_type is request_proxy.
    name String
    path String
    Health check path checking.
    persistence String
    Indicate whether the persistence session is enabled, it is invalid if persistence_type is none, an auto-generated string will be exported if persistence_type is server_insert, a custom string will be exported if persistence_type is user_defined.
    persistenceType String
    The type of session persistence of listener. Possible values are: none as disabled, server_insert as auto-generated key and user_defined as customized key. (Default: none).
    port Number
    Port opened on the listeners to receive requests, range: 1-65535. The default value: 80 as protocol is http, 443 as protocol is https, 1024 as protocol is tcp or udp.
    protocol String
    Listener protocol. Possible values: http, https, tcp if listen_type is request_proxy, tcp and udp if listen_type is packets_transmit.

    status String
    Listener status. Possible values are: allNormal for all resource functioning well, partNormal for partial resource functioning well and allException for all resource functioning exceptional.

    Import

    LB Listener can be imported using the id, e.g.

    $ pulumi import ucloud:index/lbListener:LbListener example vserver-abcdefg

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

    Package Details

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