Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. clb
  5. Listener
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.clb.Listener

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage listener

    Example Usage

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

const fooZones = volcengine.ecs.Zones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const fooClb = new volcengine.clb.Clb("fooClb", {
    type: "public",
    subnetId: fooSubnet.id,
    loadBalancerSpec: "small_1",
    description: "acc0Demo",
    loadBalancerName: "acc-test-create",
    eipBillingConfig: {
        isp: "BGP",
        eipBillingType: "PostPaidByBandwidth",
        bandwidth: 1,
    },
});
const fooServerGroup = new volcengine.clb.ServerGroup("fooServerGroup", {
    loadBalancerId: fooClb.id,
    serverGroupName: "acc-test-create",
    description: "hello demo11",
});
const fooListener = new volcengine.clb.Listener("fooListener", {
    loadBalancerId: fooClb.id,
    listenerName: "acc-test-listener",
    protocol: "HTTP",
    port: 90,
    serverGroupId: fooServerGroup.id,
    healthCheck: {
        enabled: "on",
        interval: 10,
        timeout: 3,
        healthyThreshold: 5,
        unHealthyThreshold: 2,
        domain: "volcengine.com",
        httpCode: "http_2xx",
        method: "GET",
        uri: "/",
    },
    enabled: "on",
});
const fooTcp = new volcengine.clb.Listener("fooTcp", {
    loadBalancerId: fooClb.id,
    listenerName: "acc-test-listener",
    protocol: "TCP",
    port: 90,
    serverGroupId: fooServerGroup.id,
    enabled: "on",
    bandwidth: 2,
    proxyProtocolType: "standard",
    persistenceType: "source_ip",
    persistenceTimeout: 100,
    connectionDrainEnabled: "on",
    connectionDrainTimeout: 100,
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_clb = volcengine.clb.Clb("fooClb",
    type="public",
    subnet_id=foo_subnet.id,
    load_balancer_spec="small_1",
    description="acc0Demo",
    load_balancer_name="acc-test-create",
    eip_billing_config=volcengine.clb.ClbEipBillingConfigArgs(
        isp="BGP",
        eip_billing_type="PostPaidByBandwidth",
        bandwidth=1,
    ))
foo_server_group = volcengine.clb.ServerGroup("fooServerGroup",
    load_balancer_id=foo_clb.id,
    server_group_name="acc-test-create",
    description="hello demo11")
foo_listener = volcengine.clb.Listener("fooListener",
    load_balancer_id=foo_clb.id,
    listener_name="acc-test-listener",
    protocol="HTTP",
    port=90,
    server_group_id=foo_server_group.id,
    health_check=volcengine.clb.ListenerHealthCheckArgs(
        enabled="on",
        interval=10,
        timeout=3,
        healthy_threshold=5,
        un_healthy_threshold=2,
        domain="volcengine.com",
        http_code="http_2xx",
        method="GET",
        uri="/",
    ),
    enabled="on")
foo_tcp = volcengine.clb.Listener("fooTcp",
    load_balancer_id=foo_clb.id,
    listener_name="acc-test-listener",
    protocol="TCP",
    port=90,
    server_group_id=foo_server_group.id,
    enabled="on",
    bandwidth=2,
    proxy_protocol_type="standard",
    persistence_type="source_ip",
    persistence_timeout=100,
    connection_drain_enabled="on",
    connection_drain_timeout=100)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.Zones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooClb, err := clb.NewClb(ctx, "fooClb", &clb.ClbArgs{
			Type:             pulumi.String("public"),
			SubnetId:         fooSubnet.ID(),
			LoadBalancerSpec: pulumi.String("small_1"),
			Description:      pulumi.String("acc0Demo"),
			LoadBalancerName: pulumi.String("acc-test-create"),
			EipBillingConfig: &clb.ClbEipBillingConfigArgs{
				Isp:            pulumi.String("BGP"),
				EipBillingType: pulumi.String("PostPaidByBandwidth"),
				Bandwidth:      pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		fooServerGroup, err := clb.NewServerGroup(ctx, "fooServerGroup", &clb.ServerGroupArgs{
			LoadBalancerId:  fooClb.ID(),
			ServerGroupName: pulumi.String("acc-test-create"),
			Description:     pulumi.String("hello demo11"),
		})
		if err != nil {
			return err
		}
		_, err = clb.NewListener(ctx, "fooListener", &clb.ListenerArgs{
			LoadBalancerId: fooClb.ID(),
			ListenerName:   pulumi.String("acc-test-listener"),
			Protocol:       pulumi.String("HTTP"),
			Port:           pulumi.Int(90),
			ServerGroupId:  fooServerGroup.ID(),
			HealthCheck: &clb.ListenerHealthCheckArgs{
				Enabled:            pulumi.String("on"),
				Interval:           pulumi.Int(10),
				Timeout:            pulumi.Int(3),
				HealthyThreshold:   pulumi.Int(5),
				UnHealthyThreshold: pulumi.Int(2),
				Domain:             pulumi.String("volcengine.com"),
				HttpCode:           pulumi.String("http_2xx"),
				Method:             pulumi.String("GET"),
				Uri:                pulumi.String("/"),
			},
			Enabled: pulumi.String("on"),
		})
		if err != nil {
			return err
		}
		_, err = clb.NewListener(ctx, "fooTcp", &clb.ListenerArgs{
			LoadBalancerId:         fooClb.ID(),
			ListenerName:           pulumi.String("acc-test-listener"),
			Protocol:               pulumi.String("TCP"),
			Port:                   pulumi.Int(90),
			ServerGroupId:          fooServerGroup.ID(),
			Enabled:                pulumi.String("on"),
			Bandwidth:              pulumi.Int(2),
			ProxyProtocolType:      pulumi.String("standard"),
			PersistenceType:        pulumi.String("source_ip"),
			PersistenceTimeout:     pulumi.Int(100),
			ConnectionDrainEnabled: pulumi.String("on"),
			ConnectionDrainTimeout: pulumi.Int(100),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.Zones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooClb = new Volcengine.Clb.Clb("fooClb", new()
    {
        Type = "public",
        SubnetId = fooSubnet.Id,
        LoadBalancerSpec = "small_1",
        Description = "acc0Demo",
        LoadBalancerName = "acc-test-create",
        EipBillingConfig = new Volcengine.Clb.Inputs.ClbEipBillingConfigArgs
        {
            Isp = "BGP",
            EipBillingType = "PostPaidByBandwidth",
            Bandwidth = 1,
        },
    });

    var fooServerGroup = new Volcengine.Clb.ServerGroup("fooServerGroup", new()
    {
        LoadBalancerId = fooClb.Id,
        ServerGroupName = "acc-test-create",
        Description = "hello demo11",
    });

    var fooListener = new Volcengine.Clb.Listener("fooListener", new()
    {
        LoadBalancerId = fooClb.Id,
        ListenerName = "acc-test-listener",
        Protocol = "HTTP",
        Port = 90,
        ServerGroupId = fooServerGroup.Id,
        HealthCheck = new Volcengine.Clb.Inputs.ListenerHealthCheckArgs
        {
            Enabled = "on",
            Interval = 10,
            Timeout = 3,
            HealthyThreshold = 5,
            UnHealthyThreshold = 2,
            Domain = "volcengine.com",
            HttpCode = "http_2xx",
            Method = "GET",
            Uri = "/",
        },
        Enabled = "on",
    });

    var fooTcp = new Volcengine.Clb.Listener("fooTcp", new()
    {
        LoadBalancerId = fooClb.Id,
        ListenerName = "acc-test-listener",
        Protocol = "TCP",
        Port = 90,
        ServerGroupId = fooServerGroup.Id,
        Enabled = "on",
        Bandwidth = 2,
        ProxyProtocolType = "standard",
        PersistenceType = "source_ip",
        PersistenceTimeout = 100,
        ConnectionDrainEnabled = "on",
        ConnectionDrainTimeout = 100,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.clb.Clb;
import com.pulumi.volcengine.clb.ClbArgs;
import com.pulumi.volcengine.clb.inputs.ClbEipBillingConfigArgs;
import com.pulumi.volcengine.clb.ServerGroup;
import com.pulumi.volcengine.clb.ServerGroupArgs;
import com.pulumi.volcengine.clb.Listener;
import com.pulumi.volcengine.clb.ListenerArgs;
import com.pulumi.volcengine.clb.inputs.ListenerHealthCheckArgs;
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 fooZones = EcsFunctions.Zones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooClb = new Clb("fooClb", ClbArgs.builder()        
            .type("public")
            .subnetId(fooSubnet.id())
            .loadBalancerSpec("small_1")
            .description("acc0Demo")
            .loadBalancerName("acc-test-create")
            .eipBillingConfig(ClbEipBillingConfigArgs.builder()
                .isp("BGP")
                .eipBillingType("PostPaidByBandwidth")
                .bandwidth(1)
                .build())
            .build());

        var fooServerGroup = new ServerGroup("fooServerGroup", ServerGroupArgs.builder()        
            .loadBalancerId(fooClb.id())
            .serverGroupName("acc-test-create")
            .description("hello demo11")
            .build());

        var fooListener = new Listener("fooListener", ListenerArgs.builder()        
            .loadBalancerId(fooClb.id())
            .listenerName("acc-test-listener")
            .protocol("HTTP")
            .port(90)
            .serverGroupId(fooServerGroup.id())
            .healthCheck(ListenerHealthCheckArgs.builder()
                .enabled("on")
                .interval(10)
                .timeout(3)
                .healthyThreshold(5)
                .unHealthyThreshold(2)
                .domain("volcengine.com")
                .httpCode("http_2xx")
                .method("GET")
                .uri("/")
                .build())
            .enabled("on")
            .build());

        var fooTcp = new Listener("fooTcp", ListenerArgs.builder()        
            .loadBalancerId(fooClb.id())
            .listenerName("acc-test-listener")
            .protocol("TCP")
            .port(90)
            .serverGroupId(fooServerGroup.id())
            .enabled("on")
            .bandwidth(2)
            .proxyProtocolType("standard")
            .persistenceType("source_ip")
            .persistenceTimeout(100)
            .connectionDrainEnabled("on")
            .connectionDrainTimeout(100)
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooClb:
    type: volcengine:clb:Clb
    properties:
      type: public
      subnetId: ${fooSubnet.id}
      loadBalancerSpec: small_1
      description: acc0Demo
      loadBalancerName: acc-test-create
      eipBillingConfig:
        isp: BGP
        eipBillingType: PostPaidByBandwidth
        bandwidth: 1
  fooServerGroup:
    type: volcengine:clb:ServerGroup
    properties:
      loadBalancerId: ${fooClb.id}
      serverGroupName: acc-test-create
      description: hello demo11
  fooListener:
    type: volcengine:clb:Listener
    properties:
      loadBalancerId: ${fooClb.id}
      listenerName: acc-test-listener
      protocol: HTTP
      port: 90
      serverGroupId: ${fooServerGroup.id}
      healthCheck:
        enabled: on
        interval: 10
        timeout: 3
        healthyThreshold: 5
        unHealthyThreshold: 2
        domain: volcengine.com
        httpCode: http_2xx
        method: GET
        uri: /
      enabled: on
  fooTcp:
    type: volcengine:clb:Listener
    properties:
      loadBalancerId: ${fooClb.id}
      listenerName: acc-test-listener
      protocol: TCP
      port: 90
      serverGroupId: ${fooServerGroup.id}
      enabled: on
      bandwidth: 2
      proxyProtocolType: standard
      persistenceType: source_ip
      persistenceTimeout: 100
      connectionDrainEnabled: on
      connectionDrainTimeout: 100
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:Zones
      Arguments: {}

    Create Listener Resource

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

    Constructor syntax

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

@overload
def Listener(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,
             established_timeout: Optional[int] = None,
             certificate_id: Optional[str] = None,
             connection_drain_timeout: Optional[int] = None,
             cookie: Optional[str] = None,
             description: Optional[str] = None,
             enabled: Optional[str] = None,
             acl_ids: Optional[Sequence[str]] = None,
             health_check: Optional[ListenerHealthCheckArgs] = None,
             listener_name: Optional[str] = None,
             connection_drain_enabled: Optional[str] = None,
             persistence_timeout: Optional[int] = None,
             persistence_type: Optional[str] = None,
             bandwidth: Optional[int] = None,
             acl_type: Optional[str] = None,
             proxy_protocol_type: Optional[str] = None,
             scheduler: Optional[str] = None,
             acl_status: Optional[str] = None)
    func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)
    public Listener(string name, ListenerArgs args, CustomResourceOptions? opts = null)
    public Listener(String name, ListenerArgs args)
public Listener(String name, ListenerArgs args, CustomResourceOptions options)

    type: volcengine:clb:Listener
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 ListenerArgs
    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 ListenerArgs
    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 ListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ListenerArgs
    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 volcengineListenerResource = new Volcengine.Clb.Listener("volcengineListenerResource", new()
{
    LoadBalancerId = "string",
    ServerGroupId = "string",
    Protocol = "string",
    Port = 0,
    EstablishedTimeout = 0,
    CertificateId = "string",
    ConnectionDrainTimeout = 0,
    Cookie = "string",
    Description = "string",
    Enabled = "string",
    AclIds = new[]
    {
        "string",
    },
    HealthCheck = new Volcengine.Clb.Inputs.ListenerHealthCheckArgs
    {
        Domain = "string",
        Enabled = "string",
        HealthyThreshold = 0,
        HttpCode = "string",
        Interval = 0,
        Method = "string",
        Timeout = 0,
        UdpExpect = "string",
        UdpRequest = "string",
        UnHealthyThreshold = 0,
        Uri = "string",
    },
    ListenerName = "string",
    ConnectionDrainEnabled = "string",
    PersistenceTimeout = 0,
    PersistenceType = "string",
    Bandwidth = 0,
    AclType = "string",
    ProxyProtocolType = "string",
    Scheduler = "string",
    AclStatus = "string",
});

    example, err := clb.NewListener(ctx, "volcengineListenerResource", &clb.ListenerArgs{
	LoadBalancerId:         pulumi.String("string"),
	ServerGroupId:          pulumi.String("string"),
	Protocol:               pulumi.String("string"),
	Port:                   pulumi.Int(0),
	EstablishedTimeout:     pulumi.Int(0),
	CertificateId:          pulumi.String("string"),
	ConnectionDrainTimeout: pulumi.Int(0),
	Cookie:                 pulumi.String("string"),
	Description:            pulumi.String("string"),
	Enabled:                pulumi.String("string"),
	AclIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	HealthCheck: &clb.ListenerHealthCheckArgs{
		Domain:             pulumi.String("string"),
		Enabled:            pulumi.String("string"),
		HealthyThreshold:   pulumi.Int(0),
		HttpCode:           pulumi.String("string"),
		Interval:           pulumi.Int(0),
		Method:             pulumi.String("string"),
		Timeout:            pulumi.Int(0),
		UdpExpect:          pulumi.String("string"),
		UdpRequest:         pulumi.String("string"),
		UnHealthyThreshold: pulumi.Int(0),
		Uri:                pulumi.String("string"),
	},
	ListenerName:           pulumi.String("string"),
	ConnectionDrainEnabled: pulumi.String("string"),
	PersistenceTimeout:     pulumi.Int(0),
	PersistenceType:        pulumi.String("string"),
	Bandwidth:              pulumi.Int(0),
	AclType:                pulumi.String("string"),
	ProxyProtocolType:      pulumi.String("string"),
	Scheduler:              pulumi.String("string"),
	AclStatus:              pulumi.String("string"),
})

    var volcengineListenerResource = new Listener("volcengineListenerResource", ListenerArgs.builder()
    .loadBalancerId("string")
    .serverGroupId("string")
    .protocol("string")
    .port(0)
    .establishedTimeout(0)
    .certificateId("string")
    .connectionDrainTimeout(0)
    .cookie("string")
    .description("string")
    .enabled("string")
    .aclIds("string")
    .healthCheck(ListenerHealthCheckArgs.builder()
        .domain("string")
        .enabled("string")
        .healthyThreshold(0)
        .httpCode("string")
        .interval(0)
        .method("string")
        .timeout(0)
        .udpExpect("string")
        .udpRequest("string")
        .unHealthyThreshold(0)
        .uri("string")
        .build())
    .listenerName("string")
    .connectionDrainEnabled("string")
    .persistenceTimeout(0)
    .persistenceType("string")
    .bandwidth(0)
    .aclType("string")
    .proxyProtocolType("string")
    .scheduler("string")
    .aclStatus("string")
    .build());

    volcengine_listener_resource = volcengine.clb.Listener("volcengineListenerResource",
    load_balancer_id="string",
    server_group_id="string",
    protocol="string",
    port=0,
    established_timeout=0,
    certificate_id="string",
    connection_drain_timeout=0,
    cookie="string",
    description="string",
    enabled="string",
    acl_ids=["string"],
    health_check={
        "domain": "string",
        "enabled": "string",
        "healthy_threshold": 0,
        "http_code": "string",
        "interval": 0,
        "method": "string",
        "timeout": 0,
        "udp_expect": "string",
        "udp_request": "string",
        "un_healthy_threshold": 0,
        "uri": "string",
    },
    listener_name="string",
    connection_drain_enabled="string",
    persistence_timeout=0,
    persistence_type="string",
    bandwidth=0,
    acl_type="string",
    proxy_protocol_type="string",
    scheduler="string",
    acl_status="string")

    const volcengineListenerResource = new volcengine.clb.Listener("volcengineListenerResource", {
    loadBalancerId: "string",
    serverGroupId: "string",
    protocol: "string",
    port: 0,
    establishedTimeout: 0,
    certificateId: "string",
    connectionDrainTimeout: 0,
    cookie: "string",
    description: "string",
    enabled: "string",
    aclIds: ["string"],
    healthCheck: {
        domain: "string",
        enabled: "string",
        healthyThreshold: 0,
        httpCode: "string",
        interval: 0,
        method: "string",
        timeout: 0,
        udpExpect: "string",
        udpRequest: "string",
        unHealthyThreshold: 0,
        uri: "string",
    },
    listenerName: "string",
    connectionDrainEnabled: "string",
    persistenceTimeout: 0,
    persistenceType: "string",
    bandwidth: 0,
    aclType: "string",
    proxyProtocolType: "string",
    scheduler: "string",
    aclStatus: "string",
});

    type: volcengine:clb:Listener
properties:
    aclIds:
        - string
    aclStatus: string
    aclType: string
    bandwidth: 0
    certificateId: string
    connectionDrainEnabled: string
    connectionDrainTimeout: 0
    cookie: string
    description: string
    enabled: string
    establishedTimeout: 0
    healthCheck:
        domain: string
        enabled: string
        healthyThreshold: 0
        httpCode: string
        interval: 0
        method: string
        timeout: 0
        udpExpect: string
        udpRequest: string
        unHealthyThreshold: 0
        uri: string
    listenerName: string
    loadBalancerId: string
    persistenceTimeout: 0
    persistenceType: string
    port: 0
    protocol: string
    proxyProtocolType: string
    scheduler: string
    serverGroupId: string

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

    LoadBalancerId string
    The region of the request.
    Port int
    The port receiving request of the Listener, the value range in 1~65535.
    Protocol string
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    ServerGroupId string
    The server group id associated with the listener.
    AclIds List<string>
    The id list of the Acl.
    AclStatus string
    The enable status of Acl. Optional choice contains on, off.
    AclType string
    The type of the Acl. Optional choice contains white, black.
    Bandwidth int
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    CertificateId string
    The certificate id associated with the listener.
    ConnectionDrainEnabled string
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    ConnectionDrainTimeout int
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    Cookie string
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    Description string
    The description of the Listener.
    Enabled string
    The enable status of the Listener. Optional choice contains on, off.
    EstablishedTimeout int
    The connection timeout of the Listener.
    HealthCheck ListenerHealthCheck
    The config of health check.
    ListenerName string
    The name of the Listener.
    PersistenceTimeout int
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    PersistenceType string
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    ProxyProtocolType string
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    Scheduler string
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    LoadBalancerId string
    The region of the request.
    Port int
    The port receiving request of the Listener, the value range in 1~65535.
    Protocol string
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    ServerGroupId string
    The server group id associated with the listener.
    AclIds []string
    The id list of the Acl.
    AclStatus string
    The enable status of Acl. Optional choice contains on, off.
    AclType string
    The type of the Acl. Optional choice contains white, black.
    Bandwidth int
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    CertificateId string
    The certificate id associated with the listener.
    ConnectionDrainEnabled string
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    ConnectionDrainTimeout int
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    Cookie string
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    Description string
    The description of the Listener.
    Enabled string
    The enable status of the Listener. Optional choice contains on, off.
    EstablishedTimeout int
    The connection timeout of the Listener.
    HealthCheck ListenerHealthCheckArgs
    The config of health check.
    ListenerName string
    The name of the Listener.
    PersistenceTimeout int
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    PersistenceType string
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    ProxyProtocolType string
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    Scheduler string
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    loadBalancerId String
    The region of the request.
    port Integer
    The port receiving request of the Listener, the value range in 1~65535.
    protocol String
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    serverGroupId String
    The server group id associated with the listener.
    aclIds List<String>
    The id list of the Acl.
    aclStatus String
    The enable status of Acl. Optional choice contains on, off.
    aclType String
    The type of the Acl. Optional choice contains white, black.
    bandwidth Integer
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    certificateId String
    The certificate id associated with the listener.
    connectionDrainEnabled String
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    connectionDrainTimeout Integer
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    cookie String
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    description String
    The description of the Listener.
    enabled String
    The enable status of the Listener. Optional choice contains on, off.
    establishedTimeout Integer
    The connection timeout of the Listener.
    healthCheck ListenerHealthCheck
    The config of health check.
    listenerName String
    The name of the Listener.
    persistenceTimeout Integer
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    persistenceType String
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    proxyProtocolType String
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    scheduler String
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    loadBalancerId string
    The region of the request.
    port number
    The port receiving request of the Listener, the value range in 1~65535.
    protocol string
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    serverGroupId string
    The server group id associated with the listener.
    aclIds string[]
    The id list of the Acl.
    aclStatus string
    The enable status of Acl. Optional choice contains on, off.
    aclType string
    The type of the Acl. Optional choice contains white, black.
    bandwidth number
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    certificateId string
    The certificate id associated with the listener.
    connectionDrainEnabled string
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    connectionDrainTimeout number
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    cookie string
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    description string
    The description of the Listener.
    enabled string
    The enable status of the Listener. Optional choice contains on, off.
    establishedTimeout number
    The connection timeout of the Listener.
    healthCheck ListenerHealthCheck
    The config of health check.
    listenerName string
    The name of the Listener.
    persistenceTimeout number
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    persistenceType string
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    proxyProtocolType string
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    scheduler string
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    load_balancer_id str
    The region of the request.
    port int
    The port receiving request of the Listener, the value range in 1~65535.
    protocol str
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    server_group_id str
    The server group id associated with the listener.
    acl_ids Sequence[str]
    The id list of the Acl.
    acl_status str
    The enable status of Acl. Optional choice contains on, off.
    acl_type str
    The type of the Acl. Optional choice contains white, black.
    bandwidth int
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    certificate_id str
    The certificate id associated with the listener.
    connection_drain_enabled str
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    connection_drain_timeout int
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    cookie str
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    description str
    The description of the Listener.
    enabled str
    The enable status of the Listener. Optional choice contains on, off.
    established_timeout int
    The connection timeout of the Listener.
    health_check ListenerHealthCheckArgs
    The config of health check.
    listener_name str
    The name of the Listener.
    persistence_timeout int
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    persistence_type str
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    proxy_protocol_type str
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    scheduler str
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    loadBalancerId String
    The region of the request.
    port Number
    The port receiving request of the Listener, the value range in 1~65535.
    protocol String
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    serverGroupId String
    The server group id associated with the listener.
    aclIds List<String>
    The id list of the Acl.
    aclStatus String
    The enable status of Acl. Optional choice contains on, off.
    aclType String
    The type of the Acl. Optional choice contains white, black.
    bandwidth Number
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    certificateId String
    The certificate id associated with the listener.
    connectionDrainEnabled String
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    connectionDrainTimeout Number
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    cookie String
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    description String
    The description of the Listener.
    enabled String
    The enable status of the Listener. Optional choice contains on, off.
    establishedTimeout Number
    The connection timeout of the Listener.
    healthCheck Property Map
    The config of health check.
    listenerName String
    The name of the Listener.
    persistenceTimeout Number
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    persistenceType String
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    proxyProtocolType String
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    scheduler String
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    The ID of the Listener.
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    The ID of the Listener.
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    The ID of the Listener.
    id string
    The provider-assigned unique ID for this managed resource.
    listenerId string
    The ID of the Listener.
    id str
    The provider-assigned unique ID for this managed resource.
    listener_id str
    The ID of the Listener.
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    The ID of the Listener.

    Look up Existing Listener Resource

    Get an existing Listener 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?: ListenerState, opts?: CustomResourceOptions): Listener
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl_ids: Optional[Sequence[str]] = None,
        acl_status: Optional[str] = None,
        acl_type: Optional[str] = None,
        bandwidth: Optional[int] = None,
        certificate_id: Optional[str] = None,
        connection_drain_enabled: Optional[str] = None,
        connection_drain_timeout: Optional[int] = None,
        cookie: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[str] = None,
        established_timeout: Optional[int] = None,
        health_check: Optional[ListenerHealthCheckArgs] = None,
        listener_id: Optional[str] = None,
        listener_name: Optional[str] = None,
        load_balancer_id: Optional[str] = None,
        persistence_timeout: Optional[int] = None,
        persistence_type: Optional[str] = None,
        port: Optional[int] = None,
        protocol: Optional[str] = None,
        proxy_protocol_type: Optional[str] = None,
        scheduler: Optional[str] = None,
        server_group_id: Optional[str] = None) -> Listener
    func GetListener(ctx *Context, name string, id IDInput, state *ListenerState, opts ...ResourceOption) (*Listener, error)
    public static Listener Get(string name, Input<string> id, ListenerState? state, CustomResourceOptions? opts = null)
    public static Listener get(String name, Output<String> id, ListenerState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:clb:Listener    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:
    AclIds List<string>
    The id list of the Acl.
    AclStatus string
    The enable status of Acl. Optional choice contains on, off.
    AclType string
    The type of the Acl. Optional choice contains white, black.
    Bandwidth int
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    CertificateId string
    The certificate id associated with the listener.
    ConnectionDrainEnabled string
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    ConnectionDrainTimeout int
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    Cookie string
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    Description string
    The description of the Listener.
    Enabled string
    The enable status of the Listener. Optional choice contains on, off.
    EstablishedTimeout int
    The connection timeout of the Listener.
    HealthCheck ListenerHealthCheck
    The config of health check.
    ListenerId string
    The ID of the Listener.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The region of the request.
    PersistenceTimeout int
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    PersistenceType string
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    Port int
    The port receiving request of the Listener, the value range in 1~65535.
    Protocol string
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    ProxyProtocolType string
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    Scheduler string
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    ServerGroupId string
    The server group id associated with the listener.
    AclIds []string
    The id list of the Acl.
    AclStatus string
    The enable status of Acl. Optional choice contains on, off.
    AclType string
    The type of the Acl. Optional choice contains white, black.
    Bandwidth int
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    CertificateId string
    The certificate id associated with the listener.
    ConnectionDrainEnabled string
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    ConnectionDrainTimeout int
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    Cookie string
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    Description string
    The description of the Listener.
    Enabled string
    The enable status of the Listener. Optional choice contains on, off.
    EstablishedTimeout int
    The connection timeout of the Listener.
    HealthCheck ListenerHealthCheckArgs
    The config of health check.
    ListenerId string
    The ID of the Listener.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The region of the request.
    PersistenceTimeout int
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    PersistenceType string
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    Port int
    The port receiving request of the Listener, the value range in 1~65535.
    Protocol string
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    ProxyProtocolType string
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    Scheduler string
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    ServerGroupId string
    The server group id associated with the listener.
    aclIds List<String>
    The id list of the Acl.
    aclStatus String
    The enable status of Acl. Optional choice contains on, off.
    aclType String
    The type of the Acl. Optional choice contains white, black.
    bandwidth Integer
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    certificateId String
    The certificate id associated with the listener.
    connectionDrainEnabled String
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    connectionDrainTimeout Integer
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    cookie String
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    description String
    The description of the Listener.
    enabled String
    The enable status of the Listener. Optional choice contains on, off.
    establishedTimeout Integer
    The connection timeout of the Listener.
    healthCheck ListenerHealthCheck
    The config of health check.
    listenerId String
    The ID of the Listener.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The region of the request.
    persistenceTimeout Integer
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    persistenceType String
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    port Integer
    The port receiving request of the Listener, the value range in 1~65535.
    protocol String
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    proxyProtocolType String
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    scheduler String
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    serverGroupId String
    The server group id associated with the listener.
    aclIds string[]
    The id list of the Acl.
    aclStatus string
    The enable status of Acl. Optional choice contains on, off.
    aclType string
    The type of the Acl. Optional choice contains white, black.
    bandwidth number
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    certificateId string
    The certificate id associated with the listener.
    connectionDrainEnabled string
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    connectionDrainTimeout number
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    cookie string
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    description string
    The description of the Listener.
    enabled string
    The enable status of the Listener. Optional choice contains on, off.
    establishedTimeout number
    The connection timeout of the Listener.
    healthCheck ListenerHealthCheck
    The config of health check.
    listenerId string
    The ID of the Listener.
    listenerName string
    The name of the Listener.
    loadBalancerId string
    The region of the request.
    persistenceTimeout number
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    persistenceType string
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    port number
    The port receiving request of the Listener, the value range in 1~65535.
    protocol string
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    proxyProtocolType string
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    scheduler string
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    serverGroupId string
    The server group id associated with the listener.
    acl_ids Sequence[str]
    The id list of the Acl.
    acl_status str
    The enable status of Acl. Optional choice contains on, off.
    acl_type str
    The type of the Acl. Optional choice contains white, black.
    bandwidth int
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    certificate_id str
    The certificate id associated with the listener.
    connection_drain_enabled str
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    connection_drain_timeout int
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    cookie str
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    description str
    The description of the Listener.
    enabled str
    The enable status of the Listener. Optional choice contains on, off.
    established_timeout int
    The connection timeout of the Listener.
    health_check ListenerHealthCheckArgs
    The config of health check.
    listener_id str
    The ID of the Listener.
    listener_name str
    The name of the Listener.
    load_balancer_id str
    The region of the request.
    persistence_timeout int
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    persistence_type str
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    port int
    The port receiving request of the Listener, the value range in 1~65535.
    protocol str
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    proxy_protocol_type str
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    scheduler str
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    server_group_id str
    The server group id associated with the listener.
    aclIds List<String>
    The id list of the Acl.
    aclStatus String
    The enable status of Acl. Optional choice contains on, off.
    aclType String
    The type of the Acl. Optional choice contains white, black.
    bandwidth Number
    The bandwidth of the Listener. Unit: Mbps. Default is -1, indicating that the Listener does not specify a speed limit.
    certificateId String
    The certificate id associated with the listener.
    connectionDrainEnabled String
    Whether to enable connection drain of the Listener. Valid values: off, on. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    connectionDrainTimeout Number
    The connection drain timeout of the Listener. Valid value range is 0-900. This filed is required when the value of field connection_drain_enabled is on.
    cookie String
    The name of the cookie for session persistence configured on the backend server. When PersistenceType is configured as server, this parameter is required. When PersistenceType is configured as any other value, this parameter is not effective.
    description String
    The description of the Listener.
    enabled String
    The enable status of the Listener. Optional choice contains on, off.
    establishedTimeout Number
    The connection timeout of the Listener.
    healthCheck Property Map
    The config of health check.
    listenerId String
    The ID of the Listener.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The region of the request.
    persistenceTimeout Number
    The persistence timeout of the Listener. Unit: second. Default is 1000. When PersistenceType is configured as source_ip, the value range is 1-3600. When PersistenceType is configured as insert, the value range is 1-86400. This filed is valid only when the value of field persistence_type is source_ip or insert.
    persistenceType String
    The persistence type of the Listener. Valid values: off, source_ip, insert, server. Default is off. source_ip: Represents the source IP address, only effective for TCP/UDP protocols. insert: means implanting a cookie, only effective for HTTP/HTTPS protocol and when the scheduler is wrr. server: Indicates rewriting cookies, only effective for HTTP/HTTPS protocols and when the scheduler is wrr.
    port Number
    The port receiving request of the Listener, the value range in 1~65535.
    protocol String
    The protocol of the Listener. Optional choice contains TCP, UDP, HTTP, HTTPS.
    proxyProtocolType String
    Whether to enable proxy protocol. Valid values: off, standard. Default is off. This filed is valid only when the value of field protocol is TCP or UDP.
    scheduler String
    The scheduling algorithm of the Listener. Optional choice contains wrr, wlc, sh.
    serverGroupId String
    The server group id associated with the listener.

    Supporting Types

    ListenerHealthCheck, ListenerHealthCheckArgs

    Domain string
    The domain of health check.
    Enabled string
    The enable status of health check function. Optional choice contains on, off.
    HealthyThreshold int
    The healthy threshold of health check, default 3, range in 2~10.
    HttpCode string
    The normal http status code of health check, the value can be http_2xx or http_3xx or http_4xx or http_5xx.
    Interval int
    The interval executing health check, default 2, range in 1~300.
    Method string
    The method of health check, the value can be GET or HEAD.
    Timeout int
    The response timeout of health check, default 2, range in 1~60..
    UdpExpect string
    The UDP expect of health check. This field must be specified simultaneously with field udp_request.
    UdpRequest string
    The UDP request of health check. This field must be specified simultaneously with field udp_expect.
    UnHealthyThreshold int
    The unhealthy threshold of health check, default 3, range in 2~10.
    Uri string
    The uri of health check.
    Domain string
    The domain of health check.
    Enabled string
    The enable status of health check function. Optional choice contains on, off.
    HealthyThreshold int
    The healthy threshold of health check, default 3, range in 2~10.
    HttpCode string
    The normal http status code of health check, the value can be http_2xx or http_3xx or http_4xx or http_5xx.
    Interval int
    The interval executing health check, default 2, range in 1~300.
    Method string
    The method of health check, the value can be GET or HEAD.
    Timeout int
    The response timeout of health check, default 2, range in 1~60..
    UdpExpect string
    The UDP expect of health check. This field must be specified simultaneously with field udp_request.
    UdpRequest string
    The UDP request of health check. This field must be specified simultaneously with field udp_expect.
    UnHealthyThreshold int
    The unhealthy threshold of health check, default 3, range in 2~10.
    Uri string
    The uri of health check.
    domain String
    The domain of health check.
    enabled String
    The enable status of health check function. Optional choice contains on, off.
    healthyThreshold Integer
    The healthy threshold of health check, default 3, range in 2~10.
    httpCode String
    The normal http status code of health check, the value can be http_2xx or http_3xx or http_4xx or http_5xx.
    interval Integer
    The interval executing health check, default 2, range in 1~300.
    method String
    The method of health check, the value can be GET or HEAD.
    timeout Integer
    The response timeout of health check, default 2, range in 1~60..
    udpExpect String
    The UDP expect of health check. This field must be specified simultaneously with field udp_request.
    udpRequest String
    The UDP request of health check. This field must be specified simultaneously with field udp_expect.
    unHealthyThreshold Integer
    The unhealthy threshold of health check, default 3, range in 2~10.
    uri String
    The uri of health check.
    domain string
    The domain of health check.
    enabled string
    The enable status of health check function. Optional choice contains on, off.
    healthyThreshold number
    The healthy threshold of health check, default 3, range in 2~10.
    httpCode string
    The normal http status code of health check, the value can be http_2xx or http_3xx or http_4xx or http_5xx.
    interval number
    The interval executing health check, default 2, range in 1~300.
    method string
    The method of health check, the value can be GET or HEAD.
    timeout number
    The response timeout of health check, default 2, range in 1~60..
    udpExpect string
    The UDP expect of health check. This field must be specified simultaneously with field udp_request.
    udpRequest string
    The UDP request of health check. This field must be specified simultaneously with field udp_expect.
    unHealthyThreshold number
    The unhealthy threshold of health check, default 3, range in 2~10.
    uri string
    The uri of health check.
    domain str
    The domain of health check.
    enabled str
    The enable status of health check function. Optional choice contains on, off.
    healthy_threshold int
    The healthy threshold of health check, default 3, range in 2~10.
    http_code str
    The normal http status code of health check, the value can be http_2xx or http_3xx or http_4xx or http_5xx.
    interval int
    The interval executing health check, default 2, range in 1~300.
    method str
    The method of health check, the value can be GET or HEAD.
    timeout int
    The response timeout of health check, default 2, range in 1~60..
    udp_expect str
    The UDP expect of health check. This field must be specified simultaneously with field udp_request.
    udp_request str
    The UDP request of health check. This field must be specified simultaneously with field udp_expect.
    un_healthy_threshold int
    The unhealthy threshold of health check, default 3, range in 2~10.
    uri str
    The uri of health check.
    domain String
    The domain of health check.
    enabled String
    The enable status of health check function. Optional choice contains on, off.
    healthyThreshold Number
    The healthy threshold of health check, default 3, range in 2~10.
    httpCode String
    The normal http status code of health check, the value can be http_2xx or http_3xx or http_4xx or http_5xx.
    interval Number
    The interval executing health check, default 2, range in 1~300.
    method String
    The method of health check, the value can be GET or HEAD.
    timeout Number
    The response timeout of health check, default 2, range in 1~60..
    udpExpect String
    The UDP expect of health check. This field must be specified simultaneously with field udp_request.
    udpRequest String
    The UDP request of health check. This field must be specified simultaneously with field udp_expect.
    unHealthyThreshold Number
    The unhealthy threshold of health check, default 3, range in 2~10.
    uri String
    The uri of health check.

    Import

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

    $ pulumi import volcengine:clb/listener:Listener default lsn-273yv0mhs5xj47fap8sehiiso

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
    volcengine/pulumi-volcengine