Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ClbListenerRule
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.ClbListenerRule

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create a CLB listener rule.

    NOTE: This resource only be applied to the HTTP or HTTPS listeners.

    Example Usage

    Create a single domain listener rule

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

const example = new tencentcloud.ClbListenerRule("example", {
    certificateCaId: "VfqO4zkB",
    certificateId: "VjANRdz8",
    certificateSslMode: "MUTUAL",
    clbId: "lb-k2zjp9lv",
    domain: "example.com",
    healthCheckHealthNum: 3,
    healthCheckHttpCode: 2,
    healthCheckHttpDomain: "check.com",
    healthCheckHttpMethod: "GET",
    healthCheckHttpPath: "/",
    healthCheckIntervalTime: 5,
    healthCheckSwitch: true,
    healthCheckUnhealthNum: 3,
    listenerId: "lbl-hh141sn9",
    scheduler: "WRR",
    sessionExpireTime: 30,
    url: "/",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ClbListenerRule("example",
    certificate_ca_id="VfqO4zkB",
    certificate_id="VjANRdz8",
    certificate_ssl_mode="MUTUAL",
    clb_id="lb-k2zjp9lv",
    domain="example.com",
    health_check_health_num=3,
    health_check_http_code=2,
    health_check_http_domain="check.com",
    health_check_http_method="GET",
    health_check_http_path="/",
    health_check_interval_time=5,
    health_check_switch=True,
    health_check_unhealth_num=3,
    listener_id="lbl-hh141sn9",
    scheduler="WRR",
    session_expire_time=30,
    url="/")

    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.NewClbListenerRule(ctx, "example", &tencentcloud.ClbListenerRuleArgs{
			CertificateCaId:         pulumi.String("VfqO4zkB"),
			CertificateId:           pulumi.String("VjANRdz8"),
			CertificateSslMode:      pulumi.String("MUTUAL"),
			ClbId:                   pulumi.String("lb-k2zjp9lv"),
			Domain:                  pulumi.String("example.com"),
			HealthCheckHealthNum:    pulumi.Float64(3),
			HealthCheckHttpCode:     pulumi.Float64(2),
			HealthCheckHttpDomain:   pulumi.String("check.com"),
			HealthCheckHttpMethod:   pulumi.String("GET"),
			HealthCheckHttpPath:     pulumi.String("/"),
			HealthCheckIntervalTime: pulumi.Float64(5),
			HealthCheckSwitch:       pulumi.Bool(true),
			HealthCheckUnhealthNum:  pulumi.Float64(3),
			ListenerId:              pulumi.String("lbl-hh141sn9"),
			Scheduler:               pulumi.String("WRR"),
			SessionExpireTime:       pulumi.Float64(30),
			Url:                     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 example = new Tencentcloud.ClbListenerRule("example", new()
    {
        CertificateCaId = "VfqO4zkB",
        CertificateId = "VjANRdz8",
        CertificateSslMode = "MUTUAL",
        ClbId = "lb-k2zjp9lv",
        Domain = "example.com",
        HealthCheckHealthNum = 3,
        HealthCheckHttpCode = 2,
        HealthCheckHttpDomain = "check.com",
        HealthCheckHttpMethod = "GET",
        HealthCheckHttpPath = "/",
        HealthCheckIntervalTime = 5,
        HealthCheckSwitch = true,
        HealthCheckUnhealthNum = 3,
        ListenerId = "lbl-hh141sn9",
        Scheduler = "WRR",
        SessionExpireTime = 30,
        Url = "/",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListenerRule;
import com.pulumi.tencentcloud.ClbListenerRuleArgs;
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 example = new ClbListenerRule("example", ClbListenerRuleArgs.builder()
            .certificateCaId("VfqO4zkB")
            .certificateId("VjANRdz8")
            .certificateSslMode("MUTUAL")
            .clbId("lb-k2zjp9lv")
            .domain("example.com")
            .healthCheckHealthNum(3)
            .healthCheckHttpCode(2)
            .healthCheckHttpDomain("check.com")
            .healthCheckHttpMethod("GET")
            .healthCheckHttpPath("/")
            .healthCheckIntervalTime(5)
            .healthCheckSwitch(true)
            .healthCheckUnhealthNum(3)
            .listenerId("lbl-hh141sn9")
            .scheduler("WRR")
            .sessionExpireTime(30)
            .url("/")
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ClbListenerRule
    properties:
      certificateCaId: VfqO4zkB
      certificateId: VjANRdz8
      certificateSslMode: MUTUAL
      clbId: lb-k2zjp9lv
      domain: example.com
      healthCheckHealthNum: 3
      healthCheckHttpCode: 2
      healthCheckHttpDomain: check.com
      healthCheckHttpMethod: GET
      healthCheckHttpPath: /
      healthCheckIntervalTime: 5
      healthCheckSwitch: true
      healthCheckUnhealthNum: 3
      listenerId: lbl-hh141sn9
      scheduler: WRR
      sessionExpireTime: 30
      url: /

    Create a listener rule for domain lists

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

const example = new tencentcloud.ClbListenerRule("example", {
    clbId: "lb-l6cp6jt4",
    domains: [
        "example1.com",
        "example2.com",
    ],
    healthCheckHealthNum: 3,
    healthCheckHttpCode: 15,
    healthCheckHttpDomain: "check.com",
    healthCheckHttpMethod: "GET",
    healthCheckHttpPath: "/",
    healthCheckIntervalTime: 5,
    healthCheckPort: 8080,
    healthCheckSwitch: true,
    healthCheckTimeOut: 2,
    healthCheckType: "HTTP",
    healthCheckUnhealthNum: 3,
    listenerId: "lbl-2qzcv7oq",
    multiCertInfo: {
        certIdLists: [
            "LCYouprI",
            "JVO1alRN",
        ],
        sslMode: "UNIDIRECTIONAL",
    },
    scheduler: "WRR",
    url: "/",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ClbListenerRule("example",
    clb_id="lb-l6cp6jt4",
    domains=[
        "example1.com",
        "example2.com",
    ],
    health_check_health_num=3,
    health_check_http_code=15,
    health_check_http_domain="check.com",
    health_check_http_method="GET",
    health_check_http_path="/",
    health_check_interval_time=5,
    health_check_port=8080,
    health_check_switch=True,
    health_check_time_out=2,
    health_check_type="HTTP",
    health_check_unhealth_num=3,
    listener_id="lbl-2qzcv7oq",
    multi_cert_info={
        "cert_id_lists": [
            "LCYouprI",
            "JVO1alRN",
        ],
        "ssl_mode": "UNIDIRECTIONAL",
    },
    scheduler="WRR",
    url="/")

    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.NewClbListenerRule(ctx, "example", &tencentcloud.ClbListenerRuleArgs{
			ClbId: pulumi.String("lb-l6cp6jt4"),
			Domains: pulumi.StringArray{
				pulumi.String("example1.com"),
				pulumi.String("example2.com"),
			},
			HealthCheckHealthNum:    pulumi.Float64(3),
			HealthCheckHttpCode:     pulumi.Float64(15),
			HealthCheckHttpDomain:   pulumi.String("check.com"),
			HealthCheckHttpMethod:   pulumi.String("GET"),
			HealthCheckHttpPath:     pulumi.String("/"),
			HealthCheckIntervalTime: pulumi.Float64(5),
			HealthCheckPort:         pulumi.Float64(8080),
			HealthCheckSwitch:       pulumi.Bool(true),
			HealthCheckTimeOut:      pulumi.Float64(2),
			HealthCheckType:         pulumi.String("HTTP"),
			HealthCheckUnhealthNum:  pulumi.Float64(3),
			ListenerId:              pulumi.String("lbl-2qzcv7oq"),
			MultiCertInfo: &tencentcloud.ClbListenerRuleMultiCertInfoArgs{
				CertIdLists: pulumi.StringArray{
					pulumi.String("LCYouprI"),
					pulumi.String("JVO1alRN"),
				},
				SslMode: pulumi.String("UNIDIRECTIONAL"),
			},
			Scheduler: pulumi.String("WRR"),
			Url:       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 example = new Tencentcloud.ClbListenerRule("example", new()
    {
        ClbId = "lb-l6cp6jt4",
        Domains = new[]
        {
            "example1.com",
            "example2.com",
        },
        HealthCheckHealthNum = 3,
        HealthCheckHttpCode = 15,
        HealthCheckHttpDomain = "check.com",
        HealthCheckHttpMethod = "GET",
        HealthCheckHttpPath = "/",
        HealthCheckIntervalTime = 5,
        HealthCheckPort = 8080,
        HealthCheckSwitch = true,
        HealthCheckTimeOut = 2,
        HealthCheckType = "HTTP",
        HealthCheckUnhealthNum = 3,
        ListenerId = "lbl-2qzcv7oq",
        MultiCertInfo = new Tencentcloud.Inputs.ClbListenerRuleMultiCertInfoArgs
        {
            CertIdLists = new[]
            {
                "LCYouprI",
                "JVO1alRN",
            },
            SslMode = "UNIDIRECTIONAL",
        },
        Scheduler = "WRR",
        Url = "/",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListenerRule;
import com.pulumi.tencentcloud.ClbListenerRuleArgs;
import com.pulumi.tencentcloud.inputs.ClbListenerRuleMultiCertInfoArgs;
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 example = new ClbListenerRule("example", ClbListenerRuleArgs.builder()
            .clbId("lb-l6cp6jt4")
            .domains(            
                "example1.com",
                "example2.com")
            .healthCheckHealthNum(3)
            .healthCheckHttpCode(15)
            .healthCheckHttpDomain("check.com")
            .healthCheckHttpMethod("GET")
            .healthCheckHttpPath("/")
            .healthCheckIntervalTime(5)
            .healthCheckPort(8080)
            .healthCheckSwitch(true)
            .healthCheckTimeOut(2)
            .healthCheckType("HTTP")
            .healthCheckUnhealthNum(3)
            .listenerId("lbl-2qzcv7oq")
            .multiCertInfo(ClbListenerRuleMultiCertInfoArgs.builder()
                .certIdLists(                
                    "LCYouprI",
                    "JVO1alRN")
                .sslMode("UNIDIRECTIONAL")
                .build())
            .scheduler("WRR")
            .url("/")
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ClbListenerRule
    properties:
      clbId: lb-l6cp6jt4
      domains:
        - example1.com
        - example2.com
      healthCheckHealthNum: 3
      healthCheckHttpCode: 15
      healthCheckHttpDomain: check.com
      healthCheckHttpMethod: GET
      healthCheckHttpPath: /
      healthCheckIntervalTime: 5
      healthCheckPort: 8080
      healthCheckSwitch: true
      healthCheckTimeOut: 2
      healthCheckType: HTTP
      healthCheckUnhealthNum: 3
      listenerId: lbl-2qzcv7oq
      multiCertInfo:
        certIdLists:
          - LCYouprI
          - JVO1alRN
        sslMode: UNIDIRECTIONAL
      scheduler: WRR
      url: /

    Create ClbListenerRule Resource

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

    Constructor syntax

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

@overload
def ClbListenerRule(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    clb_id: Optional[str] = None,
                    url: Optional[str] = None,
                    listener_id: Optional[str] = None,
                    forward_type: Optional[str] = None,
                    health_check_time_out: Optional[float] = None,
                    domain: Optional[str] = None,
                    domains: Optional[Sequence[str]] = None,
                    certificate_ca_id: 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_interval_time: Optional[float] = None,
                    health_check_port: Optional[float] = None,
                    health_check_switch: Optional[bool] = None,
                    clb_listener_rule_id: Optional[str] = None,
                    health_check_type: Optional[str] = None,
                    health_check_unhealth_num: Optional[float] = None,
                    health_source_ip_type: Optional[float] = None,
                    http2_switch: Optional[bool] = None,
                    certificate_ssl_mode: Optional[str] = None,
                    multi_cert_info: Optional[ClbListenerRuleMultiCertInfoArgs] = None,
                    oauth: Optional[ClbListenerRuleOauthArgs] = None,
                    quic: Optional[bool] = None,
                    scheduler: Optional[str] = None,
                    session_expire_time: Optional[float] = None,
                    target_type: Optional[str] = None,
                    certificate_id: Optional[str] = None)
    func NewClbListenerRule(ctx *Context, name string, args ClbListenerRuleArgs, opts ...ResourceOption) (*ClbListenerRule, error)
    public ClbListenerRule(string name, ClbListenerRuleArgs args, CustomResourceOptions? opts = null)
    public ClbListenerRule(String name, ClbListenerRuleArgs args)
public ClbListenerRule(String name, ClbListenerRuleArgs args, CustomResourceOptions options)

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

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

    ClbId string
    ID of CLB instance.
    ListenerId string
    ID of CLB listener.
    Url string
    Url of the listener rule.
    CertificateCaId string
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    CertificateId string
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    CertificateSslMode string
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    ClbListenerRuleId string
    ID of the resource.
    Domain string
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    Domains List<string>
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    ForwardType string
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    HealthCheckHealthNum double
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    HealthCheckHttpCode double
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    HealthCheckHttpDomain string
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    HealthCheckHttpMethod string
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    HealthCheckHttpPath string
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    HealthCheckIntervalTime double
    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.
    HealthCheckPort double
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    HealthCheckSwitch bool
    Indicates whether health check is enabled.
    HealthCheckTimeOut double
    Time out of health check. The value range is 2-60.
    HealthCheckType string
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    HealthCheckUnhealthNum double
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    HealthSourceIpType double
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    Http2Switch bool
    Indicate to apply HTTP2.0 protocol or not.
    MultiCertInfo ClbListenerRuleMultiCertInfo
    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.
    Oauth ClbListenerRuleOauth
    OAuth configuration information.
    Quic bool
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    Scheduler string
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    SessionExpireTime double
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    TargetType string
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    ClbId string
    ID of CLB instance.
    ListenerId string
    ID of CLB listener.
    Url string
    Url of the listener rule.
    CertificateCaId string
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    CertificateId string
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    CertificateSslMode string
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    ClbListenerRuleId string
    ID of the resource.
    Domain string
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    Domains []string
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    ForwardType string
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    HealthCheckHealthNum float64
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    HealthCheckHttpCode float64
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    HealthCheckHttpDomain string
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    HealthCheckHttpMethod string
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    HealthCheckHttpPath string
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    HealthCheckIntervalTime float64
    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.
    HealthCheckPort float64
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    HealthCheckSwitch bool
    Indicates whether health check is enabled.
    HealthCheckTimeOut float64
    Time out of health check. The value range is 2-60.
    HealthCheckType string
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    HealthCheckUnhealthNum float64
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    HealthSourceIpType float64
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    Http2Switch bool
    Indicate to apply HTTP2.0 protocol or not.
    MultiCertInfo ClbListenerRuleMultiCertInfoArgs
    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.
    Oauth ClbListenerRuleOauthArgs
    OAuth configuration information.
    Quic bool
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    Scheduler string
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    SessionExpireTime float64
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    TargetType string
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    clbId String
    ID of CLB instance.
    listenerId String
    ID of CLB listener.
    url String
    Url of the listener rule.
    certificateCaId String
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateId String
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateSslMode String
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    clbListenerRuleId String
    ID of the resource.
    domain String
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    domains List<String>
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    forwardType String
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    healthCheckHealthNum Double
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthCheckHttpCode Double
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    healthCheckHttpDomain String
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckHttpMethod String
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    healthCheckHttpPath String
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckIntervalTime Double
    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.
    healthCheckPort Double
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    healthCheckSwitch Boolean
    Indicates whether health check is enabled.
    healthCheckTimeOut Double
    Time out of health check. The value range is 2-60.
    healthCheckType String
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    healthCheckUnhealthNum Double
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthSourceIpType Double
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    http2Switch Boolean
    Indicate to apply HTTP2.0 protocol or not.
    multiCertInfo ClbListenerRuleMultiCertInfo
    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.
    oauth ClbListenerRuleOauth
    OAuth configuration information.
    quic Boolean
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    scheduler String
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    sessionExpireTime Double
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    targetType String
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    clbId string
    ID of CLB instance.
    listenerId string
    ID of CLB listener.
    url string
    Url of the listener rule.
    certificateCaId string
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateId string
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateSslMode string
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    clbListenerRuleId string
    ID of the resource.
    domain string
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    domains string[]
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    forwardType string
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    healthCheckHealthNum number
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthCheckHttpCode number
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    healthCheckHttpDomain string
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckHttpMethod string
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    healthCheckHttpPath string
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckIntervalTime number
    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.
    healthCheckPort number
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    healthCheckSwitch boolean
    Indicates whether health check is enabled.
    healthCheckTimeOut number
    Time out of health check. The value range is 2-60.
    healthCheckType string
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    healthCheckUnhealthNum number
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthSourceIpType number
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    http2Switch boolean
    Indicate to apply HTTP2.0 protocol or not.
    multiCertInfo ClbListenerRuleMultiCertInfo
    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.
    oauth ClbListenerRuleOauth
    OAuth configuration information.
    quic boolean
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    scheduler string
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    sessionExpireTime number
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    targetType string
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    clb_id str
    ID of CLB instance.
    listener_id str
    ID of CLB listener.
    url str
    Url of the listener rule.
    certificate_ca_id str
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificate_id str
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificate_ssl_mode str
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    clb_listener_rule_id str
    ID of the resource.
    domain str
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    domains Sequence[str]
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    forward_type str
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    health_check_health_num float
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    health_check_http_code float
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    health_check_http_domain str
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    health_check_http_method str
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    health_check_http_path str
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    health_check_interval_time float
    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_port float
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    health_check_switch bool
    Indicates whether health check is enabled.
    health_check_time_out float
    Time out of health check. The value range is 2-60.
    health_check_type str
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    health_check_unhealth_num float
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    health_source_ip_type float
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    http2_switch bool
    Indicate to apply HTTP2.0 protocol or not.
    multi_cert_info ClbListenerRuleMultiCertInfoArgs
    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.
    oauth ClbListenerRuleOauthArgs
    OAuth configuration information.
    quic bool
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    scheduler str
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    session_expire_time float
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    target_type str
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    clbId String
    ID of CLB instance.
    listenerId String
    ID of CLB listener.
    url String
    Url of the listener rule.
    certificateCaId String
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateId String
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateSslMode String
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    clbListenerRuleId String
    ID of the resource.
    domain String
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    domains List<String>
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    forwardType String
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    healthCheckHealthNum Number
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthCheckHttpCode Number
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    healthCheckHttpDomain String
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckHttpMethod String
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    healthCheckHttpPath String
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckIntervalTime Number
    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.
    healthCheckPort Number
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    healthCheckSwitch Boolean
    Indicates whether health check is enabled.
    healthCheckTimeOut Number
    Time out of health check. The value range is 2-60.
    healthCheckType String
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    healthCheckUnhealthNum Number
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthSourceIpType Number
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    http2Switch Boolean
    Indicate to apply HTTP2.0 protocol or not.
    multiCertInfo Property Map
    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.
    oauth Property Map
    OAuth configuration information.
    quic Boolean
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    scheduler String
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    sessionExpireTime Number
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    targetType String
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    ID of this CLB listener rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    ID of this CLB listener rule.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    ID of this CLB listener rule.
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId string
    ID of this CLB listener rule.
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id str
    ID of this CLB listener rule.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    ID of this CLB listener rule.

    Look up Existing ClbListenerRule Resource

    Get an existing ClbListenerRule 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?: ClbListenerRuleState, opts?: CustomResourceOptions): ClbListenerRule
    @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_rule_id: Optional[str] = None,
        domain: Optional[str] = None,
        domains: Optional[Sequence[str]] = None,
        forward_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_interval_time: Optional[float] = None,
        health_check_port: Optional[float] = 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,
        http2_switch: Optional[bool] = None,
        listener_id: Optional[str] = None,
        multi_cert_info: Optional[ClbListenerRuleMultiCertInfoArgs] = None,
        oauth: Optional[ClbListenerRuleOauthArgs] = None,
        quic: Optional[bool] = None,
        rule_id: Optional[str] = None,
        scheduler: Optional[str] = None,
        session_expire_time: Optional[float] = None,
        target_type: Optional[str] = None,
        url: Optional[str] = None) -> ClbListenerRule
    func GetClbListenerRule(ctx *Context, name string, id IDInput, state *ClbListenerRuleState, opts ...ResourceOption) (*ClbListenerRule, error)
    public static ClbListenerRule Get(string name, Input<string> id, ClbListenerRuleState? state, CustomResourceOptions? opts = null)
    public static ClbListenerRule get(String name, Output<String> id, ClbListenerRuleState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:ClbListenerRule    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CertificateCaId string
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    CertificateId string
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    CertificateSslMode string
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    ClbId string
    ID of CLB instance.
    ClbListenerRuleId string
    ID of the resource.
    Domain string
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    Domains List<string>
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    ForwardType string
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    HealthCheckHealthNum double
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    HealthCheckHttpCode double
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    HealthCheckHttpDomain string
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    HealthCheckHttpMethod string
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    HealthCheckHttpPath string
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    HealthCheckIntervalTime double
    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.
    HealthCheckPort double
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    HealthCheckSwitch bool
    Indicates whether health check is enabled.
    HealthCheckTimeOut double
    Time out of health check. The value range is 2-60.
    HealthCheckType string
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    HealthCheckUnhealthNum double
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    HealthSourceIpType double
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    Http2Switch bool
    Indicate to apply HTTP2.0 protocol or not.
    ListenerId string
    ID of CLB listener.
    MultiCertInfo ClbListenerRuleMultiCertInfo
    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.
    Oauth ClbListenerRuleOauth
    OAuth configuration information.
    Quic bool
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    RuleId string
    ID of this CLB listener rule.
    Scheduler string
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    SessionExpireTime double
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    TargetType string
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    Url string
    Url of the listener rule.
    CertificateCaId string
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    CertificateId string
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    CertificateSslMode string
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    ClbId string
    ID of CLB instance.
    ClbListenerRuleId string
    ID of the resource.
    Domain string
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    Domains []string
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    ForwardType string
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    HealthCheckHealthNum float64
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    HealthCheckHttpCode float64
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    HealthCheckHttpDomain string
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    HealthCheckHttpMethod string
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    HealthCheckHttpPath string
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    HealthCheckIntervalTime float64
    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.
    HealthCheckPort float64
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    HealthCheckSwitch bool
    Indicates whether health check is enabled.
    HealthCheckTimeOut float64
    Time out of health check. The value range is 2-60.
    HealthCheckType string
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    HealthCheckUnhealthNum float64
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    HealthSourceIpType float64
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    Http2Switch bool
    Indicate to apply HTTP2.0 protocol or not.
    ListenerId string
    ID of CLB listener.
    MultiCertInfo ClbListenerRuleMultiCertInfoArgs
    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.
    Oauth ClbListenerRuleOauthArgs
    OAuth configuration information.
    Quic bool
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    RuleId string
    ID of this CLB listener rule.
    Scheduler string
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    SessionExpireTime float64
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    TargetType string
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    Url string
    Url of the listener rule.
    certificateCaId String
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateId String
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateSslMode String
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    clbId String
    ID of CLB instance.
    clbListenerRuleId String
    ID of the resource.
    domain String
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    domains List<String>
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    forwardType String
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    healthCheckHealthNum Double
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthCheckHttpCode Double
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    healthCheckHttpDomain String
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckHttpMethod String
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    healthCheckHttpPath String
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckIntervalTime Double
    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.
    healthCheckPort Double
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    healthCheckSwitch Boolean
    Indicates whether health check is enabled.
    healthCheckTimeOut Double
    Time out of health check. The value range is 2-60.
    healthCheckType String
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    healthCheckUnhealthNum Double
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthSourceIpType Double
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    http2Switch Boolean
    Indicate to apply HTTP2.0 protocol or not.
    listenerId String
    ID of CLB listener.
    multiCertInfo ClbListenerRuleMultiCertInfo
    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.
    oauth ClbListenerRuleOauth
    OAuth configuration information.
    quic Boolean
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    ruleId String
    ID of this CLB listener rule.
    scheduler String
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    sessionExpireTime Double
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    targetType String
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    url String
    Url of the listener rule.
    certificateCaId string
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateId string
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateSslMode string
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    clbId string
    ID of CLB instance.
    clbListenerRuleId string
    ID of the resource.
    domain string
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    domains string[]
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    forwardType string
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    healthCheckHealthNum number
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthCheckHttpCode number
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    healthCheckHttpDomain string
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckHttpMethod string
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    healthCheckHttpPath string
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckIntervalTime number
    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.
    healthCheckPort number
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    healthCheckSwitch boolean
    Indicates whether health check is enabled.
    healthCheckTimeOut number
    Time out of health check. The value range is 2-60.
    healthCheckType string
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    healthCheckUnhealthNum number
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthSourceIpType number
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    http2Switch boolean
    Indicate to apply HTTP2.0 protocol or not.
    listenerId string
    ID of CLB listener.
    multiCertInfo ClbListenerRuleMultiCertInfo
    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.
    oauth ClbListenerRuleOauth
    OAuth configuration information.
    quic boolean
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    ruleId string
    ID of this CLB listener rule.
    scheduler string
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    sessionExpireTime number
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    targetType string
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    url string
    Url of the listener rule.
    certificate_ca_id str
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificate_id str
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificate_ssl_mode str
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    clb_id str
    ID of CLB instance.
    clb_listener_rule_id str
    ID of the resource.
    domain str
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    domains Sequence[str]
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    forward_type str
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    health_check_health_num float
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    health_check_http_code float
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    health_check_http_domain str
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    health_check_http_method str
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    health_check_http_path str
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    health_check_interval_time float
    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_port float
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    health_check_switch bool
    Indicates whether health check is enabled.
    health_check_time_out float
    Time out of health check. The value range is 2-60.
    health_check_type str
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    health_check_unhealth_num float
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    health_source_ip_type float
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    http2_switch bool
    Indicate to apply HTTP2.0 protocol or not.
    listener_id str
    ID of CLB listener.
    multi_cert_info ClbListenerRuleMultiCertInfoArgs
    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.
    oauth ClbListenerRuleOauthArgs
    OAuth configuration information.
    quic bool
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    rule_id str
    ID of this CLB listener rule.
    scheduler str
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    session_expire_time float
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    target_type str
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    url str
    Url of the listener rule.
    certificateCaId String
    ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateId String
    ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol.
    certificateSslMode String
    Type of certificate. Valid values: UNIDIRECTIONAL, MUTUAL. NOTES: Only supports listeners of HTTPS protocol.
    clbId String
    ID of CLB instance.
    clbListenerRuleId String
    ID of the resource.
    domain String
    Domain name of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    domains List<String>
    Domain name list of the listener rule. Single domain rules are passed to domain, and multi domain rules are passed to domains.
    forwardType String
    Forwarding protocol between the CLB instance and real server. Valid values: HTTP, HTTPS, GRPC, GRPCS, TRPC. The default is HTTP.
    healthCheckHealthNum Number
    Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthCheckHttpCode Number
    HTTP Status Code. The default is 31. Valid value ranges: [1~31]. 1 means the return value '1xx' is health. 2means the return value '2xx' is health.4means the return value '3xx' is health.8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    healthCheckHttpDomain String
    Domain name of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckHttpMethod String
    Methods of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol. The default is HEAD, the available value are HEAD and GET.
    healthCheckHttpPath String
    Path of health check. NOTES: Only supports listeners of HTTP and HTTPS protocol.
    healthCheckIntervalTime Number
    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.
    healthCheckPort Number
    Customize detection related parameters. Health check port, defaults to the port of the backend service, unless you want to specify a specific port, it is recommended to leave it blank. (Applicable only to TCP/UDP listeners).
    healthCheckSwitch Boolean
    Indicates whether health check is enabled.
    healthCheckTimeOut Number
    Time out of health check. The value range is 2-60.
    healthCheckType String
    Type of health check. Valid value is CUSTOM, PING, TCP, HTTP, HTTPS, GRPC, GRPCS.
    healthCheckUnhealthNum Number
    Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    healthSourceIpType Number
    Specifies the type of health check source IP. 0 (default): CLB VIP. 1: 100.64 IP range.
    http2Switch Boolean
    Indicate to apply HTTP2.0 protocol or not.
    listenerId String
    ID of CLB listener.
    multiCertInfo Property Map
    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.
    oauth Property Map
    OAuth configuration information.
    quic Boolean
    Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names.
    ruleId String
    ID of this CLB listener rule.
    scheduler String
    Scheduling method of the CLB listener rules. Valid values: WRR, IP HASH, LEAST_CONN. The default is WRR. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    sessionExpireTime Number
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as WRR, and not available when listener protocol is TCP_SSL. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud.ClbListenerRule.
    targetType String
    Backend target type. Valid values: NODE, TARGETGROUP. NODE means to bind ordinary nodes, TARGETGROUP means to bind target group.
    url String
    Url of the listener rule.

    Supporting Types

    ClbListenerRuleMultiCertInfo, ClbListenerRuleMultiCertInfoArgs

    CertIdLists List<string>
    List of server certificate ID.
    SslMode string
    Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
    CertIdLists []string
    List of server certificate ID.
    SslMode string
    Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
    certIdLists List<String>
    List of server certificate ID.
    sslMode String
    Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
    certIdLists string[]
    List of server certificate ID.
    sslMode string
    Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
    cert_id_lists Sequence[str]
    List of server certificate ID.
    ssl_mode str
    Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
    certIdLists List<String>
    List of server certificate ID.
    sslMode String
    Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).

    ClbListenerRuleOauth, ClbListenerRuleOauthArgs

    OauthEnable bool
    Enable or disable authentication. True: Enabled; False: Disabled.
    OauthFailureStatus string
    After all IAPs fail, the request is rejected or released. BYPASS: PASS; REJECT: Reject.
    OauthEnable bool
    Enable or disable authentication. True: Enabled; False: Disabled.
    OauthFailureStatus string
    After all IAPs fail, the request is rejected or released. BYPASS: PASS; REJECT: Reject.
    oauthEnable Boolean
    Enable or disable authentication. True: Enabled; False: Disabled.
    oauthFailureStatus String
    After all IAPs fail, the request is rejected or released. BYPASS: PASS; REJECT: Reject.
    oauthEnable boolean
    Enable or disable authentication. True: Enabled; False: Disabled.
    oauthFailureStatus string
    After all IAPs fail, the request is rejected or released. BYPASS: PASS; REJECT: Reject.
    oauth_enable bool
    Enable or disable authentication. True: Enabled; False: Disabled.
    oauth_failure_status str
    After all IAPs fail, the request is rejected or released. BYPASS: PASS; REJECT: Reject.
    oauthEnable Boolean
    Enable or disable authentication. True: Enabled; False: Disabled.
    oauthFailureStatus String
    After all IAPs fail, the request is rejected or released. BYPASS: PASS; REJECT: Reject.

    Import

    CLB listener rule can be imported using the id (version >= 1.47.0), e.g.

    $ pulumi import tencentcloud:index/clbListenerRule:ClbListenerRule example lb-k2zjp9lv#lbl-hh141sn9#loc-agg236ys

    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.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud