Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vkcs Provider
  3. API Docs
  4. LbListener
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

vkcs.LbListener

Explore with Pulumi AI

vkcs logo
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

    Manages a listener resource within VKCS.

    Example Usage

    Listener for HTTP

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

const appHttp = new vkcs.LbListener("appHttp", {
    description: "Listener for resources/datasources testing",
    loadbalancerId: vkcs_lb_loadbalancer.app.id,
    protocol: "HTTP",
    protocolPort: 8080,
});

    import pulumi
import pulumi_vkcs as vkcs

app_http = vkcs.LbListener("appHttp",
    description="Listener for resources/datasources testing",
    loadbalancer_id=vkcs_lb_loadbalancer["app"]["id"],
    protocol="HTTP",
    protocol_port=8080)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.NewLbListener(ctx, "appHttp", &vkcs.LbListenerArgs{
			Description:    pulumi.String("Listener for resources/datasources testing"),
			LoadbalancerId: pulumi.Any(vkcs_lb_loadbalancer.App.Id),
			Protocol:       pulumi.String("HTTP"),
			ProtocolPort:   pulumi.Float64(8080),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var appHttp = new Vkcs.LbListener("appHttp", new()
    {
        Description = "Listener for resources/datasources testing",
        LoadbalancerId = vkcs_lb_loadbalancer.App.Id,
        Protocol = "HTTP",
        ProtocolPort = 8080,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.LbListener;
import com.pulumi.vkcs.LbListenerArgs;
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 appHttp = new LbListener("appHttp", LbListenerArgs.builder()
            .description("Listener for resources/datasources testing")
            .loadbalancerId(vkcs_lb_loadbalancer.app().id())
            .protocol("HTTP")
            .protocolPort(8080)
            .build());

    }
}

    resources:
  appHttp:
    type: vkcs:LbListener
    properties:
      description: Listener for resources/datasources testing
      loadbalancerId: ${vkcs_lb_loadbalancer.app.id}
      protocol: HTTP
      protocolPort: 8080

    Listener for TERMINATED_HTTPS

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

const appTerminatedHttps = new vkcs.LbListener("appTerminatedHttps", {
    description: "Listener for resources/datasources testing",
    protocol: "TERMINATED_HTTPS",
    protocolPort: 8443,
    loadbalancerId: vkcs_lb_loadbalancer.app.id,
    defaultTlsContainerRef: vkcs_keymanager_container.lb_cert.container_ref,
});

    import pulumi
import pulumi_vkcs as vkcs

app_terminated_https = vkcs.LbListener("appTerminatedHttps",
    description="Listener for resources/datasources testing",
    protocol="TERMINATED_HTTPS",
    protocol_port=8443,
    loadbalancer_id=vkcs_lb_loadbalancer["app"]["id"],
    default_tls_container_ref=vkcs_keymanager_container["lb_cert"]["container_ref"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.NewLbListener(ctx, "appTerminatedHttps", &vkcs.LbListenerArgs{
			Description:            pulumi.String("Listener for resources/datasources testing"),
			Protocol:               pulumi.String("TERMINATED_HTTPS"),
			ProtocolPort:           pulumi.Float64(8443),
			LoadbalancerId:         pulumi.Any(vkcs_lb_loadbalancer.App.Id),
			DefaultTlsContainerRef: pulumi.Any(vkcs_keymanager_container.Lb_cert.Container_ref),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var appTerminatedHttps = new Vkcs.LbListener("appTerminatedHttps", new()
    {
        Description = "Listener for resources/datasources testing",
        Protocol = "TERMINATED_HTTPS",
        ProtocolPort = 8443,
        LoadbalancerId = vkcs_lb_loadbalancer.App.Id,
        DefaultTlsContainerRef = vkcs_keymanager_container.Lb_cert.Container_ref,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.LbListener;
import com.pulumi.vkcs.LbListenerArgs;
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 appTerminatedHttps = new LbListener("appTerminatedHttps", LbListenerArgs.builder()
            .description("Listener for resources/datasources testing")
            .protocol("TERMINATED_HTTPS")
            .protocolPort(8443)
            .loadbalancerId(vkcs_lb_loadbalancer.app().id())
            .defaultTlsContainerRef(vkcs_keymanager_container.lb_cert().container_ref())
            .build());

    }
}

    resources:
  appTerminatedHttps:
    type: vkcs:LbListener
    properties:
      description: Listener for resources/datasources testing
      protocol: TERMINATED_HTTPS
      protocolPort: 8443
      loadbalancerId: ${vkcs_lb_loadbalancer.app.id}
      defaultTlsContainerRef: ${vkcs_keymanager_container.lb_cert.container_ref}

    Create LbListener Resource

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

    Constructor syntax

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

@overload
def LbListener(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               loadbalancer_id: Optional[str] = None,
               protocol_port: Optional[float] = None,
               protocol: Optional[str] = None,
               default_tls_container_ref: Optional[str] = None,
               connection_limit: Optional[float] = None,
               description: Optional[str] = None,
               insert_headers: Optional[Mapping[str, str]] = None,
               lb_listener_id: Optional[str] = None,
               default_pool_id: Optional[str] = None,
               name: Optional[str] = None,
               admin_state_up: Optional[bool] = None,
               allowed_cidrs: Optional[Sequence[str]] = None,
               region: Optional[str] = None,
               sni_container_refs: Optional[Sequence[str]] = None,
               timeout_client_data: Optional[float] = None,
               timeout_member_connect: Optional[float] = None,
               timeout_member_data: Optional[float] = None,
               timeout_tcp_inspect: Optional[float] = None,
               timeouts: Optional[LbListenerTimeoutsArgs] = None)
    func NewLbListener(ctx *Context, name string, args LbListenerArgs, opts ...ResourceOption) (*LbListener, error)
    public LbListener(string name, LbListenerArgs args, CustomResourceOptions? opts = null)
    public LbListener(String name, LbListenerArgs args)
public LbListener(String name, LbListenerArgs args, CustomResourceOptions options)

    type: vkcs:LbListener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LbListenerArgs
    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 LbListenerArgs
    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 LbListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbListenerArgs
    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 lbListenerResource = new Vkcs.LbListener("lbListenerResource", new()
{
    LoadbalancerId = "string",
    ProtocolPort = 0,
    Protocol = "string",
    DefaultTlsContainerRef = "string",
    ConnectionLimit = 0,
    Description = "string",
    InsertHeaders = 
    {
        { "string", "string" },
    },
    LbListenerId = "string",
    DefaultPoolId = "string",
    Name = "string",
    AdminStateUp = false,
    AllowedCidrs = new[]
    {
        "string",
    },
    Region = "string",
    SniContainerRefs = new[]
    {
        "string",
    },
    TimeoutClientData = 0,
    TimeoutMemberConnect = 0,
    TimeoutMemberData = 0,
    TimeoutTcpInspect = 0,
    Timeouts = new Vkcs.Inputs.LbListenerTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := vkcs.NewLbListener(ctx, "lbListenerResource", &vkcs.LbListenerArgs{
LoadbalancerId: pulumi.String("string"),
ProtocolPort: pulumi.Float64(0),
Protocol: pulumi.String("string"),
DefaultTlsContainerRef: pulumi.String("string"),
ConnectionLimit: pulumi.Float64(0),
Description: pulumi.String("string"),
InsertHeaders: pulumi.StringMap{
"string": pulumi.String("string"),
},
LbListenerId: pulumi.String("string"),
DefaultPoolId: pulumi.String("string"),
Name: pulumi.String("string"),
AdminStateUp: pulumi.Bool(false),
AllowedCidrs: pulumi.StringArray{
pulumi.String("string"),
},
Region: pulumi.String("string"),
SniContainerRefs: pulumi.StringArray{
pulumi.String("string"),
},
TimeoutClientData: pulumi.Float64(0),
TimeoutMemberConnect: pulumi.Float64(0),
TimeoutMemberData: pulumi.Float64(0),
TimeoutTcpInspect: pulumi.Float64(0),
Timeouts: &.LbListenerTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})

    var lbListenerResource = new LbListener("lbListenerResource", LbListenerArgs.builder()
    .loadbalancerId("string")
    .protocolPort(0)
    .protocol("string")
    .defaultTlsContainerRef("string")
    .connectionLimit(0)
    .description("string")
    .insertHeaders(Map.of("string", "string"))
    .lbListenerId("string")
    .defaultPoolId("string")
    .name("string")
    .adminStateUp(false)
    .allowedCidrs("string")
    .region("string")
    .sniContainerRefs("string")
    .timeoutClientData(0)
    .timeoutMemberConnect(0)
    .timeoutMemberData(0)
    .timeoutTcpInspect(0)
    .timeouts(LbListenerTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    lb_listener_resource = vkcs.LbListener("lbListenerResource",
    loadbalancer_id="string",
    protocol_port=0,
    protocol="string",
    default_tls_container_ref="string",
    connection_limit=0,
    description="string",
    insert_headers={
        "string": "string",
    },
    lb_listener_id="string",
    default_pool_id="string",
    name="string",
    admin_state_up=False,
    allowed_cidrs=["string"],
    region="string",
    sni_container_refs=["string"],
    timeout_client_data=0,
    timeout_member_connect=0,
    timeout_member_data=0,
    timeout_tcp_inspect=0,
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const lbListenerResource = new vkcs.LbListener("lbListenerResource", {
    loadbalancerId: "string",
    protocolPort: 0,
    protocol: "string",
    defaultTlsContainerRef: "string",
    connectionLimit: 0,
    description: "string",
    insertHeaders: {
        string: "string",
    },
    lbListenerId: "string",
    defaultPoolId: "string",
    name: "string",
    adminStateUp: false,
    allowedCidrs: ["string"],
    region: "string",
    sniContainerRefs: ["string"],
    timeoutClientData: 0,
    timeoutMemberConnect: 0,
    timeoutMemberData: 0,
    timeoutTcpInspect: 0,
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: vkcs:LbListener
properties:
    adminStateUp: false
    allowedCidrs:
        - string
    connectionLimit: 0
    defaultPoolId: string
    defaultTlsContainerRef: string
    description: string
    insertHeaders:
        string: string
    lbListenerId: string
    loadbalancerId: string
    name: string
    protocol: string
    protocolPort: 0
    region: string
    sniContainerRefs:
        - string
    timeoutClientData: 0
    timeoutMemberConnect: 0
    timeoutMemberData: 0
    timeoutTcpInspect: 0
    timeouts:
        create: string
        delete: string
        update: string

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

    LoadbalancerId string
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    Protocol string
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    ProtocolPort double
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    AdminStateUp bool
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    AllowedCidrs List<string>
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    ConnectionLimit double
    optional number → The maximum number of connections allowed for the Listener.
    DefaultPoolId string
    optional string → The ID of the default pool with which the Listener is associated.
    DefaultTlsContainerRef string
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    Description string
    optional string → Human-readable description for the Listener.
    InsertHeaders Dictionary<string, string>
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    LbListenerId string
    string → ID of the resource.
    Name string
    optional string → Human-readable name for the Listener. Does not have to be unique.
    Region string
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    SniContainerRefs List<string>
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    TimeoutClientData double
    optional number → The client inactivity timeout in milliseconds.
    TimeoutMemberConnect double
    optional number → The member connection timeout in milliseconds.
    TimeoutMemberData double
    optional number → The member inactivity timeout in milliseconds.
    TimeoutTcpInspect double
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    Timeouts LbListenerTimeouts
    LoadbalancerId string
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    Protocol string
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    ProtocolPort float64
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    AdminStateUp bool
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    AllowedCidrs []string
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    ConnectionLimit float64
    optional number → The maximum number of connections allowed for the Listener.
    DefaultPoolId string
    optional string → The ID of the default pool with which the Listener is associated.
    DefaultTlsContainerRef string
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    Description string
    optional string → Human-readable description for the Listener.
    InsertHeaders map[string]string
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    LbListenerId string
    string → ID of the resource.
    Name string
    optional string → Human-readable name for the Listener. Does not have to be unique.
    Region string
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    SniContainerRefs []string
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    TimeoutClientData float64
    optional number → The client inactivity timeout in milliseconds.
    TimeoutMemberConnect float64
    optional number → The member connection timeout in milliseconds.
    TimeoutMemberData float64
    optional number → The member inactivity timeout in milliseconds.
    TimeoutTcpInspect float64
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    Timeouts LbListenerTimeoutsArgs
    loadbalancerId String
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    protocol String
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    protocolPort Double
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    adminStateUp Boolean
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    allowedCidrs List<String>
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    connectionLimit Double
    optional number → The maximum number of connections allowed for the Listener.
    defaultPoolId String
    optional string → The ID of the default pool with which the Listener is associated.
    defaultTlsContainerRef String
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    description String
    optional string → Human-readable description for the Listener.
    insertHeaders Map<String,String>
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    lbListenerId String
    string → ID of the resource.
    name String
    optional string → Human-readable name for the Listener. Does not have to be unique.
    region String
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    sniContainerRefs List<String>
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    timeoutClientData Double
    optional number → The client inactivity timeout in milliseconds.
    timeoutMemberConnect Double
    optional number → The member connection timeout in milliseconds.
    timeoutMemberData Double
    optional number → The member inactivity timeout in milliseconds.
    timeoutTcpInspect Double
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    timeouts LbListenerTimeouts
    loadbalancerId string
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    protocol string
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    protocolPort number
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    adminStateUp boolean
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    allowedCidrs string[]
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    connectionLimit number
    optional number → The maximum number of connections allowed for the Listener.
    defaultPoolId string
    optional string → The ID of the default pool with which the Listener is associated.
    defaultTlsContainerRef string
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    description string
    optional string → Human-readable description for the Listener.
    insertHeaders {[key: string]: string}
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    lbListenerId string
    string → ID of the resource.
    name string
    optional string → Human-readable name for the Listener. Does not have to be unique.
    region string
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    sniContainerRefs string[]
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    timeoutClientData number
    optional number → The client inactivity timeout in milliseconds.
    timeoutMemberConnect number
    optional number → The member connection timeout in milliseconds.
    timeoutMemberData number
    optional number → The member inactivity timeout in milliseconds.
    timeoutTcpInspect number
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    timeouts LbListenerTimeouts
    loadbalancer_id str
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    protocol str
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    protocol_port float
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    admin_state_up bool
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    allowed_cidrs Sequence[str]
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    connection_limit float
    optional number → The maximum number of connections allowed for the Listener.
    default_pool_id str
    optional string → The ID of the default pool with which the Listener is associated.
    default_tls_container_ref str
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    description str
    optional string → Human-readable description for the Listener.
    insert_headers Mapping[str, str]
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    lb_listener_id str
    string → ID of the resource.
    name str
    optional string → Human-readable name for the Listener. Does not have to be unique.
    region str
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    sni_container_refs Sequence[str]
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    timeout_client_data float
    optional number → The client inactivity timeout in milliseconds.
    timeout_member_connect float
    optional number → The member connection timeout in milliseconds.
    timeout_member_data float
    optional number → The member inactivity timeout in milliseconds.
    timeout_tcp_inspect float
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    timeouts LbListenerTimeoutsArgs
    loadbalancerId String
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    protocol String
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    protocolPort Number
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    adminStateUp Boolean
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    allowedCidrs List<String>
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    connectionLimit Number
    optional number → The maximum number of connections allowed for the Listener.
    defaultPoolId String
    optional string → The ID of the default pool with which the Listener is associated.
    defaultTlsContainerRef String
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    description String
    optional string → Human-readable description for the Listener.
    insertHeaders Map<String>
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    lbListenerId String
    string → ID of the resource.
    name String
    optional string → Human-readable name for the Listener. Does not have to be unique.
    region String
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    sniContainerRefs List<String>
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    timeoutClientData Number
    optional number → The client inactivity timeout in milliseconds.
    timeoutMemberConnect Number
    optional number → The member connection timeout in milliseconds.
    timeoutMemberData Number
    optional number → The member inactivity timeout in milliseconds.
    timeoutTcpInspect Number
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LbListener Resource

    Get an existing LbListener 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?: LbListenerState, opts?: CustomResourceOptions): LbListener
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state_up: Optional[bool] = None,
        allowed_cidrs: Optional[Sequence[str]] = None,
        connection_limit: Optional[float] = None,
        default_pool_id: Optional[str] = None,
        default_tls_container_ref: Optional[str] = None,
        description: Optional[str] = None,
        insert_headers: Optional[Mapping[str, str]] = None,
        lb_listener_id: Optional[str] = None,
        loadbalancer_id: Optional[str] = None,
        name: Optional[str] = None,
        protocol: Optional[str] = None,
        protocol_port: Optional[float] = None,
        region: Optional[str] = None,
        sni_container_refs: Optional[Sequence[str]] = None,
        timeout_client_data: Optional[float] = None,
        timeout_member_connect: Optional[float] = None,
        timeout_member_data: Optional[float] = None,
        timeout_tcp_inspect: Optional[float] = None,
        timeouts: Optional[LbListenerTimeoutsArgs] = None) -> LbListener
    func GetLbListener(ctx *Context, name string, id IDInput, state *LbListenerState, opts ...ResourceOption) (*LbListener, error)
    public static LbListener Get(string name, Input<string> id, LbListenerState? state, CustomResourceOptions? opts = null)
    public static LbListener get(String name, Output<String> id, LbListenerState state, CustomResourceOptions options)
    resources:  _:    type: vkcs:LbListener    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdminStateUp bool
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    AllowedCidrs List<string>
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    ConnectionLimit double
    optional number → The maximum number of connections allowed for the Listener.
    DefaultPoolId string
    optional string → The ID of the default pool with which the Listener is associated.
    DefaultTlsContainerRef string
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    Description string
    optional string → Human-readable description for the Listener.
    InsertHeaders Dictionary<string, string>
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    LbListenerId string
    string → ID of the resource.
    LoadbalancerId string
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    Name string
    optional string → Human-readable name for the Listener. Does not have to be unique.
    Protocol string
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    ProtocolPort double
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    Region string
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    SniContainerRefs List<string>
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    TimeoutClientData double
    optional number → The client inactivity timeout in milliseconds.
    TimeoutMemberConnect double
    optional number → The member connection timeout in milliseconds.
    TimeoutMemberData double
    optional number → The member inactivity timeout in milliseconds.
    TimeoutTcpInspect double
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    Timeouts LbListenerTimeouts
    AdminStateUp bool
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    AllowedCidrs []string
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    ConnectionLimit float64
    optional number → The maximum number of connections allowed for the Listener.
    DefaultPoolId string
    optional string → The ID of the default pool with which the Listener is associated.
    DefaultTlsContainerRef string
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    Description string
    optional string → Human-readable description for the Listener.
    InsertHeaders map[string]string
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    LbListenerId string
    string → ID of the resource.
    LoadbalancerId string
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    Name string
    optional string → Human-readable name for the Listener. Does not have to be unique.
    Protocol string
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    ProtocolPort float64
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    Region string
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    SniContainerRefs []string
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    TimeoutClientData float64
    optional number → The client inactivity timeout in milliseconds.
    TimeoutMemberConnect float64
    optional number → The member connection timeout in milliseconds.
    TimeoutMemberData float64
    optional number → The member inactivity timeout in milliseconds.
    TimeoutTcpInspect float64
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    Timeouts LbListenerTimeoutsArgs
    adminStateUp Boolean
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    allowedCidrs List<String>
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    connectionLimit Double
    optional number → The maximum number of connections allowed for the Listener.
    defaultPoolId String
    optional string → The ID of the default pool with which the Listener is associated.
    defaultTlsContainerRef String
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    description String
    optional string → Human-readable description for the Listener.
    insertHeaders Map<String,String>
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    lbListenerId String
    string → ID of the resource.
    loadbalancerId String
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    name String
    optional string → Human-readable name for the Listener. Does not have to be unique.
    protocol String
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    protocolPort Double
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    region String
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    sniContainerRefs List<String>
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    timeoutClientData Double
    optional number → The client inactivity timeout in milliseconds.
    timeoutMemberConnect Double
    optional number → The member connection timeout in milliseconds.
    timeoutMemberData Double
    optional number → The member inactivity timeout in milliseconds.
    timeoutTcpInspect Double
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    timeouts LbListenerTimeouts
    adminStateUp boolean
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    allowedCidrs string[]
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    connectionLimit number
    optional number → The maximum number of connections allowed for the Listener.
    defaultPoolId string
    optional string → The ID of the default pool with which the Listener is associated.
    defaultTlsContainerRef string
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    description string
    optional string → Human-readable description for the Listener.
    insertHeaders {[key: string]: string}
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    lbListenerId string
    string → ID of the resource.
    loadbalancerId string
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    name string
    optional string → Human-readable name for the Listener. Does not have to be unique.
    protocol string
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    protocolPort number
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    region string
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    sniContainerRefs string[]
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    timeoutClientData number
    optional number → The client inactivity timeout in milliseconds.
    timeoutMemberConnect number
    optional number → The member connection timeout in milliseconds.
    timeoutMemberData number
    optional number → The member inactivity timeout in milliseconds.
    timeoutTcpInspect number
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    timeouts LbListenerTimeouts
    admin_state_up bool
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    allowed_cidrs Sequence[str]
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    connection_limit float
    optional number → The maximum number of connections allowed for the Listener.
    default_pool_id str
    optional string → The ID of the default pool with which the Listener is associated.
    default_tls_container_ref str
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    description str
    optional string → Human-readable description for the Listener.
    insert_headers Mapping[str, str]
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    lb_listener_id str
    string → ID of the resource.
    loadbalancer_id str
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    name str
    optional string → Human-readable name for the Listener. Does not have to be unique.
    protocol str
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    protocol_port float
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    region str
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    sni_container_refs Sequence[str]
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    timeout_client_data float
    optional number → The client inactivity timeout in milliseconds.
    timeout_member_connect float
    optional number → The member connection timeout in milliseconds.
    timeout_member_data float
    optional number → The member inactivity timeout in milliseconds.
    timeout_tcp_inspect float
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    timeouts LbListenerTimeoutsArgs
    adminStateUp Boolean
    optional boolean → The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    allowedCidrs List<String>
    optional set of string → A list of CIDR blocks that are permitted to connect to this listener, denying all other source addresses. If not present, defaults to allow all.
    connectionLimit Number
    optional number → The maximum number of connections allowed for the Listener.
    defaultPoolId String
    optional string → The ID of the default pool with which the Listener is associated.
    defaultTlsContainerRef String
    optional string → A reference to a Keymanager Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS.
    description String
    optional string → Human-readable description for the Listener.
    insertHeaders Map<String>
    optional map of string → The list of key value pairs representing headers to insert into the request before it is sent to the backend members. Changing this updates the headers of the existing listener.
    lbListenerId String
    string → ID of the resource.
    loadbalancerId String
    required string → The load balancer on which to provision this Listener. Changing this creates a new Listener.
    name String
    optional string → Human-readable name for the Listener. Does not have to be unique.
    protocol String
    required string → The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP. Changing this creates a new Listener.
    protocolPort Number
    required number → The port on which to listen for client traffic. Changing this creates a new Listener.
    region String
    optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new Listener.
    sniContainerRefs List<String>
    optional string → A list of references to Keymanager Secrets containers which store SNI information.
    timeoutClientData Number
    optional number → The client inactivity timeout in milliseconds.
    timeoutMemberConnect Number
    optional number → The member connection timeout in milliseconds.
    timeoutMemberData Number
    optional number → The member inactivity timeout in milliseconds.
    timeoutTcpInspect Number
    optional number → The time in milliseconds, to wait for additional TCP packets for content inspection.
    timeouts Property Map

    Supporting Types

    LbListenerTimeouts, LbListenerTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    Load Balancer Listener can be imported using the Listener ID, e.g.:

    $ pulumi import vkcs:index/lbListener:LbListener listener_1 b67ce64e-8b26-405d-afeb-4a078901f15a

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

    Package Details

    Repository
    vkcs vk-cs/terraform-provider-vkcs
    License
    Notes
    This Pulumi package is based on the vkcs Terraform Provider.
    vkcs logo
    vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
    vk-cs/terraform-provider-vkcs