Class Listener

Manages a V2 listener resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
public MyStack()
{
    var listener1 = new OpenStack.LoadBalancer.Listener("listener1", new OpenStack.LoadBalancer.ListenerArgs
    {
        InsertHeaders = 
        {
            { "X-Forwarded-For", "true" },
        },
        LoadbalancerId = "d9415786-5f1a-428b-b35f-2f1523e146d2",
        Protocol = "HTTP",
        ProtocolPort = 8080,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Listener

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.OpenStack.LoadBalancer

Assembly: Pulumi.OpenStack.dll

Syntax

public class Listener : CustomResource

Constructors

Listener(String, ListenerArgs, CustomResourceOptions)

Create a Listener resource with the given unique name, arguments, and options.

Declaration

public Listener(string name, ListenerArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ListenerArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AdminStateUp

The administrative state of the Listener. A valid value is true (UP) or false (DOWN).

Declaration

public Output<bool?> AdminStateUp { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

ConnectionLimit

The maximum number of connections allowed for the Listener.

Declaration

public Output<int> ConnectionLimit { get; }

Property Value

Type	Description
Output<System.Int32>

DefaultPoolId

The ID of the default pool with which the Listener is associated.

Declaration

public Output<string> DefaultPoolId { get; }

Property Value

Type	Description
Output<System.String>

DefaultTlsContainerRef

A reference to a Barbican Secrets container which stores TLS information. This is required if the protocol is TERMINATED_HTTPS. See here for more information.

Declaration

public Output<string> DefaultTlsContainerRef { get; }

Property Value

Type	Description
Output<System.String>

Description

Human-readable description for the Listener.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

InsertHeaders

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.

Declaration

public Output<ImmutableDictionary<string, object>> InsertHeaders { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

LoadbalancerId

The load balancer on which to provision this Listener. Changing this creates a new Listener.

Declaration

public Output<string> LoadbalancerId { get; }

Property Value

Type	Description
Output<System.String>

Name

Human-readable name for the Listener. Does not have to be unique.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Protocol

The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS or UDP (supported only in Octavia). Changing this creates a new Listener.

Declaration

public Output<string> Protocol { get; }

Property Value

Type	Description
Output<System.String>

ProtocolPort

The port on which to listen for client traffic. Changing this creates a new Listener.

Declaration

public Output<int> ProtocolPort { get; }

Property Value

Type	Description
Output<System.Int32>

Region

The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new Listener.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

SniContainerRefs

A list of references to Barbican Secrets containers which store SNI information. See here for more information.

Declaration

public Output<ImmutableArray<string>> SniContainerRefs { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

TenantId

Required for admins. The UUID of the tenant who owns the Listener. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new Listener.

Declaration

public Output<string> TenantId { get; }

Property Value

Type	Description
Output<System.String>

TimeoutClientData

The client inactivity timeout in milliseconds.

Declaration

public Output<int> TimeoutClientData { get; }

Property Value

Type	Description
Output<System.Int32>

TimeoutMemberConnect

The member connection timeout in milliseconds.

Declaration

public Output<int> TimeoutMemberConnect { get; }

Property Value

Type	Description
Output<System.Int32>

TimeoutMemberData

The member inactivity timeout in milliseconds.

Declaration

public Output<int> TimeoutMemberData { get; }

Property Value

Type	Description
Output<System.Int32>

TimeoutTcpInspect

The time in milliseconds, to wait for additional TCP packets for content inspection.

Declaration

public Output<int> TimeoutTcpInspect { get; }

Property Value

Type	Description
Output<System.Int32>

Methods

Get(String, Input<String>, ListenerState, CustomResourceOptions)

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

Declaration

public static Listener Get(string name, Input<string> id, ListenerState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ListenerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Listener