1. Registry
  2. Packages
  3. Opentelekomcloud Provider
  4. API Docs
  5. LbListenerV3
Viewing docs for opentelekomcloud 1.37.11
published on Friday, Oct 23, 2026 by opentelekomcloud
opentelekomcloud
Viewing docs for opentelekomcloud 1.37.11
published on Friday, Oct 23, 2026 by opentelekomcloud

    Up-to-date reference of API arguments for DLB listener you can get at documentation portal

    Manages a Dedicated LB listener resource within OpenTelekomCloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const listener1 = new opentelekomcloud.LbListenerV3("listener_1", {
        protocol: "HTTP",
        protocolPort: 8080,
        loadbalancerId: loadbalancerId,
        tags: {
            muh: "kuh",
        },
    });
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    listener1 = opentelekomcloud.LbListenerV3("listener_1",
        protocol="HTTP",
        protocol_port=8080,
        loadbalancer_id=loadbalancer_id,
        tags={
            "muh": "kuh",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := opentelekomcloud.NewLbListenerV3(ctx, "listener_1", &opentelekomcloud.LbListenerV3Args{
    			Protocol:       pulumi.String("HTTP"),
    			ProtocolPort:   pulumi.Float64(8080),
    			LoadbalancerId: pulumi.Any(loadbalancerId),
    			Tags: pulumi.StringMap{
    				"muh": pulumi.String("kuh"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var listener1 = new Opentelekomcloud.LbListenerV3("listener_1", new()
        {
            Protocol = "HTTP",
            ProtocolPort = 8080,
            LoadbalancerId = loadbalancerId,
            Tags = 
            {
                { "muh", "kuh" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.LbListenerV3;
    import com.pulumi.opentelekomcloud.LbListenerV3Args;
    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 listener1 = new LbListenerV3("listener1", LbListenerV3Args.builder()
                .protocol("HTTP")
                .protocolPort(8080.0)
                .loadbalancerId(loadbalancerId)
                .tags(Map.of("muh", "kuh"))
                .build());
    
        }
    }
    
    resources:
      listener1:
        type: opentelekomcloud:LbListenerV3
        name: listener_1
        properties:
          protocol: HTTP
          protocolPort: 8080
          loadbalancerId: ${loadbalancerId}
          tags:
            muh: kuh
    
    Example coming soon!
    

    Example Ip Address Group

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const group1 = new opentelekomcloud.LbIpgroupV3("group_1", {
        name: "group_2",
        description: "some interesting description 2",
        ipLists: [{
            ip: "192.168.10.11",
            description: "one",
        }],
    });
    const listener1 = new opentelekomcloud.LbListenerV3("listener_1", {
        name: "listener_1",
        description: "some interesting description",
        loadbalancerId: loadbalancer1.id,
        protocol: "HTTP",
        protocolPort: 8080,
        advancedForwarding: true,
        sniMatchAlgo: "wildcard",
        insertHeaders: {
            forwardedHost: true,
        },
        ipGroup: {
            id: group1.lbIpgroupV3Id,
            enable: true,
        },
    });
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    group1 = opentelekomcloud.LbIpgroupV3("group_1",
        name="group_2",
        description="some interesting description 2",
        ip_lists=[{
            "ip": "192.168.10.11",
            "description": "one",
        }])
    listener1 = opentelekomcloud.LbListenerV3("listener_1",
        name="listener_1",
        description="some interesting description",
        loadbalancer_id=loadbalancer1["id"],
        protocol="HTTP",
        protocol_port=8080,
        advanced_forwarding=True,
        sni_match_algo="wildcard",
        insert_headers={
            "forwarded_host": True,
        },
        ip_group={
            "id": group1.lb_ipgroup_v3_id,
            "enable": True,
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		group1, err := opentelekomcloud.NewLbIpgroupV3(ctx, "group_1", &opentelekomcloud.LbIpgroupV3Args{
    			Name:        pulumi.String("group_2"),
    			Description: pulumi.String("some interesting description 2"),
    			IpLists: opentelekomcloud.LbIpgroupV3IpListArray{
    				&opentelekomcloud.LbIpgroupV3IpListArgs{
    					Ip:          pulumi.String("192.168.10.11"),
    					Description: pulumi.String("one"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = opentelekomcloud.NewLbListenerV3(ctx, "listener_1", &opentelekomcloud.LbListenerV3Args{
    			Name:               pulumi.String("listener_1"),
    			Description:        pulumi.String("some interesting description"),
    			LoadbalancerId:     pulumi.Any(loadbalancer1.Id),
    			Protocol:           pulumi.String("HTTP"),
    			ProtocolPort:       pulumi.Float64(8080),
    			AdvancedForwarding: pulumi.Bool(true),
    			SniMatchAlgo:       pulumi.String("wildcard"),
    			InsertHeaders: &opentelekomcloud.LbListenerV3InsertHeadersArgs{
    				ForwardedHost: pulumi.Bool(true),
    			},
    			IpGroup: &opentelekomcloud.LbListenerV3IpGroupArgs{
    				Id:     group1.LbIpgroupV3Id,
    				Enable: pulumi.Bool(true),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var group1 = new Opentelekomcloud.LbIpgroupV3("group_1", new()
        {
            Name = "group_2",
            Description = "some interesting description 2",
            IpLists = new[]
            {
                new Opentelekomcloud.Inputs.LbIpgroupV3IpListArgs
                {
                    Ip = "192.168.10.11",
                    Description = "one",
                },
            },
        });
    
        var listener1 = new Opentelekomcloud.LbListenerV3("listener_1", new()
        {
            Name = "listener_1",
            Description = "some interesting description",
            LoadbalancerId = loadbalancer1.Id,
            Protocol = "HTTP",
            ProtocolPort = 8080,
            AdvancedForwarding = true,
            SniMatchAlgo = "wildcard",
            InsertHeaders = new Opentelekomcloud.Inputs.LbListenerV3InsertHeadersArgs
            {
                ForwardedHost = true,
            },
            IpGroup = new Opentelekomcloud.Inputs.LbListenerV3IpGroupArgs
            {
                Id = group1.LbIpgroupV3Id,
                Enable = true,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.LbIpgroupV3;
    import com.pulumi.opentelekomcloud.LbIpgroupV3Args;
    import com.pulumi.opentelekomcloud.inputs.LbIpgroupV3IpListArgs;
    import com.pulumi.opentelekomcloud.LbListenerV3;
    import com.pulumi.opentelekomcloud.LbListenerV3Args;
    import com.pulumi.opentelekomcloud.inputs.LbListenerV3InsertHeadersArgs;
    import com.pulumi.opentelekomcloud.inputs.LbListenerV3IpGroupArgs;
    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 group1 = new LbIpgroupV3("group1", LbIpgroupV3Args.builder()
                .name("group_2")
                .description("some interesting description 2")
                .ipLists(LbIpgroupV3IpListArgs.builder()
                    .ip("192.168.10.11")
                    .description("one")
                    .build())
                .build());
    
            var listener1 = new LbListenerV3("listener1", LbListenerV3Args.builder()
                .name("listener_1")
                .description("some interesting description")
                .loadbalancerId(loadbalancer1.id())
                .protocol("HTTP")
                .protocolPort(8080.0)
                .advancedForwarding(true)
                .sniMatchAlgo("wildcard")
                .insertHeaders(LbListenerV3InsertHeadersArgs.builder()
                    .forwardedHost(true)
                    .build())
                .ipGroup(LbListenerV3IpGroupArgs.builder()
                    .id(group1.lbIpgroupV3Id())
                    .enable(true)
                    .build())
                .build());
    
        }
    }
    
    resources:
      group1:
        type: opentelekomcloud:LbIpgroupV3
        name: group_1
        properties:
          name: group_2
          description: some interesting description 2
          ipLists:
            - ip: 192.168.10.11
              description: one
      listener1:
        type: opentelekomcloud:LbListenerV3
        name: listener_1
        properties:
          name: listener_1
          description: some interesting description
          loadbalancerId: ${loadbalancer1.id}
          protocol: HTTP
          protocolPort: 8080
          advancedForwarding: true
          sniMatchAlgo: wildcard
          insertHeaders:
            forwardedHost: true
          ipGroup:
            id: ${group1.lbIpgroupV3Id}
            enable: true
    
    Example coming soon!
    

    Create LbListenerV3 Resource

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

    Constructor syntax

    new LbListenerV3(name: string, args: LbListenerV3Args, opts?: CustomResourceOptions);
    @overload
    def LbListenerV3(resource_name: str,
                     args: LbListenerV3Args,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def LbListenerV3(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     loadbalancer_id: Optional[str] = None,
                     protocol_port: Optional[float] = None,
                     protocol: Optional[str] = None,
                     lb_listener_v3_id: Optional[str] = None,
                     member_retry_enable: Optional[bool] = None,
                     default_pool_id: Optional[str] = None,
                     default_tls_container_ref: Optional[str] = None,
                     description: Optional[str] = None,
                     http2_enable: Optional[bool] = None,
                     insert_headers: Optional[LbListenerV3InsertHeadersArgs] = None,
                     ip_group: Optional[LbListenerV3IpGroupArgs] = None,
                     keep_alive_timeout: Optional[float] = None,
                     access_log_customized_headers_config: Optional[LbListenerV3AccessLogCustomizedHeadersConfigArgs] = None,
                     client_ca_tls_container_ref: Optional[str] = None,
                     client_timeout: Optional[float] = None,
                     member_timeout: Optional[float] = None,
                     name: Optional[str] = None,
                     protection_reason: Optional[str] = None,
                     protection_status: Optional[str] = None,
                     advanced_forwarding: Optional[bool] = None,
                     admin_state_up: Optional[bool] = None,
                     security_policy_id: Optional[str] = None,
                     sni_container_refs: Optional[Sequence[str]] = None,
                     sni_match_algo: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     tls_ciphers_policy: Optional[str] = None)
    func NewLbListenerV3(ctx *Context, name string, args LbListenerV3Args, opts ...ResourceOption) (*LbListenerV3, error)
    public LbListenerV3(string name, LbListenerV3Args args, CustomResourceOptions? opts = null)
    public LbListenerV3(String name, LbListenerV3Args args)
    public LbListenerV3(String name, LbListenerV3Args args, CustomResourceOptions options)
    
    type: opentelekomcloud:LbListenerV3
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "opentelekomcloud_lb_listener_v3" "name" {
        # resource properties
    }

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var lbListenerV3Resource = new Opentelekomcloud.LbListenerV3("lbListenerV3Resource", new()
    {
        LoadbalancerId = "string",
        ProtocolPort = 0.0,
        Protocol = "string",
        LbListenerV3Id = "string",
        MemberRetryEnable = false,
        DefaultPoolId = "string",
        DefaultTlsContainerRef = "string",
        Description = "string",
        Http2Enable = false,
        InsertHeaders = new Opentelekomcloud.Inputs.LbListenerV3InsertHeadersArgs
        {
            ForwardElbIp = false,
            ForwardedForPort = false,
            ForwardedHost = false,
            ForwardedPort = false,
        },
        IpGroup = new Opentelekomcloud.Inputs.LbListenerV3IpGroupArgs
        {
            Id = "string",
            Enable = false,
            Type = "string",
        },
        KeepAliveTimeout = 0.0,
        AccessLogCustomizedHeadersConfig = new Opentelekomcloud.Inputs.LbListenerV3AccessLogCustomizedHeadersConfigArgs
        {
            Enable = false,
            ExcludeHeaders = new[]
            {
                "string",
            },
            IncludeHeaders = new[]
            {
                "string",
            },
        },
        ClientCaTlsContainerRef = "string",
        ClientTimeout = 0.0,
        MemberTimeout = 0.0,
        Name = "string",
        ProtectionReason = "string",
        ProtectionStatus = "string",
        AdvancedForwarding = false,
        AdminStateUp = false,
        SecurityPolicyId = "string",
        SniContainerRefs = new[]
        {
            "string",
        },
        SniMatchAlgo = "string",
        Tags = 
        {
            { "string", "string" },
        },
        TlsCiphersPolicy = "string",
    });
    
    example, err := opentelekomcloud.NewLbListenerV3(ctx, "lbListenerV3Resource", &opentelekomcloud.LbListenerV3Args{
    	LoadbalancerId:         pulumi.String("string"),
    	ProtocolPort:           pulumi.Float64(0),
    	Protocol:               pulumi.String("string"),
    	LbListenerV3Id:         pulumi.String("string"),
    	MemberRetryEnable:      pulumi.Bool(false),
    	DefaultPoolId:          pulumi.String("string"),
    	DefaultTlsContainerRef: pulumi.String("string"),
    	Description:            pulumi.String("string"),
    	Http2Enable:            pulumi.Bool(false),
    	InsertHeaders: &opentelekomcloud.LbListenerV3InsertHeadersArgs{
    		ForwardElbIp:     pulumi.Bool(false),
    		ForwardedForPort: pulumi.Bool(false),
    		ForwardedHost:    pulumi.Bool(false),
    		ForwardedPort:    pulumi.Bool(false),
    	},
    	IpGroup: &opentelekomcloud.LbListenerV3IpGroupArgs{
    		Id:     pulumi.String("string"),
    		Enable: pulumi.Bool(false),
    		Type:   pulumi.String("string"),
    	},
    	KeepAliveTimeout: pulumi.Float64(0),
    	AccessLogCustomizedHeadersConfig: &opentelekomcloud.LbListenerV3AccessLogCustomizedHeadersConfigArgs{
    		Enable: pulumi.Bool(false),
    		ExcludeHeaders: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IncludeHeaders: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	ClientCaTlsContainerRef: pulumi.String("string"),
    	ClientTimeout:           pulumi.Float64(0),
    	MemberTimeout:           pulumi.Float64(0),
    	Name:                    pulumi.String("string"),
    	ProtectionReason:        pulumi.String("string"),
    	ProtectionStatus:        pulumi.String("string"),
    	AdvancedForwarding:      pulumi.Bool(false),
    	AdminStateUp:            pulumi.Bool(false),
    	SecurityPolicyId:        pulumi.String("string"),
    	SniContainerRefs: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SniMatchAlgo: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TlsCiphersPolicy: pulumi.String("string"),
    })
    
    resource "opentelekomcloud_lb_listener_v3" "lbListenerV3Resource" {
      lifecycle {
        create_before_destroy = true
      }
      loadbalancer_id           = "string"
      protocol_port             = 0
      protocol                  = "string"
      lb_listener_v3_id         = "string"
      member_retry_enable       = false
      default_pool_id           = "string"
      default_tls_container_ref = "string"
      description               = "string"
      http2_enable              = false
      insert_headers = {
        forward_elb_ip     = false
        forwarded_for_port = false
        forwarded_host     = false
        forwarded_port     = false
      }
      ip_group = {
        id     = "string"
        enable = false
        type   = "string"
      }
      keep_alive_timeout = 0
      access_log_customized_headers_config = {
        enable          = false
        exclude_headers = ["string"]
        include_headers = ["string"]
      }
      client_ca_tls_container_ref = "string"
      client_timeout              = 0
      member_timeout              = 0
      name                        = "string"
      protection_reason           = "string"
      protection_status           = "string"
      advanced_forwarding         = false
      admin_state_up              = false
      security_policy_id          = "string"
      sni_container_refs          = ["string"]
      sni_match_algo              = "string"
      tags = {
        "string" = "string"
      }
      tls_ciphers_policy = "string"
    }
    
    var lbListenerV3Resource = new LbListenerV3("lbListenerV3Resource", LbListenerV3Args.builder()
        .loadbalancerId("string")
        .protocolPort(0.0)
        .protocol("string")
        .lbListenerV3Id("string")
        .memberRetryEnable(false)
        .defaultPoolId("string")
        .defaultTlsContainerRef("string")
        .description("string")
        .http2Enable(false)
        .insertHeaders(LbListenerV3InsertHeadersArgs.builder()
            .forwardElbIp(false)
            .forwardedForPort(false)
            .forwardedHost(false)
            .forwardedPort(false)
            .build())
        .ipGroup(LbListenerV3IpGroupArgs.builder()
            .id("string")
            .enable(false)
            .type("string")
            .build())
        .keepAliveTimeout(0.0)
        .accessLogCustomizedHeadersConfig(LbListenerV3AccessLogCustomizedHeadersConfigArgs.builder()
            .enable(false)
            .excludeHeaders("string")
            .includeHeaders("string")
            .build())
        .clientCaTlsContainerRef("string")
        .clientTimeout(0.0)
        .memberTimeout(0.0)
        .name("string")
        .protectionReason("string")
        .protectionStatus("string")
        .advancedForwarding(false)
        .adminStateUp(false)
        .securityPolicyId("string")
        .sniContainerRefs("string")
        .sniMatchAlgo("string")
        .tags(Map.of("string", "string"))
        .tlsCiphersPolicy("string")
        .build());
    
    lb_listener_v3_resource = opentelekomcloud.LbListenerV3("lbListenerV3Resource",
        loadbalancer_id="string",
        protocol_port=float(0),
        protocol="string",
        lb_listener_v3_id="string",
        member_retry_enable=False,
        default_pool_id="string",
        default_tls_container_ref="string",
        description="string",
        http2_enable=False,
        insert_headers={
            "forward_elb_ip": False,
            "forwarded_for_port": False,
            "forwarded_host": False,
            "forwarded_port": False,
        },
        ip_group={
            "id": "string",
            "enable": False,
            "type": "string",
        },
        keep_alive_timeout=float(0),
        access_log_customized_headers_config={
            "enable": False,
            "exclude_headers": ["string"],
            "include_headers": ["string"],
        },
        client_ca_tls_container_ref="string",
        client_timeout=float(0),
        member_timeout=float(0),
        name="string",
        protection_reason="string",
        protection_status="string",
        advanced_forwarding=False,
        admin_state_up=False,
        security_policy_id="string",
        sni_container_refs=["string"],
        sni_match_algo="string",
        tags={
            "string": "string",
        },
        tls_ciphers_policy="string")
    
    const lbListenerV3Resource = new opentelekomcloud.LbListenerV3("lbListenerV3Resource", {
        loadbalancerId: "string",
        protocolPort: 0,
        protocol: "string",
        lbListenerV3Id: "string",
        memberRetryEnable: false,
        defaultPoolId: "string",
        defaultTlsContainerRef: "string",
        description: "string",
        http2Enable: false,
        insertHeaders: {
            forwardElbIp: false,
            forwardedForPort: false,
            forwardedHost: false,
            forwardedPort: false,
        },
        ipGroup: {
            id: "string",
            enable: false,
            type: "string",
        },
        keepAliveTimeout: 0,
        accessLogCustomizedHeadersConfig: {
            enable: false,
            excludeHeaders: ["string"],
            includeHeaders: ["string"],
        },
        clientCaTlsContainerRef: "string",
        clientTimeout: 0,
        memberTimeout: 0,
        name: "string",
        protectionReason: "string",
        protectionStatus: "string",
        advancedForwarding: false,
        adminStateUp: false,
        securityPolicyId: "string",
        sniContainerRefs: ["string"],
        sniMatchAlgo: "string",
        tags: {
            string: "string",
        },
        tlsCiphersPolicy: "string",
    });
    
    type: opentelekomcloud:LbListenerV3
    properties:
        accessLogCustomizedHeadersConfig:
            enable: false
            excludeHeaders:
                - string
            includeHeaders:
                - string
        adminStateUp: false
        advancedForwarding: false
        clientCaTlsContainerRef: string
        clientTimeout: 0
        defaultPoolId: string
        defaultTlsContainerRef: string
        description: string
        http2Enable: false
        insertHeaders:
            forwardElbIp: false
            forwardedForPort: false
            forwardedHost: false
            forwardedPort: false
        ipGroup:
            enable: false
            id: string
            type: string
        keepAliveTimeout: 0
        lbListenerV3Id: string
        loadbalancerId: string
        memberRetryEnable: false
        memberTimeout: 0
        name: string
        protectionReason: string
        protectionStatus: string
        protocol: string
        protocolPort: 0
        securityPolicyId: string
        sniContainerRefs:
            - string
        sniMatchAlgo: string
        tags:
            string: string
        tlsCiphersPolicy: string
    

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

    LoadbalancerId string
    Specifies the ID of the load balancer that the listener is added to.
    Protocol string
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    ProtocolPort double
    Specifies the port used by the listener. Changing this creates a new Listener.
    AccessLogCustomizedHeadersConfig LbListenerV3AccessLogCustomizedHeadersConfig
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    AdminStateUp bool
    AdvancedForwarding bool
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    ClientCaTlsContainerRef string
    Specifies the ID of the CA certificate used by the listener.
    ClientTimeout double
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    DefaultPoolId string
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    DefaultTlsContainerRef string
    Specifies the ID of the server certificate used by the listener.
    Description string
    Provides supplementary information about the listener.
    Http2Enable bool
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    InsertHeaders LbListenerV3InsertHeaders
    Specifies the HTTP header fields.
    IpGroup LbListenerV3IpGroup
    Specifies the IP address group associated with the listener.
    KeepAliveTimeout double
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    LbListenerV3Id string
    MemberRetryEnable bool
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    MemberTimeout double
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    Name string
    Specifies the listener name.
    ProtectionReason string
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    ProtectionStatus string
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    SecurityPolicyId string
    Specifies the ID of the custom security policy.
    SniContainerRefs List<string>
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    SniMatchAlgo string
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    Tags Dictionary<string, string>
    Tags key/value pairs to associate with the loadbalancer listener.
    TlsCiphersPolicy string
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    LoadbalancerId string
    Specifies the ID of the load balancer that the listener is added to.
    Protocol string
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    ProtocolPort float64
    Specifies the port used by the listener. Changing this creates a new Listener.
    AccessLogCustomizedHeadersConfig LbListenerV3AccessLogCustomizedHeadersConfigArgs
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    AdminStateUp bool
    AdvancedForwarding bool
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    ClientCaTlsContainerRef string
    Specifies the ID of the CA certificate used by the listener.
    ClientTimeout float64
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    DefaultPoolId string
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    DefaultTlsContainerRef string
    Specifies the ID of the server certificate used by the listener.
    Description string
    Provides supplementary information about the listener.
    Http2Enable bool
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    InsertHeaders LbListenerV3InsertHeadersArgs
    Specifies the HTTP header fields.
    IpGroup LbListenerV3IpGroupArgs
    Specifies the IP address group associated with the listener.
    KeepAliveTimeout float64
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    LbListenerV3Id string
    MemberRetryEnable bool
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    MemberTimeout float64
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    Name string
    Specifies the listener name.
    ProtectionReason string
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    ProtectionStatus string
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    SecurityPolicyId string
    Specifies the ID of the custom security policy.
    SniContainerRefs []string
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    SniMatchAlgo string
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    Tags map[string]string
    Tags key/value pairs to associate with the loadbalancer listener.
    TlsCiphersPolicy string
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    loadbalancer_id string
    Specifies the ID of the load balancer that the listener is added to.
    protocol string
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocol_port number
    Specifies the port used by the listener. Changing this creates a new Listener.
    access_log_customized_headers_config object
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    admin_state_up bool
    advanced_forwarding bool
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    client_ca_tls_container_ref string
    Specifies the ID of the CA certificate used by the listener.
    client_timeout number
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    default_pool_id string
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    default_tls_container_ref string
    Specifies the ID of the server certificate used by the listener.
    description string
    Provides supplementary information about the listener.
    http2_enable bool
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insert_headers object
    Specifies the HTTP header fields.
    ip_group object
    Specifies the IP address group associated with the listener.
    keep_alive_timeout number
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lb_listener_v3_id string
    member_retry_enable bool
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    member_timeout number
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name string
    Specifies the listener name.
    protection_reason string
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protection_status string
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    security_policy_id string
    Specifies the ID of the custom security policy.
    sni_container_refs list(string)
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sni_match_algo string
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags map(string)
    Tags key/value pairs to associate with the loadbalancer listener.
    tls_ciphers_policy string
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    loadbalancerId String
    Specifies the ID of the load balancer that the listener is added to.
    protocol String
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocolPort Double
    Specifies the port used by the listener. Changing this creates a new Listener.
    accessLogCustomizedHeadersConfig LbListenerV3AccessLogCustomizedHeadersConfig
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    adminStateUp Boolean
    advancedForwarding Boolean
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    clientCaTlsContainerRef String
    Specifies the ID of the CA certificate used by the listener.
    clientTimeout Double
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    defaultPoolId String
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    defaultTlsContainerRef String
    Specifies the ID of the server certificate used by the listener.
    description String
    Provides supplementary information about the listener.
    http2Enable Boolean
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insertHeaders LbListenerV3InsertHeaders
    Specifies the HTTP header fields.
    ipGroup LbListenerV3IpGroup
    Specifies the IP address group associated with the listener.
    keepAliveTimeout Double
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lbListenerV3Id String
    memberRetryEnable Boolean
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    memberTimeout Double
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name String
    Specifies the listener name.
    protectionReason String
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protectionStatus String
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    securityPolicyId String
    Specifies the ID of the custom security policy.
    sniContainerRefs List<String>
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sniMatchAlgo String
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags Map<String,String>
    Tags key/value pairs to associate with the loadbalancer listener.
    tlsCiphersPolicy String
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    loadbalancerId string
    Specifies the ID of the load balancer that the listener is added to.
    protocol string
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocolPort number
    Specifies the port used by the listener. Changing this creates a new Listener.
    accessLogCustomizedHeadersConfig LbListenerV3AccessLogCustomizedHeadersConfig
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    adminStateUp boolean
    advancedForwarding boolean
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    clientCaTlsContainerRef string
    Specifies the ID of the CA certificate used by the listener.
    clientTimeout number
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    defaultPoolId string
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    defaultTlsContainerRef string
    Specifies the ID of the server certificate used by the listener.
    description string
    Provides supplementary information about the listener.
    http2Enable boolean
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insertHeaders LbListenerV3InsertHeaders
    Specifies the HTTP header fields.
    ipGroup LbListenerV3IpGroup
    Specifies the IP address group associated with the listener.
    keepAliveTimeout number
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lbListenerV3Id string
    memberRetryEnable boolean
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    memberTimeout number
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name string
    Specifies the listener name.
    protectionReason string
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protectionStatus string
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    securityPolicyId string
    Specifies the ID of the custom security policy.
    sniContainerRefs string[]
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sniMatchAlgo string
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags {[key: string]: string}
    Tags key/value pairs to associate with the loadbalancer listener.
    tlsCiphersPolicy string
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    loadbalancer_id str
    Specifies the ID of the load balancer that the listener is added to.
    protocol str
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocol_port float
    Specifies the port used by the listener. Changing this creates a new Listener.
    access_log_customized_headers_config LbListenerV3AccessLogCustomizedHeadersConfigArgs
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    admin_state_up bool
    advanced_forwarding bool
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    client_ca_tls_container_ref str
    Specifies the ID of the CA certificate used by the listener.
    client_timeout float
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    default_pool_id str
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    default_tls_container_ref str
    Specifies the ID of the server certificate used by the listener.
    description str
    Provides supplementary information about the listener.
    http2_enable bool
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insert_headers LbListenerV3InsertHeadersArgs
    Specifies the HTTP header fields.
    ip_group LbListenerV3IpGroupArgs
    Specifies the IP address group associated with the listener.
    keep_alive_timeout float
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lb_listener_v3_id str
    member_retry_enable bool
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    member_timeout float
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name str
    Specifies the listener name.
    protection_reason str
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protection_status str
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    security_policy_id str
    Specifies the ID of the custom security policy.
    sni_container_refs Sequence[str]
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sni_match_algo str
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags Mapping[str, str]
    Tags key/value pairs to associate with the loadbalancer listener.
    tls_ciphers_policy str
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    loadbalancerId String
    Specifies the ID of the load balancer that the listener is added to.
    protocol String
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocolPort Number
    Specifies the port used by the listener. Changing this creates a new Listener.
    accessLogCustomizedHeadersConfig Property Map
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    adminStateUp Boolean
    advancedForwarding Boolean
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    clientCaTlsContainerRef String
    Specifies the ID of the CA certificate used by the listener.
    clientTimeout Number
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    defaultPoolId String
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    defaultTlsContainerRef String
    Specifies the ID of the server certificate used by the listener.
    description String
    Provides supplementary information about the listener.
    http2Enable Boolean
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insertHeaders Property Map
    Specifies the HTTP header fields.
    ipGroup Property Map
    Specifies the IP address group associated with the listener.
    keepAliveTimeout Number
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lbListenerV3Id String
    memberRetryEnable Boolean
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    memberTimeout Number
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name String
    Specifies the listener name.
    protectionReason String
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protectionStatus String
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    securityPolicyId String
    Specifies the ID of the custom security policy.
    sniContainerRefs List<String>
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sniMatchAlgo String
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags Map<String>
    Tags key/value pairs to associate with the loadbalancer listener.
    tlsCiphersPolicy String
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.

    Outputs

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

    Cps double
    Specifies the maximum number of new connections that a listener can handle per second.
    CreatedAt string
    Indicates the creation time.
    GzipEnable bool
    Specifies whether GZIP compression is enabled for the load balancer.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxConnections double
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    Nat64Enable bool
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    ProxyProtocolEnable bool
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    QuicConfigs List<LbListenerV3QuicConfig>
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    TracingConfigs List<LbListenerV3TracingConfig>
    Specifies the open tracing configuration.
    UpdatedAt string
    Indicates the update time.
    Cps float64
    Specifies the maximum number of new connections that a listener can handle per second.
    CreatedAt string
    Indicates the creation time.
    GzipEnable bool
    Specifies whether GZIP compression is enabled for the load balancer.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxConnections float64
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    Nat64Enable bool
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    ProxyProtocolEnable bool
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    QuicConfigs []LbListenerV3QuicConfig
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    TracingConfigs []LbListenerV3TracingConfig
    Specifies the open tracing configuration.
    UpdatedAt string
    Indicates the update time.
    cps number
    Specifies the maximum number of new connections that a listener can handle per second.
    created_at string
    Indicates the creation time.
    gzip_enable bool
    Specifies whether GZIP compression is enabled for the load balancer.
    id string
    The provider-assigned unique ID for this managed resource.
    max_connections number
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    nat64_enable bool
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    proxy_protocol_enable bool
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quic_configs list(object)
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    tracing_configs list(object)
    Specifies the open tracing configuration.
    updated_at string
    Indicates the update time.
    cps Double
    Specifies the maximum number of new connections that a listener can handle per second.
    createdAt String
    Indicates the creation time.
    gzipEnable Boolean
    Specifies whether GZIP compression is enabled for the load balancer.
    id String
    The provider-assigned unique ID for this managed resource.
    maxConnections Double
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    nat64Enable Boolean
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    proxyProtocolEnable Boolean
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quicConfigs List<LbListenerV3QuicConfig>
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    tracingConfigs List<LbListenerV3TracingConfig>
    Specifies the open tracing configuration.
    updatedAt String
    Indicates the update time.
    cps number
    Specifies the maximum number of new connections that a listener can handle per second.
    createdAt string
    Indicates the creation time.
    gzipEnable boolean
    Specifies whether GZIP compression is enabled for the load balancer.
    id string
    The provider-assigned unique ID for this managed resource.
    maxConnections number
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    nat64Enable boolean
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    proxyProtocolEnable boolean
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quicConfigs LbListenerV3QuicConfig[]
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    tracingConfigs LbListenerV3TracingConfig[]
    Specifies the open tracing configuration.
    updatedAt string
    Indicates the update time.
    cps float
    Specifies the maximum number of new connections that a listener can handle per second.
    created_at str
    Indicates the creation time.
    gzip_enable bool
    Specifies whether GZIP compression is enabled for the load balancer.
    id str
    The provider-assigned unique ID for this managed resource.
    max_connections float
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    nat64_enable bool
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    proxy_protocol_enable bool
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quic_configs Sequence[LbListenerV3QuicConfig]
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    tracing_configs Sequence[LbListenerV3TracingConfig]
    Specifies the open tracing configuration.
    updated_at str
    Indicates the update time.
    cps Number
    Specifies the maximum number of new connections that a listener can handle per second.
    createdAt String
    Indicates the creation time.
    gzipEnable Boolean
    Specifies whether GZIP compression is enabled for the load balancer.
    id String
    The provider-assigned unique ID for this managed resource.
    maxConnections Number
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    nat64Enable Boolean
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    proxyProtocolEnable Boolean
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quicConfigs List<Property Map>
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    tracingConfigs List<Property Map>
    Specifies the open tracing configuration.
    updatedAt String
    Indicates the update time.

    Look up Existing LbListenerV3 Resource

    Get an existing LbListenerV3 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?: LbListenerV3State, opts?: CustomResourceOptions): LbListenerV3
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_log_customized_headers_config: Optional[LbListenerV3AccessLogCustomizedHeadersConfigArgs] = None,
            admin_state_up: Optional[bool] = None,
            advanced_forwarding: Optional[bool] = None,
            client_ca_tls_container_ref: Optional[str] = None,
            client_timeout: Optional[float] = None,
            cps: Optional[float] = None,
            created_at: Optional[str] = None,
            default_pool_id: Optional[str] = None,
            default_tls_container_ref: Optional[str] = None,
            description: Optional[str] = None,
            gzip_enable: Optional[bool] = None,
            http2_enable: Optional[bool] = None,
            insert_headers: Optional[LbListenerV3InsertHeadersArgs] = None,
            ip_group: Optional[LbListenerV3IpGroupArgs] = None,
            keep_alive_timeout: Optional[float] = None,
            lb_listener_v3_id: Optional[str] = None,
            loadbalancer_id: Optional[str] = None,
            max_connections: Optional[float] = None,
            member_retry_enable: Optional[bool] = None,
            member_timeout: Optional[float] = None,
            name: Optional[str] = None,
            nat64_enable: Optional[bool] = None,
            protection_reason: Optional[str] = None,
            protection_status: Optional[str] = None,
            protocol: Optional[str] = None,
            protocol_port: Optional[float] = None,
            proxy_protocol_enable: Optional[bool] = None,
            quic_configs: Optional[Sequence[LbListenerV3QuicConfigArgs]] = None,
            security_policy_id: Optional[str] = None,
            sni_container_refs: Optional[Sequence[str]] = None,
            sni_match_algo: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tls_ciphers_policy: Optional[str] = None,
            tracing_configs: Optional[Sequence[LbListenerV3TracingConfigArgs]] = None,
            updated_at: Optional[str] = None) -> LbListenerV3
    func GetLbListenerV3(ctx *Context, name string, id IDInput, state *LbListenerV3State, opts ...ResourceOption) (*LbListenerV3, error)
    public static LbListenerV3 Get(string name, Input<string> id, LbListenerV3State? state, CustomResourceOptions? opts = null)
    public static LbListenerV3 get(String name, Output<String> id, LbListenerV3State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:LbListenerV3    get:      id: ${id}
    import {
      to = opentelekomcloud_lb_listener_v3.example
      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:
    AccessLogCustomizedHeadersConfig LbListenerV3AccessLogCustomizedHeadersConfig
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    AdminStateUp bool
    AdvancedForwarding bool
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    ClientCaTlsContainerRef string
    Specifies the ID of the CA certificate used by the listener.
    ClientTimeout double
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    Cps double
    Specifies the maximum number of new connections that a listener can handle per second.
    CreatedAt string
    Indicates the creation time.
    DefaultPoolId string
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    DefaultTlsContainerRef string
    Specifies the ID of the server certificate used by the listener.
    Description string
    Provides supplementary information about the listener.
    GzipEnable bool
    Specifies whether GZIP compression is enabled for the load balancer.
    Http2Enable bool
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    InsertHeaders LbListenerV3InsertHeaders
    Specifies the HTTP header fields.
    IpGroup LbListenerV3IpGroup
    Specifies the IP address group associated with the listener.
    KeepAliveTimeout double
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    LbListenerV3Id string
    LoadbalancerId string
    Specifies the ID of the load balancer that the listener is added to.
    MaxConnections double
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    MemberRetryEnable bool
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    MemberTimeout double
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    Name string
    Specifies the listener name.
    Nat64Enable bool
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    ProtectionReason string
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    ProtectionStatus string
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    Protocol string
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    ProtocolPort double
    Specifies the port used by the listener. Changing this creates a new Listener.
    ProxyProtocolEnable bool
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    QuicConfigs List<LbListenerV3QuicConfig>
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    SecurityPolicyId string
    Specifies the ID of the custom security policy.
    SniContainerRefs List<string>
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    SniMatchAlgo string
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    Tags Dictionary<string, string>
    Tags key/value pairs to associate with the loadbalancer listener.
    TlsCiphersPolicy string
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    TracingConfigs List<LbListenerV3TracingConfig>
    Specifies the open tracing configuration.
    UpdatedAt string
    Indicates the update time.
    AccessLogCustomizedHeadersConfig LbListenerV3AccessLogCustomizedHeadersConfigArgs
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    AdminStateUp bool
    AdvancedForwarding bool
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    ClientCaTlsContainerRef string
    Specifies the ID of the CA certificate used by the listener.
    ClientTimeout float64
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    Cps float64
    Specifies the maximum number of new connections that a listener can handle per second.
    CreatedAt string
    Indicates the creation time.
    DefaultPoolId string
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    DefaultTlsContainerRef string
    Specifies the ID of the server certificate used by the listener.
    Description string
    Provides supplementary information about the listener.
    GzipEnable bool
    Specifies whether GZIP compression is enabled for the load balancer.
    Http2Enable bool
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    InsertHeaders LbListenerV3InsertHeadersArgs
    Specifies the HTTP header fields.
    IpGroup LbListenerV3IpGroupArgs
    Specifies the IP address group associated with the listener.
    KeepAliveTimeout float64
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    LbListenerV3Id string
    LoadbalancerId string
    Specifies the ID of the load balancer that the listener is added to.
    MaxConnections float64
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    MemberRetryEnable bool
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    MemberTimeout float64
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    Name string
    Specifies the listener name.
    Nat64Enable bool
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    ProtectionReason string
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    ProtectionStatus string
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    Protocol string
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    ProtocolPort float64
    Specifies the port used by the listener. Changing this creates a new Listener.
    ProxyProtocolEnable bool
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    QuicConfigs []LbListenerV3QuicConfigArgs
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    SecurityPolicyId string
    Specifies the ID of the custom security policy.
    SniContainerRefs []string
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    SniMatchAlgo string
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    Tags map[string]string
    Tags key/value pairs to associate with the loadbalancer listener.
    TlsCiphersPolicy string
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    TracingConfigs []LbListenerV3TracingConfigArgs
    Specifies the open tracing configuration.
    UpdatedAt string
    Indicates the update time.
    access_log_customized_headers_config object
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    admin_state_up bool
    advanced_forwarding bool
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    client_ca_tls_container_ref string
    Specifies the ID of the CA certificate used by the listener.
    client_timeout number
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    cps number
    Specifies the maximum number of new connections that a listener can handle per second.
    created_at string
    Indicates the creation time.
    default_pool_id string
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    default_tls_container_ref string
    Specifies the ID of the server certificate used by the listener.
    description string
    Provides supplementary information about the listener.
    gzip_enable bool
    Specifies whether GZIP compression is enabled for the load balancer.
    http2_enable bool
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insert_headers object
    Specifies the HTTP header fields.
    ip_group object
    Specifies the IP address group associated with the listener.
    keep_alive_timeout number
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lb_listener_v3_id string
    loadbalancer_id string
    Specifies the ID of the load balancer that the listener is added to.
    max_connections number
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    member_retry_enable bool
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    member_timeout number
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name string
    Specifies the listener name.
    nat64_enable bool
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    protection_reason string
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protection_status string
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    protocol string
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocol_port number
    Specifies the port used by the listener. Changing this creates a new Listener.
    proxy_protocol_enable bool
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quic_configs list(object)
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    security_policy_id string
    Specifies the ID of the custom security policy.
    sni_container_refs list(string)
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sni_match_algo string
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags map(string)
    Tags key/value pairs to associate with the loadbalancer listener.
    tls_ciphers_policy string
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    tracing_configs list(object)
    Specifies the open tracing configuration.
    updated_at string
    Indicates the update time.
    accessLogCustomizedHeadersConfig LbListenerV3AccessLogCustomizedHeadersConfig
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    adminStateUp Boolean
    advancedForwarding Boolean
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    clientCaTlsContainerRef String
    Specifies the ID of the CA certificate used by the listener.
    clientTimeout Double
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    cps Double
    Specifies the maximum number of new connections that a listener can handle per second.
    createdAt String
    Indicates the creation time.
    defaultPoolId String
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    defaultTlsContainerRef String
    Specifies the ID of the server certificate used by the listener.
    description String
    Provides supplementary information about the listener.
    gzipEnable Boolean
    Specifies whether GZIP compression is enabled for the load balancer.
    http2Enable Boolean
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insertHeaders LbListenerV3InsertHeaders
    Specifies the HTTP header fields.
    ipGroup LbListenerV3IpGroup
    Specifies the IP address group associated with the listener.
    keepAliveTimeout Double
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lbListenerV3Id String
    loadbalancerId String
    Specifies the ID of the load balancer that the listener is added to.
    maxConnections Double
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    memberRetryEnable Boolean
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    memberTimeout Double
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name String
    Specifies the listener name.
    nat64Enable Boolean
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    protectionReason String
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protectionStatus String
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    protocol String
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocolPort Double
    Specifies the port used by the listener. Changing this creates a new Listener.
    proxyProtocolEnable Boolean
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quicConfigs List<LbListenerV3QuicConfig>
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    securityPolicyId String
    Specifies the ID of the custom security policy.
    sniContainerRefs List<String>
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sniMatchAlgo String
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags Map<String,String>
    Tags key/value pairs to associate with the loadbalancer listener.
    tlsCiphersPolicy String
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    tracingConfigs List<LbListenerV3TracingConfig>
    Specifies the open tracing configuration.
    updatedAt String
    Indicates the update time.
    accessLogCustomizedHeadersConfig LbListenerV3AccessLogCustomizedHeadersConfig
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    adminStateUp boolean
    advancedForwarding boolean
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    clientCaTlsContainerRef string
    Specifies the ID of the CA certificate used by the listener.
    clientTimeout number
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    cps number
    Specifies the maximum number of new connections that a listener can handle per second.
    createdAt string
    Indicates the creation time.
    defaultPoolId string
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    defaultTlsContainerRef string
    Specifies the ID of the server certificate used by the listener.
    description string
    Provides supplementary information about the listener.
    gzipEnable boolean
    Specifies whether GZIP compression is enabled for the load balancer.
    http2Enable boolean
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insertHeaders LbListenerV3InsertHeaders
    Specifies the HTTP header fields.
    ipGroup LbListenerV3IpGroup
    Specifies the IP address group associated with the listener.
    keepAliveTimeout number
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lbListenerV3Id string
    loadbalancerId string
    Specifies the ID of the load balancer that the listener is added to.
    maxConnections number
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    memberRetryEnable boolean
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    memberTimeout number
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name string
    Specifies the listener name.
    nat64Enable boolean
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    protectionReason string
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protectionStatus string
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    protocol string
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocolPort number
    Specifies the port used by the listener. Changing this creates a new Listener.
    proxyProtocolEnable boolean
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quicConfigs LbListenerV3QuicConfig[]
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    securityPolicyId string
    Specifies the ID of the custom security policy.
    sniContainerRefs string[]
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sniMatchAlgo string
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags {[key: string]: string}
    Tags key/value pairs to associate with the loadbalancer listener.
    tlsCiphersPolicy string
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    tracingConfigs LbListenerV3TracingConfig[]
    Specifies the open tracing configuration.
    updatedAt string
    Indicates the update time.
    access_log_customized_headers_config LbListenerV3AccessLogCustomizedHeadersConfigArgs
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    admin_state_up bool
    advanced_forwarding bool
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    client_ca_tls_container_ref str
    Specifies the ID of the CA certificate used by the listener.
    client_timeout float
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    cps float
    Specifies the maximum number of new connections that a listener can handle per second.
    created_at str
    Indicates the creation time.
    default_pool_id str
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    default_tls_container_ref str
    Specifies the ID of the server certificate used by the listener.
    description str
    Provides supplementary information about the listener.
    gzip_enable bool
    Specifies whether GZIP compression is enabled for the load balancer.
    http2_enable bool
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insert_headers LbListenerV3InsertHeadersArgs
    Specifies the HTTP header fields.
    ip_group LbListenerV3IpGroupArgs
    Specifies the IP address group associated with the listener.
    keep_alive_timeout float
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lb_listener_v3_id str
    loadbalancer_id str
    Specifies the ID of the load balancer that the listener is added to.
    max_connections float
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    member_retry_enable bool
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    member_timeout float
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name str
    Specifies the listener name.
    nat64_enable bool
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    protection_reason str
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protection_status str
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    protocol str
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocol_port float
    Specifies the port used by the listener. Changing this creates a new Listener.
    proxy_protocol_enable bool
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quic_configs Sequence[LbListenerV3QuicConfigArgs]
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    security_policy_id str
    Specifies the ID of the custom security policy.
    sni_container_refs Sequence[str]
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sni_match_algo str
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags Mapping[str, str]
    Tags key/value pairs to associate with the loadbalancer listener.
    tls_ciphers_policy str
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    tracing_configs Sequence[LbListenerV3TracingConfigArgs]
    Specifies the open tracing configuration.
    updated_at str
    Indicates the update time.
    accessLogCustomizedHeadersConfig Property Map
    Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
    adminStateUp Boolean
    advancedForwarding Boolean
    Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false. Changing this creates a new Listener.
    clientCaTlsContainerRef String
    Specifies the ID of the CA certificate used by the listener.
    clientTimeout Number
    Specifies the timeout duration for waiting for a request from a client, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    cps Number
    Specifies the maximum number of new connections that a listener can handle per second.
    createdAt String
    Indicates the creation time.
    defaultPoolId String
    Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
    defaultTlsContainerRef String
    Specifies the ID of the server certificate used by the listener.
    description String
    Provides supplementary information about the listener.
    gzipEnable Boolean
    Specifies whether GZIP compression is enabled for the load balancer.
    http2Enable Boolean
    Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.
    insertHeaders Property Map
    Specifies the HTTP header fields.
    ipGroup Property Map
    Specifies the IP address group associated with the listener.
    keepAliveTimeout Number
    Specifies the idle timeout duration, in seconds.

    • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.
    • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.
    • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.
    lbListenerV3Id String
    loadbalancerId String
    Specifies the ID of the load balancer that the listener is added to.
    maxConnections Number
    Specifies the maximum number of concurrent connections that a listener can handle per second.
    memberRetryEnable Boolean
    Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners. An error will be returned if you configure this parameter for TCP and UDP listeners.
    memberTimeout Number
    Specifies the timeout duration for waiting for a request from a backend server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. An error will be returned if you configure this parameter for TCP and UDP listeners.
    name String
    Specifies the listener name.
    nat64Enable Boolean
    Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.
    protectionReason String
    Specifies why the modification protection is enabled. Valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>).
    protectionStatus String
    Specifies the protection status. Value options: nonProtection (default, not protected), consoleProtection (modification protection is enabled on the console).
    protocol String
    The protocol - can either be TCP, HTTP, HTTPS or UDP. Changing this creates a new Listener.
    protocolPort Number
    Specifies the port used by the listener. Changing this creates a new Listener.
    proxyProtocolEnable Boolean
    Specifies whether ProxyProtocol is enabled to pass the source IP addresses of the clients to backend servers.
    quicConfigs List<Property Map>
    Specifies the QUIC configuration for the current listener. Valid only when protocol is set to HTTPS.
    securityPolicyId String
    Specifies the ID of the custom security policy.
    sniContainerRefs List<String>
    Lists the IDs of SNI certificates (server certificates with domain names) used by the listener. Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique. This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.
    sniMatchAlgo String
    Specifies how wildcard domain name matches with the SNI certificates used by the listener.
    tags Map<String>
    Tags key/value pairs to associate with the loadbalancer listener.
    tlsCiphersPolicy String
    Specifies the security policy that will be used by the listener. This parameter is available only for HTTPS listeners. An error will be returned if the protocol of the listener is not HTTPS. Possible values are: tls-1-0, tls-1-1, tls-1-0-inherit, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc.
    tracingConfigs List<Property Map>
    Specifies the open tracing configuration.
    updatedAt String
    Indicates the update time.

    Supporting Types

    LbListenerV3AccessLogCustomizedHeadersConfig, LbListenerV3AccessLogCustomizedHeadersConfigArgs

    Enable bool
    Specifies whether to enable custom access log headers.
    ExcludeHeaders List<string>
    Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.
    IncludeHeaders List<string>
    Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.
    Enable bool
    Specifies whether to enable custom access log headers.
    ExcludeHeaders []string
    Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.
    IncludeHeaders []string
    Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.
    enable bool
    Specifies whether to enable custom access log headers.
    exclude_headers list(string)
    Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.
    include_headers list(string)
    Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.
    enable Boolean
    Specifies whether to enable custom access log headers.
    excludeHeaders List<String>
    Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.
    includeHeaders List<String>
    Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.
    enable boolean
    Specifies whether to enable custom access log headers.
    excludeHeaders string[]
    Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.
    includeHeaders string[]
    Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.
    enable bool
    Specifies whether to enable custom access log headers.
    exclude_headers Sequence[str]
    Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.
    include_headers Sequence[str]
    Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.
    enable Boolean
    Specifies whether to enable custom access log headers.
    excludeHeaders List<String>
    Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.
    includeHeaders List<String>
    Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.

    LbListenerV3InsertHeaders, LbListenerV3InsertHeadersArgs

    ForwardElbIp bool
    Specifies whether to transparently transmit the load balancer EIP to backend servers. If forward_elb_ip is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.
    ForwardedForPort bool
    Specifies whether to transparently transmit the source port of the client to backend servers. If forwarded_for_port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.
    ForwardedHost bool
    Specifies whether to rewrite the X-Forwarded-Host header. If forwarded_host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.
    ForwardedPort bool
    Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If forwarded_port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
    ForwardElbIp bool
    Specifies whether to transparently transmit the load balancer EIP to backend servers. If forward_elb_ip is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.
    ForwardedForPort bool
    Specifies whether to transparently transmit the source port of the client to backend servers. If forwarded_for_port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.
    ForwardedHost bool
    Specifies whether to rewrite the X-Forwarded-Host header. If forwarded_host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.
    ForwardedPort bool
    Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If forwarded_port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
    forward_elb_ip bool
    Specifies whether to transparently transmit the load balancer EIP to backend servers. If forward_elb_ip is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.
    forwarded_for_port bool
    Specifies whether to transparently transmit the source port of the client to backend servers. If forwarded_for_port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.
    forwarded_host bool
    Specifies whether to rewrite the X-Forwarded-Host header. If forwarded_host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.
    forwarded_port bool
    Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If forwarded_port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
    forwardElbIp Boolean
    Specifies whether to transparently transmit the load balancer EIP to backend servers. If forward_elb_ip is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.
    forwardedForPort Boolean
    Specifies whether to transparently transmit the source port of the client to backend servers. If forwarded_for_port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.
    forwardedHost Boolean
    Specifies whether to rewrite the X-Forwarded-Host header. If forwarded_host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.
    forwardedPort Boolean
    Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If forwarded_port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
    forwardElbIp boolean
    Specifies whether to transparently transmit the load balancer EIP to backend servers. If forward_elb_ip is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.
    forwardedForPort boolean
    Specifies whether to transparently transmit the source port of the client to backend servers. If forwarded_for_port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.
    forwardedHost boolean
    Specifies whether to rewrite the X-Forwarded-Host header. If forwarded_host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.
    forwardedPort boolean
    Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If forwarded_port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
    forward_elb_ip bool
    Specifies whether to transparently transmit the load balancer EIP to backend servers. If forward_elb_ip is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.
    forwarded_for_port bool
    Specifies whether to transparently transmit the source port of the client to backend servers. If forwarded_for_port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.
    forwarded_host bool
    Specifies whether to rewrite the X-Forwarded-Host header. If forwarded_host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.
    forwarded_port bool
    Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If forwarded_port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
    forwardElbIp Boolean
    Specifies whether to transparently transmit the load balancer EIP to backend servers. If forward_elb_ip is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.
    forwardedForPort Boolean
    Specifies whether to transparently transmit the source port of the client to backend servers. If forwarded_for_port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.
    forwardedHost Boolean
    Specifies whether to rewrite the X-Forwarded-Host header. If forwarded_host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.
    forwardedPort Boolean
    Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If forwarded_port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

    LbListenerV3IpGroup, LbListenerV3IpGroupArgs

    Id string
    Specifies the ID of the IP address group associated with the listener. Specifies the ID of the IP address group associated with the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to whitelist, no IP addresses are allowed to access the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to blacklist, any IP address is allowed to access the listener.
    Enable bool
    Specifies whether to enable access control. true: Access control will be enabled. false (default): Access control will be disabled.
    Type string
    Specifies how access to the listener is controlled. white (default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener. black: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
    Id string
    Specifies the ID of the IP address group associated with the listener. Specifies the ID of the IP address group associated with the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to whitelist, no IP addresses are allowed to access the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to blacklist, any IP address is allowed to access the listener.
    Enable bool
    Specifies whether to enable access control. true: Access control will be enabled. false (default): Access control will be disabled.
    Type string
    Specifies how access to the listener is controlled. white (default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener. black: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
    id string
    Specifies the ID of the IP address group associated with the listener. Specifies the ID of the IP address group associated with the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to whitelist, no IP addresses are allowed to access the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to blacklist, any IP address is allowed to access the listener.
    enable bool
    Specifies whether to enable access control. true: Access control will be enabled. false (default): Access control will be disabled.
    type string
    Specifies how access to the listener is controlled. white (default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener. black: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
    id String
    Specifies the ID of the IP address group associated with the listener. Specifies the ID of the IP address group associated with the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to whitelist, no IP addresses are allowed to access the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to blacklist, any IP address is allowed to access the listener.
    enable Boolean
    Specifies whether to enable access control. true: Access control will be enabled. false (default): Access control will be disabled.
    type String
    Specifies how access to the listener is controlled. white (default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener. black: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
    id string
    Specifies the ID of the IP address group associated with the listener. Specifies the ID of the IP address group associated with the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to whitelist, no IP addresses are allowed to access the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to blacklist, any IP address is allowed to access the listener.
    enable boolean
    Specifies whether to enable access control. true: Access control will be enabled. false (default): Access control will be disabled.
    type string
    Specifies how access to the listener is controlled. white (default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener. black: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
    id str
    Specifies the ID of the IP address group associated with the listener. Specifies the ID of the IP address group associated with the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to whitelist, no IP addresses are allowed to access the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to blacklist, any IP address is allowed to access the listener.
    enable bool
    Specifies whether to enable access control. true: Access control will be enabled. false (default): Access control will be disabled.
    type str
    Specifies how access to the listener is controlled. white (default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener. black: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
    id String
    Specifies the ID of the IP address group associated with the listener. Specifies the ID of the IP address group associated with the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to whitelist, no IP addresses are allowed to access the listener. If ip_list in opentelekomcloud.LbIpgroupV3 is set to an empty array [] and type to blacklist, any IP address is allowed to access the listener.
    enable Boolean
    Specifies whether to enable access control. true: Access control will be enabled. false (default): Access control will be disabled.
    type String
    Specifies how access to the listener is controlled. white (default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener. black: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.

    LbListenerV3QuicConfig, LbListenerV3QuicConfigArgs

    EnableQuicUpgrade bool
    Specifies whether QUIC upgrade is enabled.
    QuicListenerId string
    Specifies the ID of the QUIC listener.
    EnableQuicUpgrade bool
    Specifies whether QUIC upgrade is enabled.
    QuicListenerId string
    Specifies the ID of the QUIC listener.
    enable_quic_upgrade bool
    Specifies whether QUIC upgrade is enabled.
    quic_listener_id string
    Specifies the ID of the QUIC listener.
    enableQuicUpgrade Boolean
    Specifies whether QUIC upgrade is enabled.
    quicListenerId String
    Specifies the ID of the QUIC listener.
    enableQuicUpgrade boolean
    Specifies whether QUIC upgrade is enabled.
    quicListenerId string
    Specifies the ID of the QUIC listener.
    enable_quic_upgrade bool
    Specifies whether QUIC upgrade is enabled.
    quic_listener_id str
    Specifies the ID of the QUIC listener.
    enableQuicUpgrade Boolean
    Specifies whether QUIC upgrade is enabled.
    quicListenerId String
    Specifies the ID of the QUIC listener.

    LbListenerV3TracingConfig, LbListenerV3TracingConfigArgs

    TracingEnable bool
    Specifies whether open tracing is enabled.
    TracingSample double
    Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01% to 100%.
    TracingStrategy string
    Specifies the sampling mode. Value options: full (full sampling), ratio (sampling by ratio).
    TracingType string
    Specifies the tracing type. Value: W3CTraceContext.
    TracingEnable bool
    Specifies whether open tracing is enabled.
    TracingSample float64
    Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01% to 100%.
    TracingStrategy string
    Specifies the sampling mode. Value options: full (full sampling), ratio (sampling by ratio).
    TracingType string
    Specifies the tracing type. Value: W3CTraceContext.
    tracing_enable bool
    Specifies whether open tracing is enabled.
    tracing_sample number
    Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01% to 100%.
    tracing_strategy string
    Specifies the sampling mode. Value options: full (full sampling), ratio (sampling by ratio).
    tracing_type string
    Specifies the tracing type. Value: W3CTraceContext.
    tracingEnable Boolean
    Specifies whether open tracing is enabled.
    tracingSample Double
    Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01% to 100%.
    tracingStrategy String
    Specifies the sampling mode. Value options: full (full sampling), ratio (sampling by ratio).
    tracingType String
    Specifies the tracing type. Value: W3CTraceContext.
    tracingEnable boolean
    Specifies whether open tracing is enabled.
    tracingSample number
    Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01% to 100%.
    tracingStrategy string
    Specifies the sampling mode. Value options: full (full sampling), ratio (sampling by ratio).
    tracingType string
    Specifies the tracing type. Value: W3CTraceContext.
    tracing_enable bool
    Specifies whether open tracing is enabled.
    tracing_sample float
    Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01% to 100%.
    tracing_strategy str
    Specifies the sampling mode. Value options: full (full sampling), ratio (sampling by ratio).
    tracing_type str
    Specifies the tracing type. Value: W3CTraceContext.
    tracingEnable Boolean
    Specifies whether open tracing is enabled.
    tracingSample Number
    Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01% to 100%.
    tracingStrategy String
    Specifies the sampling mode. Value options: full (full sampling), ratio (sampling by ratio).
    tracingType String
    Specifies the tracing type. Value: W3CTraceContext.

    Import

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

    $ pulumi import opentelekomcloud:index/lbListenerV3:LbListenerV3 listener_1 7117d38e-4c8f-4624-a505-bd96b97d024c
    

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

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud
    Viewing docs for opentelekomcloud 1.37.11
    published on Friday, Oct 23, 2026 by opentelekomcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial