Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. NetworkLoadBalancer
  5. Listener
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.NetworkLoadBalancer.Listener

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Listener resource in Oracle Cloud Infrastructure Network Load Balancer service.

    Adds a listener to a network load balancer.

    Example Usage

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

const testListener = new oci.networkloadbalancer.Listener("test_listener", {
    defaultBackendSetName: testBackendSet.name,
    name: listenerName,
    networkLoadBalancerId: testNetworkLoadBalancer.id,
    port: listenerPort,
    protocol: listenerProtocol,
    ipVersion: listenerIpVersion,
    isPpv2enabled: listenerIsPpv2enabled,
    l3ipIdleTimeout: listenerL3ipIdleTimeout,
    tcpIdleTimeout: listenerTcpIdleTimeout,
    udpIdleTimeout: listenerUdpIdleTimeout,
});

    import pulumi
import pulumi_oci as oci

test_listener = oci.network_load_balancer.Listener("test_listener",
    default_backend_set_name=test_backend_set["name"],
    name=listener_name,
    network_load_balancer_id=test_network_load_balancer["id"],
    port=listener_port,
    protocol=listener_protocol,
    ip_version=listener_ip_version,
    is_ppv2enabled=listener_is_ppv2enabled,
    l3ip_idle_timeout=listener_l3ip_idle_timeout,
    tcp_idle_timeout=listener_tcp_idle_timeout,
    udp_idle_timeout=listener_udp_idle_timeout)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/networkloadbalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkloadbalancer.NewListener(ctx, "test_listener", &networkloadbalancer.ListenerArgs{
			DefaultBackendSetName: pulumi.Any(testBackendSet.Name),
			Name:                  pulumi.Any(listenerName),
			NetworkLoadBalancerId: pulumi.Any(testNetworkLoadBalancer.Id),
			Port:                  pulumi.Any(listenerPort),
			Protocol:              pulumi.Any(listenerProtocol),
			IpVersion:             pulumi.Any(listenerIpVersion),
			IsPpv2enabled:         pulumi.Any(listenerIsPpv2enabled),
			L3ipIdleTimeout:       pulumi.Any(listenerL3ipIdleTimeout),
			TcpIdleTimeout:        pulumi.Any(listenerTcpIdleTimeout),
			UdpIdleTimeout:        pulumi.Any(listenerUdpIdleTimeout),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testListener = new Oci.NetworkLoadBalancer.Listener("test_listener", new()
    {
        DefaultBackendSetName = testBackendSet.Name,
        Name = listenerName,
        NetworkLoadBalancerId = testNetworkLoadBalancer.Id,
        Port = listenerPort,
        Protocol = listenerProtocol,
        IpVersion = listenerIpVersion,
        IsPpv2enabled = listenerIsPpv2enabled,
        L3ipIdleTimeout = listenerL3ipIdleTimeout,
        TcpIdleTimeout = listenerTcpIdleTimeout,
        UdpIdleTimeout = listenerUdpIdleTimeout,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.NetworkLoadBalancer.Listener;
import com.pulumi.oci.NetworkLoadBalancer.ListenerArgs;
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 testListener = new Listener("testListener", ListenerArgs.builder()
            .defaultBackendSetName(testBackendSet.name())
            .name(listenerName)
            .networkLoadBalancerId(testNetworkLoadBalancer.id())
            .port(listenerPort)
            .protocol(listenerProtocol)
            .ipVersion(listenerIpVersion)
            .isPpv2enabled(listenerIsPpv2enabled)
            .l3ipIdleTimeout(listenerL3ipIdleTimeout)
            .tcpIdleTimeout(listenerTcpIdleTimeout)
            .udpIdleTimeout(listenerUdpIdleTimeout)
            .build());

    }
}

    resources:
  testListener:
    type: oci:NetworkLoadBalancer:Listener
    name: test_listener
    properties:
      defaultBackendSetName: ${testBackendSet.name}
      name: ${listenerName}
      networkLoadBalancerId: ${testNetworkLoadBalancer.id}
      port: ${listenerPort}
      protocol: ${listenerProtocol}
      ipVersion: ${listenerIpVersion}
      isPpv2enabled: ${listenerIsPpv2enabled}
      l3ipIdleTimeout: ${listenerL3ipIdleTimeout}
      tcpIdleTimeout: ${listenerTcpIdleTimeout}
      udpIdleTimeout: ${listenerUdpIdleTimeout}

    Create Listener Resource

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

    Constructor syntax

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

@overload
def Listener(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             default_backend_set_name: Optional[str] = None,
             network_load_balancer_id: Optional[str] = None,
             port: Optional[int] = None,
             protocol: Optional[str] = None,
             ip_version: Optional[str] = None,
             is_ppv2enabled: Optional[bool] = None,
             l3ip_idle_timeout: Optional[int] = None,
             name: Optional[str] = None,
             tcp_idle_timeout: Optional[int] = None,
             udp_idle_timeout: Optional[int] = None)
    func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)
    public Listener(string name, ListenerArgs args, CustomResourceOptions? opts = null)
    public Listener(String name, ListenerArgs args)
public Listener(String name, ListenerArgs args, CustomResourceOptions options)

    type: oci:NetworkLoadBalancer:Listener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var ociListenerResource = new Oci.NetworkLoadBalancer.Listener("ociListenerResource", new()
{
    DefaultBackendSetName = "string",
    NetworkLoadBalancerId = "string",
    Port = 0,
    Protocol = "string",
    IpVersion = "string",
    IsPpv2enabled = false,
    L3ipIdleTimeout = 0,
    Name = "string",
    TcpIdleTimeout = 0,
    UdpIdleTimeout = 0,
});

    example, err := networkloadbalancer.NewListener(ctx, "ociListenerResource", &networkloadbalancer.ListenerArgs{
	DefaultBackendSetName: pulumi.String("string"),
	NetworkLoadBalancerId: pulumi.String("string"),
	Port:                  pulumi.Int(0),
	Protocol:              pulumi.String("string"),
	IpVersion:             pulumi.String("string"),
	IsPpv2enabled:         pulumi.Bool(false),
	L3ipIdleTimeout:       pulumi.Int(0),
	Name:                  pulumi.String("string"),
	TcpIdleTimeout:        pulumi.Int(0),
	UdpIdleTimeout:        pulumi.Int(0),
})

    var ociListenerResource = new com.pulumi.oci.NetworkLoadBalancer.Listener("ociListenerResource", com.pulumi.oci.NetworkLoadBalancer.ListenerArgs.builder()
    .defaultBackendSetName("string")
    .networkLoadBalancerId("string")
    .port(0)
    .protocol("string")
    .ipVersion("string")
    .isPpv2enabled(false)
    .l3ipIdleTimeout(0)
    .name("string")
    .tcpIdleTimeout(0)
    .udpIdleTimeout(0)
    .build());

    oci_listener_resource = oci.network_load_balancer.Listener("ociListenerResource",
    default_backend_set_name="string",
    network_load_balancer_id="string",
    port=0,
    protocol="string",
    ip_version="string",
    is_ppv2enabled=False,
    l3ip_idle_timeout=0,
    name="string",
    tcp_idle_timeout=0,
    udp_idle_timeout=0)

    const ociListenerResource = new oci.networkloadbalancer.Listener("ociListenerResource", {
    defaultBackendSetName: "string",
    networkLoadBalancerId: "string",
    port: 0,
    protocol: "string",
    ipVersion: "string",
    isPpv2enabled: false,
    l3ipIdleTimeout: 0,
    name: "string",
    tcpIdleTimeout: 0,
    udpIdleTimeout: 0,
});

    type: oci:NetworkLoadBalancer:Listener
properties:
    defaultBackendSetName: string
    ipVersion: string
    isPpv2enabled: false
    l3ipIdleTimeout: 0
    name: string
    networkLoadBalancerId: string
    port: 0
    protocol: string
    tcpIdleTimeout: 0
    udpIdleTimeout: 0

    Listener Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Listener resource accepts the following input properties:

    DefaultBackendSetName string
    (Updatable) The name of the associated backend set. Example: example_backend_set
    NetworkLoadBalancerId string
    The OCID of the network load balancer to update.
    Port int
    (Updatable) The communication port for the listener. Example: 80
    Protocol string
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    IpVersion string
    (Updatable) IP version associated with the listener.
    IsPpv2enabled bool
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    L3ipIdleTimeout int
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    Name string
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    TcpIdleTimeout int
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    UdpIdleTimeout int

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefaultBackendSetName string
    (Updatable) The name of the associated backend set. Example: example_backend_set
    NetworkLoadBalancerId string
    The OCID of the network load balancer to update.
    Port int
    (Updatable) The communication port for the listener. Example: 80
    Protocol string
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    IpVersion string
    (Updatable) IP version associated with the listener.
    IsPpv2enabled bool
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    L3ipIdleTimeout int
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    Name string
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    TcpIdleTimeout int
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    UdpIdleTimeout int

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defaultBackendSetName String
    (Updatable) The name of the associated backend set. Example: example_backend_set
    networkLoadBalancerId String
    The OCID of the network load balancer to update.
    port Integer
    (Updatable) The communication port for the listener. Example: 80
    protocol String
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    ipVersion String
    (Updatable) IP version associated with the listener.
    isPpv2enabled Boolean
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    l3ipIdleTimeout Integer
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    name String
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    tcpIdleTimeout Integer
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    udpIdleTimeout Integer

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defaultBackendSetName string
    (Updatable) The name of the associated backend set. Example: example_backend_set
    networkLoadBalancerId string
    The OCID of the network load balancer to update.
    port number
    (Updatable) The communication port for the listener. Example: 80
    protocol string
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    ipVersion string
    (Updatable) IP version associated with the listener.
    isPpv2enabled boolean
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    l3ipIdleTimeout number
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    name string
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    tcpIdleTimeout number
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    udpIdleTimeout number

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    default_backend_set_name str
    (Updatable) The name of the associated backend set. Example: example_backend_set
    network_load_balancer_id str
    The OCID of the network load balancer to update.
    port int
    (Updatable) The communication port for the listener. Example: 80
    protocol str
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    ip_version str
    (Updatable) IP version associated with the listener.
    is_ppv2enabled bool
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    l3ip_idle_timeout int
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    name str
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    tcp_idle_timeout int
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    udp_idle_timeout int

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defaultBackendSetName String
    (Updatable) The name of the associated backend set. Example: example_backend_set
    networkLoadBalancerId String
    The OCID of the network load balancer to update.
    port Number
    (Updatable) The communication port for the listener. Example: 80
    protocol String
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    ipVersion String
    (Updatable) IP version associated with the listener.
    isPpv2enabled Boolean
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    l3ipIdleTimeout Number
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    name String
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    tcpIdleTimeout Number
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    udpIdleTimeout Number

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    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 Listener Resource

    Get an existing Listener resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ListenerState, opts?: CustomResourceOptions): Listener
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_backend_set_name: Optional[str] = None,
        ip_version: Optional[str] = None,
        is_ppv2enabled: Optional[bool] = None,
        l3ip_idle_timeout: Optional[int] = None,
        name: Optional[str] = None,
        network_load_balancer_id: Optional[str] = None,
        port: Optional[int] = None,
        protocol: Optional[str] = None,
        tcp_idle_timeout: Optional[int] = None,
        udp_idle_timeout: Optional[int] = None) -> Listener
    func GetListener(ctx *Context, name string, id IDInput, state *ListenerState, opts ...ResourceOption) (*Listener, error)
    public static Listener Get(string name, Input<string> id, ListenerState? state, CustomResourceOptions? opts = null)
    public static Listener get(String name, Output<String> id, ListenerState state, CustomResourceOptions options)
    resources:  _:    type: oci:NetworkLoadBalancer:Listener    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DefaultBackendSetName string
    (Updatable) The name of the associated backend set. Example: example_backend_set
    IpVersion string
    (Updatable) IP version associated with the listener.
    IsPpv2enabled bool
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    L3ipIdleTimeout int
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    Name string
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    NetworkLoadBalancerId string
    The OCID of the network load balancer to update.
    Port int
    (Updatable) The communication port for the listener. Example: 80
    Protocol string
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    TcpIdleTimeout int
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    UdpIdleTimeout int

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefaultBackendSetName string
    (Updatable) The name of the associated backend set. Example: example_backend_set
    IpVersion string
    (Updatable) IP version associated with the listener.
    IsPpv2enabled bool
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    L3ipIdleTimeout int
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    Name string
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    NetworkLoadBalancerId string
    The OCID of the network load balancer to update.
    Port int
    (Updatable) The communication port for the listener. Example: 80
    Protocol string
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    TcpIdleTimeout int
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    UdpIdleTimeout int

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defaultBackendSetName String
    (Updatable) The name of the associated backend set. Example: example_backend_set
    ipVersion String
    (Updatable) IP version associated with the listener.
    isPpv2enabled Boolean
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    l3ipIdleTimeout Integer
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    name String
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    networkLoadBalancerId String
    The OCID of the network load balancer to update.
    port Integer
    (Updatable) The communication port for the listener. Example: 80
    protocol String
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    tcpIdleTimeout Integer
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    udpIdleTimeout Integer

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defaultBackendSetName string
    (Updatable) The name of the associated backend set. Example: example_backend_set
    ipVersion string
    (Updatable) IP version associated with the listener.
    isPpv2enabled boolean
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    l3ipIdleTimeout number
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    name string
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    networkLoadBalancerId string
    The OCID of the network load balancer to update.
    port number
    (Updatable) The communication port for the listener. Example: 80
    protocol string
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    tcpIdleTimeout number
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    udpIdleTimeout number

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    default_backend_set_name str
    (Updatable) The name of the associated backend set. Example: example_backend_set
    ip_version str
    (Updatable) IP version associated with the listener.
    is_ppv2enabled bool
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    l3ip_idle_timeout int
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    name str
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    network_load_balancer_id str
    The OCID of the network load balancer to update.
    port int
    (Updatable) The communication port for the listener. Example: 80
    protocol str
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    tcp_idle_timeout int
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    udp_idle_timeout int

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defaultBackendSetName String
    (Updatable) The name of the associated backend set. Example: example_backend_set
    ipVersion String
    (Updatable) IP version associated with the listener.
    isPpv2enabled Boolean
    (Updatable) Property to enable/disable PPv2 feature for this listener.
    l3ipIdleTimeout Number
    (Updatable) The duration for L3IP idle timeout in seconds. Example: 200
    name String
    A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener
    networkLoadBalancerId String
    The OCID of the network load balancer to update.
    port Number
    (Updatable) The communication port for the listener. Example: 80
    protocol String
    (Updatable) The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: TCP
    tcpIdleTimeout Number
    (Updatable) The duration for TCP idle timeout in seconds. Example: 300
    udpIdleTimeout Number

    (Updatable) The duration for UDP idle timeout in seconds. Example: 120

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

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

    $ pulumi import oci:NetworkLoadBalancer/listener:Listener test_listener "networkLoadBalancers/{networkLoadBalancerId}/listeners/{listenerName}"

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci