Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getListeners

This data source provides the list of Listeners in Oracle Cloud Infrastructure Network Load Balancer service.

Lists all listeners associated with a given network load balancer.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testListeners = Output.Create(Oci.NetworkLoadBalancer.GetListeners.InvokeAsync(new Oci.NetworkLoadBalancer.GetListenersArgs
        {
            NetworkLoadBalancerId = oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := NetworkLoadBalancer.GetListeners(ctx, &networkloadbalancer.GetListenersArgs{
			NetworkLoadBalancerId: oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_listeners = oci.NetworkLoadBalancer.get_listeners(network_load_balancer_id=oci_network_load_balancer_network_load_balancer["test_network_load_balancer"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testListeners = oci.NetworkLoadBalancer.getListeners({
    networkLoadBalancerId: oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id,
});

Coming soon!

Using getListeners

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getListeners(args: GetListenersArgs, opts?: InvokeOptions): Promise<GetListenersResult>
function getListenersOutput(args: GetListenersOutputArgs, opts?: InvokeOptions): Output<GetListenersResult>
def get_listeners(filters: Optional[Sequence[_networkloadbalancer.GetListenersFilter]] = None,
                  network_load_balancer_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetListenersResult
def get_listeners_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_networkloadbalancer.GetListenersFilterArgs]]]] = None,
                  network_load_balancer_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetListenersResult]
func GetListeners(ctx *Context, args *GetListenersArgs, opts ...InvokeOption) (*GetListenersResult, error)
func GetListenersOutput(ctx *Context, args *GetListenersOutputArgs, opts ...InvokeOption) GetListenersResultOutput

> Note: This function is named GetListeners in the Go SDK.

public static class GetListeners 
{
    public static Task<GetListenersResult> InvokeAsync(GetListenersArgs args, InvokeOptions? opts = null)
    public static Output<GetListenersResult> Invoke(GetListenersInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetListenersResult> getListeners(GetListenersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:NetworkLoadBalancer/getListeners:getListeners
  Arguments:
    # Arguments dictionary

The following arguments are supported:

NetworkLoadBalancerId string

The OCID of the network load balancer to update.

Filters List<GetListenersFilter>
NetworkLoadBalancerId string

The OCID of the network load balancer to update.

Filters []GetListenersFilter
networkLoadBalancerId String

The OCID of the network load balancer to update.

filters List<GetListenersFilter>
networkLoadBalancerId string

The OCID of the network load balancer to update.

filters GetListenersFilter[]
network_load_balancer_id str

The OCID of the network load balancer to update.

filters GetListenersFilter]
networkLoadBalancerId String

The OCID of the network load balancer to update.

filters List<Property Map>

getListeners Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

ListenerCollections List<GetListenersListenerCollection>

The list of listener_collection.

NetworkLoadBalancerId string
Filters List<GetListenersFilter>
Id string

The provider-assigned unique ID for this managed resource.

ListenerCollections []GetListenersListenerCollection

The list of listener_collection.

NetworkLoadBalancerId string
Filters []GetListenersFilter
id String

The provider-assigned unique ID for this managed resource.

listenerCollections List<GetListenersListenerCollection>

The list of listener_collection.

networkLoadBalancerId String
filters List<GetListenersFilter>
id string

The provider-assigned unique ID for this managed resource.

listenerCollections GetListenersListenerCollection[]

The list of listener_collection.

networkLoadBalancerId string
filters GetListenersFilter[]
id str

The provider-assigned unique ID for this managed resource.

listener_collections GetListenersListenerCollection]

The list of listener_collection.

network_load_balancer_id str
filters GetListenersFilter]
id String

The provider-assigned unique ID for this managed resource.

listenerCollections List<Property Map>

The list of listener_collection.

networkLoadBalancerId String
filters List<Property Map>

Supporting Types

GetListenersFilter

Name string

A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener

Values List<string>
Regex bool
Name string

A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener

Values []string
Regex bool
name String

A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener

values List<String>
regex Boolean
name string

A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener

values string[]
regex boolean
name str

A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener

values Sequence[str]
regex bool
name String

A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener

values List<String>
regex Boolean

GetListenersListenerCollection

GetListenersListenerCollectionItem

DefaultBackendSetName string

The name of the associated backend set. Example: example_backend_set

Id string
IpVersion string

IP version associated with the listener.

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

The communication port for the listener. Example: 80

Protocol string

The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP

DefaultBackendSetName string

The name of the associated backend set. Example: example_backend_set

Id string
IpVersion string

IP version associated with the listener.

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

The communication port for the listener. Example: 80

Protocol string

The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP

defaultBackendSetName String

The name of the associated backend set. Example: example_backend_set

id String
ipVersion String

IP version associated with the listener.

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

The communication port for the listener. Example: 80

protocol String

The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP

defaultBackendSetName string

The name of the associated backend set. Example: example_backend_set

id string
ipVersion string

IP version associated with the listener.

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

The communication port for the listener. Example: 80

protocol string

The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP

default_backend_set_name str

The name of the associated backend set. Example: example_backend_set

id str
ip_version str

IP version associated with the listener.

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

The communication port for the listener. Example: 80

protocol str

The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP

defaultBackendSetName String

The name of the associated backend set. Example: example_backend_set

id String
ipVersion String

IP version associated with the listener.

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

The communication port for the listener. Example: 80

protocol String

The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.