1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. clb
  6. NlbListener
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.clb.NlbListener

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    The listener monitors user access requests received by the NLB instance based on the specified protocol and port. NLB forwards requests to healthy backend servers in the associated server group according to the scheduling algorithm configured for that group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const cLBNLBListenerDemo = new volcenginecc.clb.NlbListener("CLBNLBListenerDemo", {
    loadBalancerId: "nlb-11zz9w3jqptz449iegfwvxxxx",
    protocol: "TCP",
    port: 0,
    serverGroupId: "rsp-11zz9wdewa3uo49ieggq8xxxx",
    connectionTimeout: 60,
    description: "CLBNLBListenerDemo description",
    enabled: true,
    listenerName: "CLBNLBListenerDemo",
    tags: [{
        key: "env",
        value: "Test",
    }],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

c_lbnlb_listener_demo = volcenginecc.clb.NlbListener("CLBNLBListenerDemo",
    load_balancer_id="nlb-11zz9w3jqptz449iegfwvxxxx",
    protocol="TCP",
    port=0,
    server_group_id="rsp-11zz9wdewa3uo49ieggq8xxxx",
    connection_timeout=60,
    description="CLBNLBListenerDemo description",
    enabled=True,
    listener_name="CLBNLBListenerDemo",
    tags=[{
        "key": "env",
        "value": "Test",
    }])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/clb"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := clb.NewNlbListener(ctx, "CLBNLBListenerDemo", &clb.NlbListenerArgs{
			LoadBalancerId:    pulumi.String("nlb-11zz9w3jqptz449iegfwvxxxx"),
			Protocol:          pulumi.String("TCP"),
			Port:              pulumi.Int(0),
			ServerGroupId:     pulumi.String("rsp-11zz9wdewa3uo49ieggq8xxxx"),
			ConnectionTimeout: pulumi.Int(60),
			Description:       pulumi.String("CLBNLBListenerDemo description"),
			Enabled:           pulumi.Bool(true),
			ListenerName:      pulumi.String("CLBNLBListenerDemo"),
			Tags: clb.NlbListenerTagArray{
				&clb.NlbListenerTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("Test"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var cLBNLBListenerDemo = new Volcenginecc.Clb.NlbListener("CLBNLBListenerDemo", new()
    {
        LoadBalancerId = "nlb-11zz9w3jqptz449iegfwvxxxx",
        Protocol = "TCP",
        Port = 0,
        ServerGroupId = "rsp-11zz9wdewa3uo49ieggq8xxxx",
        ConnectionTimeout = 60,
        Description = "CLBNLBListenerDemo description",
        Enabled = true,
        ListenerName = "CLBNLBListenerDemo",
        Tags = new[]
        {
            new Volcenginecc.Clb.Inputs.NlbListenerTagArgs
            {
                Key = "env",
                Value = "Test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.clb.NlbListener;
import com.volcengine.volcenginecc.clb.NlbListenerArgs;
import com.pulumi.volcenginecc.clb.inputs.NlbListenerTagArgs;
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 cLBNLBListenerDemo = new NlbListener("cLBNLBListenerDemo", NlbListenerArgs.builder()
            .loadBalancerId("nlb-11zz9w3jqptz449iegfwvxxxx")
            .protocol("TCP")
            .port(0)
            .serverGroupId("rsp-11zz9wdewa3uo49ieggq8xxxx")
            .connectionTimeout(60)
            .description("CLBNLBListenerDemo description")
            .enabled(true)
            .listenerName("CLBNLBListenerDemo")
            .tags(NlbListenerTagArgs.builder()
                .key("env")
                .value("Test")
                .build())
            .build());

    }
}

    resources:
  cLBNLBListenerDemo:
    type: volcenginecc:clb:NlbListener
    name: CLBNLBListenerDemo
    properties:
      loadBalancerId: nlb-11zz9w3jqptz449iegfwvxxxx
      protocol: TCP
      port: 0
      serverGroupId: rsp-11zz9wdewa3uo49ieggq8xxxx
      connectionTimeout: 60
      description: CLBNLBListenerDemo description
      enabled: true
      listenerName: CLBNLBListenerDemo
      tags:
        - key: env
          value: Test

    Create NlbListener Resource

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

    Constructor syntax

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

@overload
def NlbListener(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                load_balancer_id: Optional[str] = None,
                server_group_id: Optional[str] = None,
                protocol: Optional[str] = None,
                port: Optional[int] = None,
                enabled: Optional[bool] = None,
                healths: Optional[Sequence[NlbListenerHealthArgs]] = None,
                listener_name: Optional[str] = None,
                end_port: Optional[int] = None,
                certificate_id: Optional[str] = None,
                description: Optional[str] = None,
                security_policy_id: Optional[str] = None,
                connection_timeout: Optional[int] = None,
                start_port: Optional[int] = None,
                tags: Optional[Sequence[NlbListenerTagArgs]] = None)
    func NewNlbListener(ctx *Context, name string, args NlbListenerArgs, opts ...ResourceOption) (*NlbListener, error)
    public NlbListener(string name, NlbListenerArgs args, CustomResourceOptions? opts = null)
    public NlbListener(String name, NlbListenerArgs args)
public NlbListener(String name, NlbListenerArgs args, CustomResourceOptions options)

    type: volcenginecc:clb:NlbListener
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 NlbListenerArgs
    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 NlbListenerArgs
    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 NlbListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NlbListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NlbListenerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    LoadBalancerId string
    Load balancer instance ID
    Port int
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    Protocol string
    Listener protocol type: TCP, UDP, TLS
    ServerGroupId string
    Server group ID associated with the listener
    CertificateId string
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    ConnectionTimeout int
    Listener connection timeout (seconds)
    Description string
    Listener description
    Enabled bool
    Listener enabled: true (enabled); false (disabled)
    EndPort int
    End port for all-port listening. Valid only when Port is 0.
    Healths List<Volcengine.NlbListenerHealth>
    ListenerName string
    Listener name
    SecurityPolicyId string
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    StartPort int
    Start port for all-port listening. Valid only when Port is 0.
    Tags List<Volcengine.NlbListenerTag>
    LoadBalancerId string
    Load balancer instance ID
    Port int
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    Protocol string
    Listener protocol type: TCP, UDP, TLS
    ServerGroupId string
    Server group ID associated with the listener
    CertificateId string
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    ConnectionTimeout int
    Listener connection timeout (seconds)
    Description string
    Listener description
    Enabled bool
    Listener enabled: true (enabled); false (disabled)
    EndPort int
    End port for all-port listening. Valid only when Port is 0.
    Healths []NlbListenerHealthArgs
    ListenerName string
    Listener name
    SecurityPolicyId string
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    StartPort int
    Start port for all-port listening. Valid only when Port is 0.
    Tags []NlbListenerTagArgs
    loadBalancerId String
    Load balancer instance ID
    port Integer
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol String
    Listener protocol type: TCP, UDP, TLS
    serverGroupId String
    Server group ID associated with the listener
    certificateId String
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connectionTimeout Integer
    Listener connection timeout (seconds)
    description String
    Listener description
    enabled Boolean
    Listener enabled: true (enabled); false (disabled)
    endPort Integer
    End port for all-port listening. Valid only when Port is 0.
    healths List<NlbListenerHealth>
    listenerName String
    Listener name
    securityPolicyId String
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    startPort Integer
    Start port for all-port listening. Valid only when Port is 0.
    tags List<NlbListenerTag>
    loadBalancerId string
    Load balancer instance ID
    port number
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol string
    Listener protocol type: TCP, UDP, TLS
    serverGroupId string
    Server group ID associated with the listener
    certificateId string
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connectionTimeout number
    Listener connection timeout (seconds)
    description string
    Listener description
    enabled boolean
    Listener enabled: true (enabled); false (disabled)
    endPort number
    End port for all-port listening. Valid only when Port is 0.
    healths NlbListenerHealth[]
    listenerName string
    Listener name
    securityPolicyId string
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    startPort number
    Start port for all-port listening. Valid only when Port is 0.
    tags NlbListenerTag[]
    load_balancer_id str
    Load balancer instance ID
    port int
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol str
    Listener protocol type: TCP, UDP, TLS
    server_group_id str
    Server group ID associated with the listener
    certificate_id str
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connection_timeout int
    Listener connection timeout (seconds)
    description str
    Listener description
    enabled bool
    Listener enabled: true (enabled); false (disabled)
    end_port int
    End port for all-port listening. Valid only when Port is 0.
    healths Sequence[NlbListenerHealthArgs]
    listener_name str
    Listener name
    security_policy_id str
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    start_port int
    Start port for all-port listening. Valid only when Port is 0.
    tags Sequence[NlbListenerTagArgs]
    loadBalancerId String
    Load balancer instance ID
    port Number
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol String
    Listener protocol type: TCP, UDP, TLS
    serverGroupId String
    Server group ID associated with the listener
    certificateId String
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connectionTimeout Number
    Listener connection timeout (seconds)
    description String
    Listener description
    enabled Boolean
    Listener enabled: true (enabled); false (disabled)
    endPort Number
    End port for all-port listening. Valid only when Port is 0.
    healths List<Property Map>
    listenerName String
    Listener name
    securityPolicyId String
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    startPort Number
    Start port for all-port listening. Valid only when Port is 0.
    tags List<Property Map>

    Outputs

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

    CreatedTime string
    Listener creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    Listener unique identifier
    Status string
    Listener status
    UpdatedTime string
    Listener's most recent operation time
    CreatedTime string
    Listener creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    Listener unique identifier
    Status string
    Listener status
    UpdatedTime string
    Listener's most recent operation time
    createdTime String
    Listener creation time
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    Listener unique identifier
    status String
    Listener status
    updatedTime String
    Listener's most recent operation time
    createdTime string
    Listener creation time
    id string
    The provider-assigned unique ID for this managed resource.
    listenerId string
    Listener unique identifier
    status string
    Listener status
    updatedTime string
    Listener's most recent operation time
    created_time str
    Listener creation time
    id str
    The provider-assigned unique ID for this managed resource.
    listener_id str
    Listener unique identifier
    status str
    Listener status
    updated_time str
    Listener's most recent operation time
    createdTime String
    Listener creation time
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    Listener unique identifier
    status String
    Listener status
    updatedTime String
    Listener's most recent operation time

    Look up Existing NlbListener Resource

    Get an existing NlbListener 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?: NlbListenerState, opts?: CustomResourceOptions): NlbListener
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_id: Optional[str] = None,
        connection_timeout: Optional[int] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        end_port: Optional[int] = None,
        healths: Optional[Sequence[NlbListenerHealthArgs]] = None,
        listener_id: Optional[str] = None,
        listener_name: Optional[str] = None,
        load_balancer_id: Optional[str] = None,
        port: Optional[int] = None,
        protocol: Optional[str] = None,
        security_policy_id: Optional[str] = None,
        server_group_id: Optional[str] = None,
        start_port: Optional[int] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[NlbListenerTagArgs]] = None,
        updated_time: Optional[str] = None) -> NlbListener
    func GetNlbListener(ctx *Context, name string, id IDInput, state *NlbListenerState, opts ...ResourceOption) (*NlbListener, error)
    public static NlbListener Get(string name, Input<string> id, NlbListenerState? state, CustomResourceOptions? opts = null)
    public static NlbListener get(String name, Output<String> id, NlbListenerState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:clb:NlbListener    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:
    CertificateId string
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    ConnectionTimeout int
    Listener connection timeout (seconds)
    CreatedTime string
    Listener creation time
    Description string
    Listener description
    Enabled bool
    Listener enabled: true (enabled); false (disabled)
    EndPort int
    End port for all-port listening. Valid only when Port is 0.
    Healths List<Volcengine.NlbListenerHealth>
    ListenerId string
    Listener unique identifier
    ListenerName string
    Listener name
    LoadBalancerId string
    Load balancer instance ID
    Port int
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    Protocol string
    Listener protocol type: TCP, UDP, TLS
    SecurityPolicyId string
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    ServerGroupId string
    Server group ID associated with the listener
    StartPort int
    Start port for all-port listening. Valid only when Port is 0.
    Status string
    Listener status
    Tags List<Volcengine.NlbListenerTag>
    UpdatedTime string
    Listener's most recent operation time
    CertificateId string
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    ConnectionTimeout int
    Listener connection timeout (seconds)
    CreatedTime string
    Listener creation time
    Description string
    Listener description
    Enabled bool
    Listener enabled: true (enabled); false (disabled)
    EndPort int
    End port for all-port listening. Valid only when Port is 0.
    Healths []NlbListenerHealthArgs
    ListenerId string
    Listener unique identifier
    ListenerName string
    Listener name
    LoadBalancerId string
    Load balancer instance ID
    Port int
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    Protocol string
    Listener protocol type: TCP, UDP, TLS
    SecurityPolicyId string
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    ServerGroupId string
    Server group ID associated with the listener
    StartPort int
    Start port for all-port listening. Valid only when Port is 0.
    Status string
    Listener status
    Tags []NlbListenerTagArgs
    UpdatedTime string
    Listener's most recent operation time
    certificateId String
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connectionTimeout Integer
    Listener connection timeout (seconds)
    createdTime String
    Listener creation time
    description String
    Listener description
    enabled Boolean
    Listener enabled: true (enabled); false (disabled)
    endPort Integer
    End port for all-port listening. Valid only when Port is 0.
    healths List<NlbListenerHealth>
    listenerId String
    Listener unique identifier
    listenerName String
    Listener name
    loadBalancerId String
    Load balancer instance ID
    port Integer
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol String
    Listener protocol type: TCP, UDP, TLS
    securityPolicyId String
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    serverGroupId String
    Server group ID associated with the listener
    startPort Integer
    Start port for all-port listening. Valid only when Port is 0.
    status String
    Listener status
    tags List<NlbListenerTag>
    updatedTime String
    Listener's most recent operation time
    certificateId string
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connectionTimeout number
    Listener connection timeout (seconds)
    createdTime string
    Listener creation time
    description string
    Listener description
    enabled boolean
    Listener enabled: true (enabled); false (disabled)
    endPort number
    End port for all-port listening. Valid only when Port is 0.
    healths NlbListenerHealth[]
    listenerId string
    Listener unique identifier
    listenerName string
    Listener name
    loadBalancerId string
    Load balancer instance ID
    port number
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol string
    Listener protocol type: TCP, UDP, TLS
    securityPolicyId string
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    serverGroupId string
    Server group ID associated with the listener
    startPort number
    Start port for all-port listening. Valid only when Port is 0.
    status string
    Listener status
    tags NlbListenerTag[]
    updatedTime string
    Listener's most recent operation time
    certificate_id str
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connection_timeout int
    Listener connection timeout (seconds)
    created_time str
    Listener creation time
    description str
    Listener description
    enabled bool
    Listener enabled: true (enabled); false (disabled)
    end_port int
    End port for all-port listening. Valid only when Port is 0.
    healths Sequence[NlbListenerHealthArgs]
    listener_id str
    Listener unique identifier
    listener_name str
    Listener name
    load_balancer_id str
    Load balancer instance ID
    port int
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol str
    Listener protocol type: TCP, UDP, TLS
    security_policy_id str
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    server_group_id str
    Server group ID associated with the listener
    start_port int
    Start port for all-port listening. Valid only when Port is 0.
    status str
    Listener status
    tags Sequence[NlbListenerTagArgs]
    updated_time str
    Listener's most recent operation time
    certificateId String
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connectionTimeout Number
    Listener connection timeout (seconds)
    createdTime String
    Listener creation time
    description String
    Listener description
    enabled Boolean
    Listener enabled: true (enabled); false (disabled)
    endPort Number
    End port for all-port listening. Valid only when Port is 0.
    healths List<Property Map>
    listenerId String
    Listener unique identifier
    listenerName String
    Listener name
    loadBalancerId String
    Load balancer instance ID
    port Number
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol String
    Listener protocol type: TCP, UDP, TLS
    securityPolicyId String
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    serverGroupId String
    Server group ID associated with the listener
    startPort Number
    Start port for all-port listening. Valid only when Port is 0.
    status String
    Listener status
    tags List<Property Map>
    updatedTime String
    Listener's most recent operation time

    Supporting Types

    NlbListenerHealth, NlbListenerHealthArgs

    InstanceId string
    Backend server instance ID or IP address
    Ip string
    Backend server IP address
    Port int
    Port on which the backend server provides services
    ServerId string
    Backend server ID
    ServerType string
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    Status string
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    UpdatedTime string
    Last update time of health status
    ZoneId string
    Zone ID where the backend server receives traffic
    InstanceId string
    Backend server instance ID or IP address
    Ip string
    Backend server IP address
    Port int
    Port on which the backend server provides services
    ServerId string
    Backend server ID
    ServerType string
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    Status string
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    UpdatedTime string
    Last update time of health status
    ZoneId string
    Zone ID where the backend server receives traffic
    instanceId String
    Backend server instance ID or IP address
    ip String
    Backend server IP address
    port Integer
    Port on which the backend server provides services
    serverId String
    Backend server ID
    serverType String
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    status String
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    updatedTime String
    Last update time of health status
    zoneId String
    Zone ID where the backend server receives traffic
    instanceId string
    Backend server instance ID or IP address
    ip string
    Backend server IP address
    port number
    Port on which the backend server provides services
    serverId string
    Backend server ID
    serverType string
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    status string
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    updatedTime string
    Last update time of health status
    zoneId string
    Zone ID where the backend server receives traffic
    instance_id str
    Backend server instance ID or IP address
    ip str
    Backend server IP address
    port int
    Port on which the backend server provides services
    server_id str
    Backend server ID
    server_type str
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    status str
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    updated_time str
    Last update time of health status
    zone_id str
    Zone ID where the backend server receives traffic
    instanceId String
    Backend server instance ID or IP address
    ip String
    Backend server IP address
    port Number
    Port on which the backend server provides services
    serverId String
    Backend server ID
    serverType String
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    status String
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    updatedTime String
    Last update time of health status
    zoneId String
    Zone ID where the backend server receives traffic

    NlbListenerTag, NlbListenerTagArgs

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Import

    $ pulumi import volcenginecc:clb/nlbListener:NlbListener example "listener_id"

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.