tencentcloud.ClbListener
Explore with Pulumi AI
Provides a resource to create a CLB listener.
Example Usage
HTTP Listener
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const hTTPListener = new tencentcloud.ClbListener("hTTPListener", {
clbId: "lb-0lh5au7v",
listenerName: "test_listener",
port: 80,
protocol: "HTTP",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
h_ttp_listener = tencentcloud.ClbListener("hTTPListener",
clb_id="lb-0lh5au7v",
listener_name="test_listener",
port=80,
protocol="HTTP")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tencentcloud.NewClbListener(ctx, "hTTPListener", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-0lh5au7v"),
ListenerName: pulumi.String("test_listener"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("HTTP"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var hTTPListener = new Tencentcloud.ClbListener("hTTPListener", new()
{
ClbId = "lb-0lh5au7v",
ListenerName = "test_listener",
Port = 80,
Protocol = "HTTP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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 hTTPListener = new ClbListener("hTTPListener", ClbListenerArgs.builder()
.clbId("lb-0lh5au7v")
.listenerName("test_listener")
.port(80)
.protocol("HTTP")
.build());
}
}
resources:
hTTPListener:
type: tencentcloud:ClbListener
properties:
clbId: lb-0lh5au7v
listenerName: test_listener
port: 80
protocol: HTTP
TCP/UDP Listener
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const tCPListener = new tencentcloud.ClbListener("tCPListener", {
clbId: "lb-0lh5au7v",
healthCheckHealthNum: 3,
healthCheckHttpCode: 2,
healthCheckHttpMethod: "GET",
healthCheckHttpVersion: "HTTP/1.0",
healthCheckIntervalTime: 5,
healthCheckPort: 200,
healthCheckSwitch: true,
healthCheckTimeOut: 2,
healthCheckType: "HTTP",
healthCheckUnhealthNum: 3,
listenerName: "test_listener",
port: 80,
protocol: "TCP",
scheduler: "WRR",
sessionExpireTime: 30,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
t_cp_listener = tencentcloud.ClbListener("tCPListener",
clb_id="lb-0lh5au7v",
health_check_health_num=3,
health_check_http_code=2,
health_check_http_method="GET",
health_check_http_version="HTTP/1.0",
health_check_interval_time=5,
health_check_port=200,
health_check_switch=True,
health_check_time_out=2,
health_check_type="HTTP",
health_check_unhealth_num=3,
listener_name="test_listener",
port=80,
protocol="TCP",
scheduler="WRR",
session_expire_time=30)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tencentcloud.NewClbListener(ctx, "tCPListener", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-0lh5au7v"),
HealthCheckHealthNum: pulumi.Float64(3),
HealthCheckHttpCode: pulumi.Float64(2),
HealthCheckHttpMethod: pulumi.String("GET"),
HealthCheckHttpVersion: pulumi.String("HTTP/1.0"),
HealthCheckIntervalTime: pulumi.Float64(5),
HealthCheckPort: pulumi.Float64(200),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(2),
HealthCheckType: pulumi.String("HTTP"),
HealthCheckUnhealthNum: pulumi.Float64(3),
ListenerName: pulumi.String("test_listener"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("TCP"),
Scheduler: pulumi.String("WRR"),
SessionExpireTime: pulumi.Float64(30),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var tCPListener = new Tencentcloud.ClbListener("tCPListener", new()
{
ClbId = "lb-0lh5au7v",
HealthCheckHealthNum = 3,
HealthCheckHttpCode = 2,
HealthCheckHttpMethod = "GET",
HealthCheckHttpVersion = "HTTP/1.0",
HealthCheckIntervalTime = 5,
HealthCheckPort = 200,
HealthCheckSwitch = true,
HealthCheckTimeOut = 2,
HealthCheckType = "HTTP",
HealthCheckUnhealthNum = 3,
ListenerName = "test_listener",
Port = 80,
Protocol = "TCP",
Scheduler = "WRR",
SessionExpireTime = 30,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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 tCPListener = new ClbListener("tCPListener", ClbListenerArgs.builder()
.clbId("lb-0lh5au7v")
.healthCheckHealthNum(3)
.healthCheckHttpCode(2)
.healthCheckHttpMethod("GET")
.healthCheckHttpVersion("HTTP/1.0")
.healthCheckIntervalTime(5)
.healthCheckPort(200)
.healthCheckSwitch(true)
.healthCheckTimeOut(2)
.healthCheckType("HTTP")
.healthCheckUnhealthNum(3)
.listenerName("test_listener")
.port(80)
.protocol("TCP")
.scheduler("WRR")
.sessionExpireTime(30)
.build());
}
}
resources:
tCPListener:
type: tencentcloud:ClbListener
properties:
clbId: lb-0lh5au7v
healthCheckHealthNum: 3
healthCheckHttpCode: 2
healthCheckHttpMethod: GET
healthCheckHttpVersion: HTTP/1.0
healthCheckIntervalTime: 5
healthCheckPort: 200
healthCheckSwitch: true
healthCheckTimeOut: 2
healthCheckType: HTTP
healthCheckUnhealthNum: 3
listenerName: test_listener
port: 80
protocol: TCP
scheduler: WRR
sessionExpireTime: 30
TCP/UDP Listener with tcp health check
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const listenerTcp = new tencentcloud.ClbListener("listenerTcp", {
clbId: tencentcloud_clb_instance.clb_basic.id,
listenerName: "listener_tcp",
port: 44,
protocol: "TCP",
healthCheckSwitch: true,
healthCheckTimeOut: 30,
healthCheckIntervalTime: 100,
healthCheckHealthNum: 2,
healthCheckUnhealthNum: 2,
sessionExpireTime: 30,
scheduler: "WRR",
healthCheckType: "TCP",
healthCheckPort: 200,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
listener_tcp = tencentcloud.ClbListener("listenerTcp",
clb_id=tencentcloud_clb_instance["clb_basic"]["id"],
listener_name="listener_tcp",
port=44,
protocol="TCP",
health_check_switch=True,
health_check_time_out=30,
health_check_interval_time=100,
health_check_health_num=2,
health_check_unhealth_num=2,
session_expire_time=30,
scheduler="WRR",
health_check_type="TCP",
health_check_port=200)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tencentcloud.NewClbListener(ctx, "listenerTcp", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.Any(tencentcloud_clb_instance.Clb_basic.Id),
ListenerName: pulumi.String("listener_tcp"),
Port: pulumi.Float64(44),
Protocol: pulumi.String("TCP"),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(30),
HealthCheckIntervalTime: pulumi.Float64(100),
HealthCheckHealthNum: pulumi.Float64(2),
HealthCheckUnhealthNum: pulumi.Float64(2),
SessionExpireTime: pulumi.Float64(30),
Scheduler: pulumi.String("WRR"),
HealthCheckType: pulumi.String("TCP"),
HealthCheckPort: pulumi.Float64(200),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var listenerTcp = new Tencentcloud.ClbListener("listenerTcp", new()
{
ClbId = tencentcloud_clb_instance.Clb_basic.Id,
ListenerName = "listener_tcp",
Port = 44,
Protocol = "TCP",
HealthCheckSwitch = true,
HealthCheckTimeOut = 30,
HealthCheckIntervalTime = 100,
HealthCheckHealthNum = 2,
HealthCheckUnhealthNum = 2,
SessionExpireTime = 30,
Scheduler = "WRR",
HealthCheckType = "TCP",
HealthCheckPort = 200,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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 listenerTcp = new ClbListener("listenerTcp", ClbListenerArgs.builder()
.clbId(tencentcloud_clb_instance.clb_basic().id())
.listenerName("listener_tcp")
.port(44)
.protocol("TCP")
.healthCheckSwitch(true)
.healthCheckTimeOut(30)
.healthCheckIntervalTime(100)
.healthCheckHealthNum(2)
.healthCheckUnhealthNum(2)
.sessionExpireTime(30)
.scheduler("WRR")
.healthCheckType("TCP")
.healthCheckPort(200)
.build());
}
}
resources:
listenerTcp:
type: tencentcloud:ClbListener
properties:
clbId: ${tencentcloud_clb_instance.clb_basic.id}
listenerName: listener_tcp
port: 44
protocol: TCP
healthCheckSwitch: true
healthCheckTimeOut: 30
healthCheckIntervalTime: 100
healthCheckHealthNum: 2
healthCheckUnhealthNum: 2
sessionExpireTime: 30
scheduler: WRR
healthCheckType: TCP
healthCheckPort: 200
TCP/UDP Listener with http health check
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const listenerTcp = new tencentcloud.ClbListener("listenerTcp", {
clbId: tencentcloud_clb_instance.clb_basic.id,
listenerName: "listener_tcp",
port: 44,
protocol: "TCP",
healthCheckSwitch: true,
healthCheckTimeOut: 30,
healthCheckIntervalTime: 100,
healthCheckHealthNum: 2,
healthCheckUnhealthNum: 2,
sessionExpireTime: 30,
scheduler: "WRR",
healthCheckType: "HTTP",
healthCheckHttpDomain: "www.tencent.com",
healthCheckHttpCode: 16,
healthCheckHttpVersion: "HTTP/1.1",
healthCheckHttpMethod: "HEAD",
healthCheckHttpPath: "/",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
listener_tcp = tencentcloud.ClbListener("listenerTcp",
clb_id=tencentcloud_clb_instance["clb_basic"]["id"],
listener_name="listener_tcp",
port=44,
protocol="TCP",
health_check_switch=True,
health_check_time_out=30,
health_check_interval_time=100,
health_check_health_num=2,
health_check_unhealth_num=2,
session_expire_time=30,
scheduler="WRR",
health_check_type="HTTP",
health_check_http_domain="www.tencent.com",
health_check_http_code=16,
health_check_http_version="HTTP/1.1",
health_check_http_method="HEAD",
health_check_http_path="/")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tencentcloud.NewClbListener(ctx, "listenerTcp", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.Any(tencentcloud_clb_instance.Clb_basic.Id),
ListenerName: pulumi.String("listener_tcp"),
Port: pulumi.Float64(44),
Protocol: pulumi.String("TCP"),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(30),
HealthCheckIntervalTime: pulumi.Float64(100),
HealthCheckHealthNum: pulumi.Float64(2),
HealthCheckUnhealthNum: pulumi.Float64(2),
SessionExpireTime: pulumi.Float64(30),
Scheduler: pulumi.String("WRR"),
HealthCheckType: pulumi.String("HTTP"),
HealthCheckHttpDomain: pulumi.String("www.tencent.com"),
HealthCheckHttpCode: pulumi.Float64(16),
HealthCheckHttpVersion: pulumi.String("HTTP/1.1"),
HealthCheckHttpMethod: pulumi.String("HEAD"),
HealthCheckHttpPath: pulumi.String("/"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var listenerTcp = new Tencentcloud.ClbListener("listenerTcp", new()
{
ClbId = tencentcloud_clb_instance.Clb_basic.Id,
ListenerName = "listener_tcp",
Port = 44,
Protocol = "TCP",
HealthCheckSwitch = true,
HealthCheckTimeOut = 30,
HealthCheckIntervalTime = 100,
HealthCheckHealthNum = 2,
HealthCheckUnhealthNum = 2,
SessionExpireTime = 30,
Scheduler = "WRR",
HealthCheckType = "HTTP",
HealthCheckHttpDomain = "www.tencent.com",
HealthCheckHttpCode = 16,
HealthCheckHttpVersion = "HTTP/1.1",
HealthCheckHttpMethod = "HEAD",
HealthCheckHttpPath = "/",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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 listenerTcp = new ClbListener("listenerTcp", ClbListenerArgs.builder()
.clbId(tencentcloud_clb_instance.clb_basic().id())
.listenerName("listener_tcp")
.port(44)
.protocol("TCP")
.healthCheckSwitch(true)
.healthCheckTimeOut(30)
.healthCheckIntervalTime(100)
.healthCheckHealthNum(2)
.healthCheckUnhealthNum(2)
.sessionExpireTime(30)
.scheduler("WRR")
.healthCheckType("HTTP")
.healthCheckHttpDomain("www.tencent.com")
.healthCheckHttpCode(16)
.healthCheckHttpVersion("HTTP/1.1")
.healthCheckHttpMethod("HEAD")
.healthCheckHttpPath("/")
.build());
}
}
resources:
listenerTcp:
type: tencentcloud:ClbListener
properties:
clbId: ${tencentcloud_clb_instance.clb_basic.id}
listenerName: listener_tcp
port: 44
protocol: TCP
healthCheckSwitch: true
healthCheckTimeOut: 30
healthCheckIntervalTime: 100
healthCheckHealthNum: 2
healthCheckUnhealthNum: 2
sessionExpireTime: 30
scheduler: WRR
healthCheckType: HTTP
healthCheckHttpDomain: www.tencent.com
healthCheckHttpCode: 16
healthCheckHttpVersion: HTTP/1.1
healthCheckHttpMethod: HEAD
healthCheckHttpPath: /
TCP/UDP Listener with customer health check
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const listenerTcp = new tencentcloud.ClbListener("listenerTcp", {
clbId: tencentcloud_clb_instance.clb_basic.id,
listenerName: "listener_tcp",
port: 44,
protocol: "TCP",
healthCheckSwitch: true,
healthCheckTimeOut: 30,
healthCheckIntervalTime: 100,
healthCheckHealthNum: 2,
healthCheckUnhealthNum: 2,
sessionExpireTime: 30,
scheduler: "WRR",
healthCheckType: "CUSTOM",
healthCheckContextType: "HEX",
healthCheckSendContext: "0123456789ABCDEF",
healthCheckRecvContext: "ABCD",
targetType: "TARGETGROUP",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
listener_tcp = tencentcloud.ClbListener("listenerTcp",
clb_id=tencentcloud_clb_instance["clb_basic"]["id"],
listener_name="listener_tcp",
port=44,
protocol="TCP",
health_check_switch=True,
health_check_time_out=30,
health_check_interval_time=100,
health_check_health_num=2,
health_check_unhealth_num=2,
session_expire_time=30,
scheduler="WRR",
health_check_type="CUSTOM",
health_check_context_type="HEX",
health_check_send_context="0123456789ABCDEF",
health_check_recv_context="ABCD",
target_type="TARGETGROUP")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tencentcloud.NewClbListener(ctx, "listenerTcp", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.Any(tencentcloud_clb_instance.Clb_basic.Id),
ListenerName: pulumi.String("listener_tcp"),
Port: pulumi.Float64(44),
Protocol: pulumi.String("TCP"),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(30),
HealthCheckIntervalTime: pulumi.Float64(100),
HealthCheckHealthNum: pulumi.Float64(2),
HealthCheckUnhealthNum: pulumi.Float64(2),
SessionExpireTime: pulumi.Float64(30),
Scheduler: pulumi.String("WRR"),
HealthCheckType: pulumi.String("CUSTOM"),
HealthCheckContextType: pulumi.String("HEX"),
HealthCheckSendContext: pulumi.String("0123456789ABCDEF"),
HealthCheckRecvContext: pulumi.String("ABCD"),
TargetType: pulumi.String("TARGETGROUP"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var listenerTcp = new Tencentcloud.ClbListener("listenerTcp", new()
{
ClbId = tencentcloud_clb_instance.Clb_basic.Id,
ListenerName = "listener_tcp",
Port = 44,
Protocol = "TCP",
HealthCheckSwitch = true,
HealthCheckTimeOut = 30,
HealthCheckIntervalTime = 100,
HealthCheckHealthNum = 2,
HealthCheckUnhealthNum = 2,
SessionExpireTime = 30,
Scheduler = "WRR",
HealthCheckType = "CUSTOM",
HealthCheckContextType = "HEX",
HealthCheckSendContext = "0123456789ABCDEF",
HealthCheckRecvContext = "ABCD",
TargetType = "TARGETGROUP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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 listenerTcp = new ClbListener("listenerTcp", ClbListenerArgs.builder()
.clbId(tencentcloud_clb_instance.clb_basic().id())
.listenerName("listener_tcp")
.port(44)
.protocol("TCP")
.healthCheckSwitch(true)
.healthCheckTimeOut(30)
.healthCheckIntervalTime(100)
.healthCheckHealthNum(2)
.healthCheckUnhealthNum(2)
.sessionExpireTime(30)
.scheduler("WRR")
.healthCheckType("CUSTOM")
.healthCheckContextType("HEX")
.healthCheckSendContext("0123456789ABCDEF")
.healthCheckRecvContext("ABCD")
.targetType("TARGETGROUP")
.build());
}
}
resources:
listenerTcp:
type: tencentcloud:ClbListener
properties:
clbId: ${tencentcloud_clb_instance.clb_basic.id}
listenerName: listener_tcp
port: 44
protocol: TCP
healthCheckSwitch: true
healthCheckTimeOut: 30
healthCheckIntervalTime: 100
healthCheckHealthNum: 2
healthCheckUnhealthNum: 2
sessionExpireTime: 30
scheduler: WRR
healthCheckType: CUSTOM
healthCheckContextType: HEX
healthCheckSendContext: 0123456789ABCDEF
healthCheckRecvContext: ABCD
targetType: TARGETGROUP
HTTPS Listener with sigle certificate
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const hTTPSListener = new tencentcloud.ClbListener("hTTPSListener", {
certificateCaId: "VfqO4zkB",
certificateId: "VjANRdz8",
certificateSslMode: "MUTUAL",
clbId: "lb-0lh5au7v",
listenerName: "test_listener",
port: 80,
protocol: "HTTPS",
sniSwitch: true,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
h_ttps_listener = tencentcloud.ClbListener("hTTPSListener",
certificate_ca_id="VfqO4zkB",
certificate_id="VjANRdz8",
certificate_ssl_mode="MUTUAL",
clb_id="lb-0lh5au7v",
listener_name="test_listener",
port=80,
protocol="HTTPS",
sni_switch=True)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tencentcloud.NewClbListener(ctx, "hTTPSListener", &tencentcloud.ClbListenerArgs{
CertificateCaId: pulumi.String("VfqO4zkB"),
CertificateId: pulumi.String("VjANRdz8"),
CertificateSslMode: pulumi.String("MUTUAL"),
ClbId: pulumi.String("lb-0lh5au7v"),
ListenerName: pulumi.String("test_listener"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("HTTPS"),
SniSwitch: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var hTTPSListener = new Tencentcloud.ClbListener("hTTPSListener", new()
{
CertificateCaId = "VfqO4zkB",
CertificateId = "VjANRdz8",
CertificateSslMode = "MUTUAL",
ClbId = "lb-0lh5au7v",
ListenerName = "test_listener",
Port = 80,
Protocol = "HTTPS",
SniSwitch = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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 hTTPSListener = new ClbListener("hTTPSListener", ClbListenerArgs.builder()
.certificateCaId("VfqO4zkB")
.certificateId("VjANRdz8")
.certificateSslMode("MUTUAL")
.clbId("lb-0lh5au7v")
.listenerName("test_listener")
.port("80")
.protocol("HTTPS")
.sniSwitch(true)
.build());
}
}
resources:
hTTPSListener:
type: tencentcloud:ClbListener
properties:
certificateCaId: VfqO4zkB
certificateId: VjANRdz8
certificateSslMode: MUTUAL
clbId: lb-0lh5au7v
listenerName: test_listener
port: '80'
protocol: HTTPS
sniSwitch: true
HTTPS Listener with multi certificates
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const hTTPSListener = new tencentcloud.ClbListener("hTTPSListener", {
clbId: "lb-l6cp6jt4",
listenerName: "test_listener",
multiCertInfo: {
certIdLists: [
"LCYouprI",
"JVO1alRN",
],
sslMode: "UNIDIRECTIONAL",
},
port: 80,
protocol: "HTTPS",
sniSwitch: true,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
h_ttps_listener = tencentcloud.ClbListener("hTTPSListener",
clb_id="lb-l6cp6jt4",
listener_name="test_listener",
multi_cert_info={
"cert_id_lists": [
"LCYouprI",
"JVO1alRN",
],
"ssl_mode": "UNIDIRECTIONAL",
},
port=80,
protocol="HTTPS",
sni_switch=True)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tencentcloud.NewClbListener(ctx, "hTTPSListener", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-l6cp6jt4"),
ListenerName: pulumi.String("test_listener"),
MultiCertInfo: &tencentcloud.ClbListenerMultiCertInfoArgs{
CertIdLists: pulumi.StringArray{
pulumi.String("LCYouprI"),
pulumi.String("JVO1alRN"),
},
SslMode: pulumi.String("UNIDIRECTIONAL"),
},
Port: pulumi.Float64(80),
Protocol: pulumi.String("HTTPS"),
SniSwitch: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var hTTPSListener = new Tencentcloud.ClbListener("hTTPSListener", new()
{
ClbId = "lb-l6cp6jt4",
ListenerName = "test_listener",
MultiCertInfo = new Tencentcloud.Inputs.ClbListenerMultiCertInfoArgs
{
CertIdLists = new[]
{
"LCYouprI",
"JVO1alRN",
},
SslMode = "UNIDIRECTIONAL",
},
Port = 80,
Protocol = "HTTPS",
SniSwitch = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
import com.pulumi.tencentcloud.inputs.ClbListenerMultiCertInfoArgs;
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 hTTPSListener = new ClbListener("hTTPSListener", ClbListenerArgs.builder()
.clbId("lb-l6cp6jt4")
.listenerName("test_listener")
.multiCertInfo(ClbListenerMultiCertInfoArgs.builder()
.certIdLists(
"LCYouprI",
"JVO1alRN")
.sslMode("UNIDIRECTIONAL")
.build())
.port("80")
.protocol("HTTPS")
.sniSwitch(true)
.build());
}
}
resources:
hTTPSListener:
type: tencentcloud:ClbListener
properties:
clbId: lb-l6cp6jt4
listenerName: test_listener
multiCertInfo:
certIdLists:
- LCYouprI
- JVO1alRN
sslMode: UNIDIRECTIONAL
port: '80'
protocol: HTTPS
sniSwitch: true
TCP SSL Listener
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const tCPSSLListener = new tencentcloud.ClbListener("tCPSSLListener", {
certificateCaId: "VfqO4zkB",
certificateId: "VjANRdz8",
certificateSslMode: "MUTUAL",
clbId: "lb-0lh5au7v",
healthCheckHealthNum: 3,
healthCheckIntervalTime: 5,
healthCheckSwitch: true,
healthCheckTimeOut: 2,
healthCheckUnhealthNum: 3,
listenerName: "test_listener",
port: 80,
protocol: "TCP_SSL",
scheduler: "WRR",
targetType: "TARGETGROUP",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
t_cpssl_listener = tencentcloud.ClbListener("tCPSSLListener",
certificate_ca_id="VfqO4zkB",
certificate_id="VjANRdz8",
certificate_ssl_mode="MUTUAL",
clb_id="lb-0lh5au7v",
health_check_health_num=3,
health_check_interval_time=5,
health_check_switch=True,
health_check_time_out=2,
health_check_unhealth_num=3,
listener_name="test_listener",
port=80,
protocol="TCP_SSL",
scheduler="WRR",
target_type="TARGETGROUP")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tencentcloud.NewClbListener(ctx, "tCPSSLListener", &tencentcloud.ClbListenerArgs{
CertificateCaId: pulumi.String("VfqO4zkB"),
CertificateId: pulumi.String("VjANRdz8"),
CertificateSslMode: pulumi.String("MUTUAL"),
ClbId: pulumi.String("lb-0lh5au7v"),
HealthCheckHealthNum: pulumi.Float64(3),
HealthCheckIntervalTime: pulumi.Float64(5),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(2),
HealthCheckUnhealthNum: pulumi.Float64(3),
ListenerName: pulumi.String("test_listener"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("TCP_SSL"),
Scheduler: pulumi.String("WRR"),
TargetType: pulumi.String("TARGETGROUP"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var tCPSSLListener = new Tencentcloud.ClbListener("tCPSSLListener", new()
{
CertificateCaId = "VfqO4zkB",
CertificateId = "VjANRdz8",
CertificateSslMode = "MUTUAL",
ClbId = "lb-0lh5au7v",
HealthCheckHealthNum = 3,
HealthCheckIntervalTime = 5,
HealthCheckSwitch = true,
HealthCheckTimeOut = 2,
HealthCheckUnhealthNum = 3,
ListenerName = "test_listener",
Port = 80,
Protocol = "TCP_SSL",
Scheduler = "WRR",
TargetType = "TARGETGROUP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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 tCPSSLListener = new ClbListener("tCPSSLListener", ClbListenerArgs.builder()
.certificateCaId("VfqO4zkB")
.certificateId("VjANRdz8")
.certificateSslMode("MUTUAL")
.clbId("lb-0lh5au7v")
.healthCheckHealthNum(3)
.healthCheckIntervalTime(5)
.healthCheckSwitch(true)
.healthCheckTimeOut(2)
.healthCheckUnhealthNum(3)
.listenerName("test_listener")
.port("80")
.protocol("TCP_SSL")
.scheduler("WRR")
.targetType("TARGETGROUP")
.build());
}
}
resources:
tCPSSLListener:
type: tencentcloud:ClbListener
properties:
certificateCaId: VfqO4zkB
certificateId: VjANRdz8
certificateSslMode: MUTUAL
clbId: lb-0lh5au7v
healthCheckHealthNum: 3
healthCheckIntervalTime: 5
healthCheckSwitch: true
healthCheckTimeOut: 2
healthCheckUnhealthNum: 3
listenerName: test_listener
port: '80'
protocol: TCP_SSL
scheduler: WRR
targetType: TARGETGROUP
Port Range Listener
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const clbBasic = new tencentcloud.ClbInstance("clbBasic", {
networkType: "OPEN",
clbName: "tf-listener-test",
});
const listenerBasic = new tencentcloud.ClbListener("listenerBasic", {
clbId: clbBasic.clbInstanceId,
port: 1,
endPort: 6,
protocol: "TCP",
listenerName: "listener_basic",
sessionExpireTime: 30,
scheduler: "WRR",
targetType: "NODE",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
clb_basic = tencentcloud.ClbInstance("clbBasic",
network_type="OPEN",
clb_name="tf-listener-test")
listener_basic = tencentcloud.ClbListener("listenerBasic",
clb_id=clb_basic.clb_instance_id,
port=1,
end_port=6,
protocol="TCP",
listener_name="listener_basic",
session_expire_time=30,
scheduler="WRR",
target_type="NODE")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
clbBasic, err := tencentcloud.NewClbInstance(ctx, "clbBasic", &tencentcloud.ClbInstanceArgs{
NetworkType: pulumi.String("OPEN"),
ClbName: pulumi.String("tf-listener-test"),
})
if err != nil {
return err
}
_, err = tencentcloud.NewClbListener(ctx, "listenerBasic", &tencentcloud.ClbListenerArgs{
ClbId: clbBasic.ClbInstanceId,
Port: pulumi.Float64(1),
EndPort: pulumi.Float64(6),
Protocol: pulumi.String("TCP"),
ListenerName: pulumi.String("listener_basic"),
SessionExpireTime: pulumi.Float64(30),
Scheduler: pulumi.String("WRR"),
TargetType: pulumi.String("NODE"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var clbBasic = new Tencentcloud.ClbInstance("clbBasic", new()
{
NetworkType = "OPEN",
ClbName = "tf-listener-test",
});
var listenerBasic = new Tencentcloud.ClbListener("listenerBasic", new()
{
ClbId = clbBasic.ClbInstanceId,
Port = 1,
EndPort = 6,
Protocol = "TCP",
ListenerName = "listener_basic",
SessionExpireTime = 30,
Scheduler = "WRR",
TargetType = "NODE",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbInstance;
import com.pulumi.tencentcloud.ClbInstanceArgs;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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 clbBasic = new ClbInstance("clbBasic", ClbInstanceArgs.builder()
.networkType("OPEN")
.clbName("tf-listener-test")
.build());
var listenerBasic = new ClbListener("listenerBasic", ClbListenerArgs.builder()
.clbId(clbBasic.clbInstanceId())
.port(1)
.endPort(6)
.protocol("TCP")
.listenerName("listener_basic")
.sessionExpireTime(30)
.scheduler("WRR")
.targetType("NODE")
.build());
}
}
resources:
clbBasic:
type: tencentcloud:ClbInstance
properties:
networkType: OPEN
clbName: tf-listener-test
listenerBasic:
type: tencentcloud:ClbListener
properties:
clbId: ${clbBasic.clbInstanceId}
port: 1
endPort: 6
protocol: TCP
listenerName: listener_basic
sessionExpireTime: 30
scheduler: WRR
targetType: NODE
Create ClbListener Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClbListener(name: string, args: ClbListenerArgs, opts?: CustomResourceOptions);
@overload
def ClbListener(resource_name: str,
args: ClbListenerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClbListener(resource_name: str,
opts: Optional[ResourceOptions] = None,
clb_id: Optional[str] = None,
protocol: Optional[str] = None,
listener_name: Optional[str] = None,
health_check_health_num: Optional[float] = None,
health_check_time_out: Optional[float] = None,
end_port: Optional[float] = None,
h2c_switch: Optional[bool] = None,
health_check_context_type: Optional[str] = None,
certificate_ca_id: Optional[str] = None,
health_check_http_code: Optional[float] = None,
health_check_http_domain: Optional[str] = None,
health_check_http_method: Optional[str] = None,
health_check_http_path: Optional[str] = None,
health_check_http_version: Optional[str] = None,
health_check_interval_time: Optional[float] = None,
health_check_port: Optional[float] = None,
health_check_recv_context: Optional[str] = None,
clb_listener_id: Optional[str] = None,
health_check_send_context: Optional[str] = None,
health_check_unhealth_num: Optional[float] = None,
health_check_type: Optional[str] = None,
health_check_switch: Optional[bool] = None,
health_source_ip_type: Optional[float] = None,
keepalive_enable: Optional[float] = None,
certificate_ssl_mode: Optional[str] = None,
multi_cert_info: Optional[ClbListenerMultiCertInfoArgs] = None,
port: Optional[float] = None,
certificate_id: Optional[str] = None,
scheduler: Optional[str] = None,
session_expire_time: Optional[float] = None,
session_type: Optional[str] = None,
snat_enable: Optional[bool] = None,
sni_switch: Optional[bool] = None,
target_type: Optional[str] = None)
func NewClbListener(ctx *Context, name string, args ClbListenerArgs, opts ...ResourceOption) (*ClbListener, error)
public ClbListener(string name, ClbListenerArgs args, CustomResourceOptions? opts = null)
public ClbListener(String name, ClbListenerArgs args)
public ClbListener(String name, ClbListenerArgs args, CustomResourceOptions options)
type: tencentcloud:ClbListener
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 ClbListenerArgs
- 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 ClbListenerArgs
- 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 ClbListenerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClbListenerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClbListenerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ClbListener 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 ClbListener resource accepts the following input properties:
- Clb
Id string - ID of the CLB.
- Listener
Name string - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- Protocol string
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - Certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - Certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - Certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - Clb
Listener stringId - ID of the resource.
- End
Port double - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - H2c
Switch bool - Enable H2C switch for intranet HTTP listener.
- Health
Check stringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - Health
Check doubleHealth Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - Health
Check doubleHttp Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - Health
Check stringHttp Domain - HTTP health check domain of TCP listener.
- Health
Check stringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - Health
Check stringHttp Path - HTTP health check path of TCP listener.
- Health
Check stringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - Health
Check doubleInterval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - Health
Check doublePort - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- Health
Check stringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - Health
Check stringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - Health
Check boolSwitch - Indicates whether health check is enabled.
- Health
Check doubleTime Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - Health
Check stringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - Health
Check doubleUnhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Health
Source doubleIp Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - Keepalive
Enable double - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- Multi
Cert ClbInfo Listener Multi Cert Info - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- Port double
- Port of the CLB listener.
- Scheduler string
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Session
Expire doubleTime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Session
Type string - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - Snat
Enable bool - Whether to enable SNAT.
- Sni
Switch bool - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - Target
Type string - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- Clb
Id string - ID of the CLB.
- Listener
Name string - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- Protocol string
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - Certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - Certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - Certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - Clb
Listener stringId - ID of the resource.
- End
Port float64 - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - H2c
Switch bool - Enable H2C switch for intranet HTTP listener.
- Health
Check stringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - Health
Check float64Health Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - Health
Check float64Http Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - Health
Check stringHttp Domain - HTTP health check domain of TCP listener.
- Health
Check stringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - Health
Check stringHttp Path - HTTP health check path of TCP listener.
- Health
Check stringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - Health
Check float64Interval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - Health
Check float64Port - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- Health
Check stringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - Health
Check stringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - Health
Check boolSwitch - Indicates whether health check is enabled.
- Health
Check float64Time Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - Health
Check stringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - Health
Check float64Unhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Health
Source float64Ip Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - Keepalive
Enable float64 - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- Multi
Cert ClbInfo Listener Multi Cert Info Args - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- Port float64
- Port of the CLB listener.
- Scheduler string
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Session
Expire float64Time - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Session
Type string - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - Snat
Enable bool - Whether to enable SNAT.
- Sni
Switch bool - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - Target
Type string - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- clb
Id String - ID of the CLB.
- listener
Name String - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- protocol String
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - certificate
Ca StringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - certificate
Id String - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - certificate
Ssl StringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - clb
Listener StringId - ID of the resource.
- end
Port Double - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch Boolean - Enable H2C switch for intranet HTTP listener.
- health
Check StringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - health
Check DoubleHealth Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - health
Check DoubleHttp Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - health
Check StringHttp Domain - HTTP health check domain of TCP listener.
- health
Check StringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - health
Check StringHttp Path - HTTP health check path of TCP listener.
- health
Check StringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - health
Check DoubleInterval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - health
Check DoublePort - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- health
Check StringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check StringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check BooleanSwitch - Indicates whether health check is enabled.
- health
Check DoubleTime Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - health
Check StringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - health
Check DoubleUnhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - health
Source DoubleIp Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - keepalive
Enable Double - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- multi
Cert ClbInfo Listener Multi Cert Info - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- port Double
- Port of the CLB listener.
- scheduler String
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Expire DoubleTime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Type String - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - snat
Enable Boolean - Whether to enable SNAT.
- sni
Switch Boolean - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - target
Type String - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- clb
Id string - ID of the CLB.
- listener
Name string - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- protocol string
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - clb
Listener stringId - ID of the resource.
- end
Port number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch boolean - Enable H2C switch for intranet HTTP listener.
- health
Check stringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - health
Check numberHealth Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - health
Check numberHttp Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - health
Check stringHttp Domain - HTTP health check domain of TCP listener.
- health
Check stringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - health
Check stringHttp Path - HTTP health check path of TCP listener.
- health
Check stringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - health
Check numberInterval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - health
Check numberPort - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- health
Check stringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check stringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check booleanSwitch - Indicates whether health check is enabled.
- health
Check numberTime Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - health
Check stringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - health
Check numberUnhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - health
Source numberIp Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - keepalive
Enable number - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- multi
Cert ClbInfo Listener Multi Cert Info - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- port number
- Port of the CLB listener.
- scheduler string
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Expire numberTime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Type string - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - snat
Enable boolean - Whether to enable SNAT.
- sni
Switch boolean - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - target
Type string - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- clb_
id str - ID of the CLB.
- listener_
name str - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- protocol str
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - certificate_
ca_ strid - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - certificate_
id str - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - certificate_
ssl_ strmode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - clb_
listener_ strid - ID of the resource.
- end_
port float - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c_
switch bool - Enable H2C switch for intranet HTTP listener.
- health_
check_ strcontext_ type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - health_
check_ floathealth_ num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - health_
check_ floathttp_ code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - health_
check_ strhttp_ domain - HTTP health check domain of TCP listener.
- health_
check_ strhttp_ method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - health_
check_ strhttp_ path - HTTP health check path of TCP listener.
- health_
check_ strhttp_ version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - health_
check_ floatinterval_ time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - health_
check_ floatport - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- health_
check_ strrecv_ context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health_
check_ strsend_ context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health_
check_ boolswitch - Indicates whether health check is enabled.
- health_
check_ floattime_ out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - health_
check_ strtype - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - health_
check_ floatunhealth_ num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - health_
source_ floatip_ type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - keepalive_
enable float - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- multi_
cert_ Clbinfo Listener Multi Cert Info Args - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- port float
- Port of the CLB listener.
- scheduler str
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session_
expire_ floattime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session_
type str - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - snat_
enable bool - Whether to enable SNAT.
- sni_
switch bool - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - target_
type str - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- clb
Id String - ID of the CLB.
- listener
Name String - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- protocol String
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - certificate
Ca StringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - certificate
Id String - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - certificate
Ssl StringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - clb
Listener StringId - ID of the resource.
- end
Port Number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch Boolean - Enable H2C switch for intranet HTTP listener.
- health
Check StringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - health
Check NumberHealth Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - health
Check NumberHttp Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - health
Check StringHttp Domain - HTTP health check domain of TCP listener.
- health
Check StringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - health
Check StringHttp Path - HTTP health check path of TCP listener.
- health
Check StringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - health
Check NumberInterval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - health
Check NumberPort - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- health
Check StringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check StringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check BooleanSwitch - Indicates whether health check is enabled.
- health
Check NumberTime Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - health
Check StringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - health
Check NumberUnhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - health
Source NumberIp Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - keepalive
Enable Number - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- multi
Cert Property MapInfo - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- port Number
- Port of the CLB listener.
- scheduler String
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Expire NumberTime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Type String - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - snat
Enable Boolean - Whether to enable SNAT.
- sni
Switch Boolean - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - target
Type String - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClbListener resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Listener
Id string - ID of this CLB listener.
- Id string
- The provider-assigned unique ID for this managed resource.
- Listener
Id string - ID of this CLB listener.
- id String
- The provider-assigned unique ID for this managed resource.
- listener
Id String - ID of this CLB listener.
- id string
- The provider-assigned unique ID for this managed resource.
- listener
Id string - ID of this CLB listener.
- id str
- The provider-assigned unique ID for this managed resource.
- listener_
id str - ID of this CLB listener.
- id String
- The provider-assigned unique ID for this managed resource.
- listener
Id String - ID of this CLB listener.
Look up Existing ClbListener Resource
Get an existing ClbListener 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?: ClbListenerState, opts?: CustomResourceOptions): ClbListener
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
certificate_ca_id: Optional[str] = None,
certificate_id: Optional[str] = None,
certificate_ssl_mode: Optional[str] = None,
clb_id: Optional[str] = None,
clb_listener_id: Optional[str] = None,
end_port: Optional[float] = None,
h2c_switch: Optional[bool] = None,
health_check_context_type: Optional[str] = None,
health_check_health_num: Optional[float] = None,
health_check_http_code: Optional[float] = None,
health_check_http_domain: Optional[str] = None,
health_check_http_method: Optional[str] = None,
health_check_http_path: Optional[str] = None,
health_check_http_version: Optional[str] = None,
health_check_interval_time: Optional[float] = None,
health_check_port: Optional[float] = None,
health_check_recv_context: Optional[str] = None,
health_check_send_context: Optional[str] = None,
health_check_switch: Optional[bool] = None,
health_check_time_out: Optional[float] = None,
health_check_type: Optional[str] = None,
health_check_unhealth_num: Optional[float] = None,
health_source_ip_type: Optional[float] = None,
keepalive_enable: Optional[float] = None,
listener_id: Optional[str] = None,
listener_name: Optional[str] = None,
multi_cert_info: Optional[ClbListenerMultiCertInfoArgs] = None,
port: Optional[float] = None,
protocol: Optional[str] = None,
scheduler: Optional[str] = None,
session_expire_time: Optional[float] = None,
session_type: Optional[str] = None,
snat_enable: Optional[bool] = None,
sni_switch: Optional[bool] = None,
target_type: Optional[str] = None) -> ClbListener
func GetClbListener(ctx *Context, name string, id IDInput, state *ClbListenerState, opts ...ResourceOption) (*ClbListener, error)
public static ClbListener Get(string name, Input<string> id, ClbListenerState? state, CustomResourceOptions? opts = null)
public static ClbListener get(String name, Output<String> id, ClbListenerState state, CustomResourceOptions options)
resources: _: type: tencentcloud:ClbListener 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.
- Certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - Certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - Certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - Clb
Id string - ID of the CLB.
- Clb
Listener stringId - ID of the resource.
- End
Port double - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - H2c
Switch bool - Enable H2C switch for intranet HTTP listener.
- Health
Check stringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - Health
Check doubleHealth Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - Health
Check doubleHttp Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - Health
Check stringHttp Domain - HTTP health check domain of TCP listener.
- Health
Check stringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - Health
Check stringHttp Path - HTTP health check path of TCP listener.
- Health
Check stringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - Health
Check doubleInterval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - Health
Check doublePort - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- Health
Check stringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - Health
Check stringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - Health
Check boolSwitch - Indicates whether health check is enabled.
- Health
Check doubleTime Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - Health
Check stringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - Health
Check doubleUnhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Health
Source doubleIp Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - Keepalive
Enable double - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- Listener
Id string - ID of this CLB listener.
- Listener
Name string - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- Multi
Cert ClbInfo Listener Multi Cert Info - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- Port double
- Port of the CLB listener.
- Protocol string
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - Scheduler string
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Session
Expire doubleTime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Session
Type string - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - Snat
Enable bool - Whether to enable SNAT.
- Sni
Switch bool - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - Target
Type string - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- Certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - Certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - Certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - Clb
Id string - ID of the CLB.
- Clb
Listener stringId - ID of the resource.
- End
Port float64 - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - H2c
Switch bool - Enable H2C switch for intranet HTTP listener.
- Health
Check stringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - Health
Check float64Health Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - Health
Check float64Http Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - Health
Check stringHttp Domain - HTTP health check domain of TCP listener.
- Health
Check stringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - Health
Check stringHttp Path - HTTP health check path of TCP listener.
- Health
Check stringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - Health
Check float64Interval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - Health
Check float64Port - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- Health
Check stringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - Health
Check stringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - Health
Check boolSwitch - Indicates whether health check is enabled.
- Health
Check float64Time Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - Health
Check stringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - Health
Check float64Unhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Health
Source float64Ip Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - Keepalive
Enable float64 - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- Listener
Id string - ID of this CLB listener.
- Listener
Name string - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- Multi
Cert ClbInfo Listener Multi Cert Info Args - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- Port float64
- Port of the CLB listener.
- Protocol string
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - Scheduler string
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Session
Expire float64Time - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - Session
Type string - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - Snat
Enable bool - Whether to enable SNAT.
- Sni
Switch bool - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - Target
Type string - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- certificate
Ca StringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - certificate
Id String - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - certificate
Ssl StringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - clb
Id String - ID of the CLB.
- clb
Listener StringId - ID of the resource.
- end
Port Double - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch Boolean - Enable H2C switch for intranet HTTP listener.
- health
Check StringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - health
Check DoubleHealth Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - health
Check DoubleHttp Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - health
Check StringHttp Domain - HTTP health check domain of TCP listener.
- health
Check StringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - health
Check StringHttp Path - HTTP health check path of TCP listener.
- health
Check StringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - health
Check DoubleInterval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - health
Check DoublePort - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- health
Check StringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check StringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check BooleanSwitch - Indicates whether health check is enabled.
- health
Check DoubleTime Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - health
Check StringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - health
Check DoubleUnhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - health
Source DoubleIp Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - keepalive
Enable Double - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- listener
Id String - ID of this CLB listener.
- listener
Name String - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- multi
Cert ClbInfo Listener Multi Cert Info - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- port Double
- Port of the CLB listener.
- protocol String
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - scheduler String
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Expire DoubleTime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Type String - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - snat
Enable Boolean - Whether to enable SNAT.
- sni
Switch Boolean - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - target
Type String - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - clb
Id string - ID of the CLB.
- clb
Listener stringId - ID of the resource.
- end
Port number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch boolean - Enable H2C switch for intranet HTTP listener.
- health
Check stringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - health
Check numberHealth Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - health
Check numberHttp Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - health
Check stringHttp Domain - HTTP health check domain of TCP listener.
- health
Check stringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - health
Check stringHttp Path - HTTP health check path of TCP listener.
- health
Check stringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - health
Check numberInterval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - health
Check numberPort - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- health
Check stringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check stringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check booleanSwitch - Indicates whether health check is enabled.
- health
Check numberTime Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - health
Check stringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - health
Check numberUnhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - health
Source numberIp Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - keepalive
Enable number - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- listener
Id string - ID of this CLB listener.
- listener
Name string - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- multi
Cert ClbInfo Listener Multi Cert Info - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- port number
- Port of the CLB listener.
- protocol string
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - scheduler string
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Expire numberTime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Type string - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - snat
Enable boolean - Whether to enable SNAT.
- sni
Switch boolean - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - target
Type string - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- certificate_
ca_ strid - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - certificate_
id str - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - certificate_
ssl_ strmode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - clb_
id str - ID of the CLB.
- clb_
listener_ strid - ID of the resource.
- end_
port float - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c_
switch bool - Enable H2C switch for intranet HTTP listener.
- health_
check_ strcontext_ type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - health_
check_ floathealth_ num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - health_
check_ floathttp_ code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - health_
check_ strhttp_ domain - HTTP health check domain of TCP listener.
- health_
check_ strhttp_ method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - health_
check_ strhttp_ path - HTTP health check path of TCP listener.
- health_
check_ strhttp_ version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - health_
check_ floatinterval_ time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - health_
check_ floatport - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- health_
check_ strrecv_ context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health_
check_ strsend_ context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health_
check_ boolswitch - Indicates whether health check is enabled.
- health_
check_ floattime_ out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - health_
check_ strtype - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - health_
check_ floatunhealth_ num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - health_
source_ floatip_ type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - keepalive_
enable float - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- listener_
id str - ID of this CLB listener.
- listener_
name str - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- multi_
cert_ Clbinfo Listener Multi Cert Info Args - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- port float
- Port of the CLB listener.
- protocol str
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - scheduler str
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session_
expire_ floattime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session_
type str - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - snat_
enable bool - Whether to enable SNAT.
- sni_
switch bool - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - target_
type str - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
- certificate
Ca StringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when the ssl mode isMUTUAL
. - certificate
Id String - ID of the server certificate. NOTES: Only supports listeners of
HTTPS
andTCP_SSL
protocol and must be set when it is available. - certificate
Ssl StringMode - Type of certificate. Valid values:
UNIDIRECTIONAL
,MUTUAL
. NOTES: Only supports listeners ofHTTPS
andTCP_SSL
protocol and must be set when it is available. - clb
Id String - ID of the CLB.
- clb
Listener StringId - ID of the resource.
- end
Port Number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Ports
parameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch Boolean - Enable H2C switch for intranet HTTP listener.
- health
Check StringContext Type - Health check protocol. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required, which represents the input format of the health check. Valid values:HEX
,TEXT
. - health
Check NumberHealth Num - Health threshold of health check, and the default is
3
. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. - health
Check NumberHttp Code - HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:1
,2
,4
,8
,16
.1
means http_1xx,2
means http_2xx,4
means http_3xx,8
means http_4xx,16
means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. - health
Check StringHttp Domain - HTTP health check domain of TCP listener.
- health
Check StringHttp Method - HTTP health check method of TCP listener. Valid values:
HEAD
,GET
. - health
Check StringHttp Path - HTTP health check path of TCP listener.
- health
Check StringHttp Version - The HTTP version of the backend service. When the value of
health_check_type
of the health check protocol isHTTP
, this field is required. Valid values:HTTP/1.0
,HTTP/1.1
. - health
Check NumberInterval Time - Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in
tencentcloud.ClbListenerRule
. - health
Check NumberPort - The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener.
- health
Check StringRecv Context - It represents the result returned by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check StringSend Context - It represents the content of the request sent by the health check. When the value of
health_check_type
of the health check protocol isCUSTOM
, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. Whenhealth_check_context_type
value isHEX
, the characters of SendContext and RecvContext can only be selected in0123456789ABCDEF
and the length must be even digits. - health
Check BooleanSwitch - Indicates whether health check is enabled.
- health
Check NumberTime Out - Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of
TCP
,UDP
,TCP_SSL
protocol. - health
Check StringType - Protocol used for health check. Valid values:
CUSTOM
,TCP
,HTTP
,HTTPS
,PING
,GRPC
. - health
Check NumberUnhealth Num - Unhealthy threshold of health check, and the default is
3
. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - health
Source NumberIp Type - Specifies the type of health check source IP.
0
(default): CLB VIP.1
: 100.64 IP range. - keepalive
Enable Number - Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners. Valid values: 0 (disable; default value) and 1 (enable).
- listener
Id String - ID of this CLB listener.
- listener
Name String - Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'.
- multi
Cert Property MapInfo - Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time.
- port Number
- Port of the CLB listener.
- protocol String
- Type of protocol within the listener. Valid values:
TCP
,UDP
,HTTP
,HTTPS
,TCP_SSL
andQUIC
. - scheduler String
- Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of
HTTP
andHTTPS
protocol additionally supports theIP Hash
method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Expire NumberTime - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as
WRR
, and not available when listener protocol isTCP_SSL
. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured intencentcloud.ClbListenerRule
. - session
Type String - Session persistence type. Valid values:
NORMAL
: the default session persistence type;QUIC_CID
: session persistence by QUIC connection ID. TheQUIC_CID
value can only be configured in UDP listeners. If this field is not specified, the default session persistence type will be used. - snat
Enable Boolean - Whether to enable SNAT.
- sni
Switch Boolean - Indicates whether SNI is enabled, and only supported with protocol
HTTPS
. If enabled, you can set a certificate for each rule intencentcloud.ClbListenerRule
, otherwise all rules have a certificate. - target
Type String - Backend target type. Valid values:
NODE
,TARGETGROUP
.NODE
means to bind ordinary nodes,TARGETGROUP
means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
Supporting Types
ClbListenerMultiCertInfo, ClbListenerMultiCertInfoArgs
- Cert
Id List<string>Lists - List of server certificate ID.
- Ssl
Mode string - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- Cert
Id []stringLists - List of server certificate ID.
- Ssl
Mode string - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- cert
Id List<String>Lists - List of server certificate ID.
- ssl
Mode String - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- cert
Id string[]Lists - List of server certificate ID.
- ssl
Mode string - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- cert_
id_ Sequence[str]lists - List of server certificate ID.
- ssl_
mode str - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- cert
Id List<String>Lists - List of server certificate ID.
- ssl
Mode String - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
Import
CLB listener can be imported using the id (version >= 1.47.0), e.g.
$ pulumi import tencentcloud:index/clbListener:ClbListener foo lb-7a0t6zqb#lbl-hh141sn9
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- tencentcloud tencentcloudstack/terraform-provider-tencentcloud
- License
- Notes
- This Pulumi package is based on the
tencentcloud
Terraform Provider.