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,
        });
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

listener1 = openstack.loadbalancer.Listener("listener1",
    insert_headers={
        "X-Forwarded-For": "true",
    },
    loadbalancer_id="d9415786-5f1a-428b-b35f-2f1523e146d2",
    protocol="HTTP",
    protocol_port=8080)

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

const listener1 = new openstack.loadbalancer.Listener("listener_1", {
    insertHeaders: {
        "X-Forwarded-For": "true",
    },
    loadbalancerId: "d9415786-5f1a-428b-b35f-2f1523e146d2",
    protocol: "HTTP",
    protocolPort: 8080,
});

Create a Listener Resource

new Listener(name: string, args: ListenerArgs, opts?: CustomResourceOptions);

def Listener(resource_name, opts=None, admin_state_up=None, connection_limit=None, default_pool_id=None, default_tls_container_ref=None, description=None, insert_headers=None, loadbalancer_id=None, name=None, protocol=None, protocol_port=None, region=None, sni_container_refs=None, tenant_id=None, timeout_client_data=None, timeout_member_connect=None, timeout_member_data=None, timeout_tcp_inspect=None, __props__=None);

func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)

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

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.
opts ResourceOptions: A bag of options that control this 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.

Listener Resource Properties

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

Inputs

The Listener resource accepts the following input properties:

LoadbalancerId string: The load balancer on which to provision this Listener. Changing this creates a new Listener.
Protocol string: The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS or UDP (supported only in Octavia). Changing this creates a new Listener.
ProtocolPort int: The port on which to listen for client traffic. Changing this creates a new Listener.
AdminStateUp bool: The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
ConnectionLimit int: The maximum number of connections allowed for the Listener.
DefaultPoolId string: The ID of the default pool with which the Listener is associated.
DefaultTlsContainerRef string: 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.
Description string: Human-readable description for the Listener.
InsertHeaders Dictionary<string, object>: 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.
Name string: Human-readable name for the Listener. Does not have to be unique.
Region string: 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.
SniContainerRefs List<string>: A list of references to Barbican Secrets containers which store SNI information. See here for more information.
TenantId string: 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.
TimeoutClientData int: The client inactivity timeout in milliseconds.
TimeoutMemberConnect int: The member connection timeout in milliseconds.
TimeoutMemberData int: The member inactivity timeout in milliseconds.
TimeoutTcpInspect int: The time in milliseconds, to wait for additional TCP packets for content inspection.

LoadbalancerId string: The load balancer on which to provision this Listener. Changing this creates a new Listener.
Protocol string: The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS or UDP (supported only in Octavia). Changing this creates a new Listener.
ProtocolPort int: The port on which to listen for client traffic. Changing this creates a new Listener.
AdminStateUp bool: The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
ConnectionLimit int: The maximum number of connections allowed for the Listener.
DefaultPoolId string: The ID of the default pool with which the Listener is associated.
DefaultTlsContainerRef string: 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.
Description string: Human-readable description for the Listener.
InsertHeaders map[string]interface{}: 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.
Name string: Human-readable name for the Listener. Does not have to be unique.
Region string: 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.
SniContainerRefs []string: A list of references to Barbican Secrets containers which store SNI information. See here for more information.
TenantId string: 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.
TimeoutClientData int: The client inactivity timeout in milliseconds.
TimeoutMemberConnect int: The member connection timeout in milliseconds.
TimeoutMemberData int: The member inactivity timeout in milliseconds.
TimeoutTcpInspect int: The time in milliseconds, to wait for additional TCP packets for content inspection.

loadbalancerId string: The load balancer on which to provision this Listener. Changing this creates a new Listener.
protocol string: The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS or UDP (supported only in Octavia). Changing this creates a new Listener.
protocolPort number: The port on which to listen for client traffic. Changing this creates a new Listener.
adminStateUp boolean: The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
connectionLimit number: The maximum number of connections allowed for the Listener.
defaultPoolId string: The ID of the default pool with which the Listener is associated.
defaultTlsContainerRef string: 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.
description string: Human-readable description for the Listener.
insertHeaders {[key: string]: any}: 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.
name string: Human-readable name for the Listener. Does not have to be unique.
region string: 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.
sniContainerRefs string[]: A list of references to Barbican Secrets containers which store SNI information. See here for more information.
tenantId string: 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.
timeoutClientData number: The client inactivity timeout in milliseconds.
timeoutMemberConnect number: The member connection timeout in milliseconds.
timeoutMemberData number: The member inactivity timeout in milliseconds.
timeoutTcpInspect number: The time in milliseconds, to wait for additional TCP packets for content inspection.

loadbalancer_id str: The load balancer on which to provision this Listener. Changing this creates a new Listener.
protocol str: The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS or UDP (supported only in Octavia). Changing this creates a new Listener.
protocol_port float: The port on which to listen for client traffic. Changing this creates a new Listener.
admin_state_up bool: The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
connection_limit float: The maximum number of connections allowed for the Listener.
default_pool_id str: The ID of the default pool with which the Listener is associated.
default_tls_container_ref str: 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.
description str: Human-readable description for the Listener.
insert_headers Dict[str, Any]: 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.
name str: Human-readable name for the Listener. Does not have to be unique.
region str: 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.
sni_container_refs List[str]: A list of references to Barbican Secrets containers which store SNI information. See here for more information.
tenant_id str: 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.
timeout_client_data float: The client inactivity timeout in milliseconds.
timeout_member_connect float: The member connection timeout in milliseconds.
timeout_member_data float: The member inactivity timeout in milliseconds.
timeout_tcp_inspect float: The time in milliseconds, to wait for additional TCP packets for content inspection.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, admin_state_up=None, connection_limit=None, default_pool_id=None, default_tls_container_ref=None, description=None, insert_headers=None, loadbalancer_id=None, name=None, protocol=None, protocol_port=None, region=None, sni_container_refs=None, tenant_id=None, timeout_client_data=None, timeout_member_connect=None, timeout_member_data=None, timeout_tcp_inspect=None, __props__=None);

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)

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.

The following state arguments are supported:

AdminStateUp bool: The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
ConnectionLimit int: The maximum number of connections allowed for the Listener.
DefaultPoolId string: The ID of the default pool with which the Listener is associated.
DefaultTlsContainerRef string: 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.
Description string: Human-readable description for the Listener.
InsertHeaders Dictionary<string, object>: 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.
LoadbalancerId string: The load balancer on which to provision this Listener. Changing this creates a new Listener.
Name string: Human-readable name for the Listener. Does not have to be unique.
Protocol string: The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS or UDP (supported only in Octavia). Changing this creates a new Listener.
ProtocolPort int: The port on which to listen for client traffic. Changing this creates a new Listener.
Region string: 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.
SniContainerRefs List<string>: A list of references to Barbican Secrets containers which store SNI information. See here for more information.
TenantId string: 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.
TimeoutClientData int: The client inactivity timeout in milliseconds.
TimeoutMemberConnect int: The member connection timeout in milliseconds.
TimeoutMemberData int: The member inactivity timeout in milliseconds.
TimeoutTcpInspect int: The time in milliseconds, to wait for additional TCP packets for content inspection.

AdminStateUp bool: The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
ConnectionLimit int: The maximum number of connections allowed for the Listener.
DefaultPoolId string: The ID of the default pool with which the Listener is associated.
DefaultTlsContainerRef string: 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.
Description string: Human-readable description for the Listener.
InsertHeaders map[string]interface{}: 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.
LoadbalancerId string: The load balancer on which to provision this Listener. Changing this creates a new Listener.
Name string: Human-readable name for the Listener. Does not have to be unique.
Protocol string: The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS or UDP (supported only in Octavia). Changing this creates a new Listener.
ProtocolPort int: The port on which to listen for client traffic. Changing this creates a new Listener.
Region string: 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.
SniContainerRefs []string: A list of references to Barbican Secrets containers which store SNI information. See here for more information.
TenantId string: 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.
TimeoutClientData int: The client inactivity timeout in milliseconds.
TimeoutMemberConnect int: The member connection timeout in milliseconds.
TimeoutMemberData int: The member inactivity timeout in milliseconds.
TimeoutTcpInspect int: The time in milliseconds, to wait for additional TCP packets for content inspection.

adminStateUp boolean: The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
connectionLimit number: The maximum number of connections allowed for the Listener.
defaultPoolId string: The ID of the default pool with which the Listener is associated.
defaultTlsContainerRef string: 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.
description string: Human-readable description for the Listener.
insertHeaders {[key: string]: any}: 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.
loadbalancerId string: The load balancer on which to provision this Listener. Changing this creates a new Listener.
name string: Human-readable name for the Listener. Does not have to be unique.
protocol string: The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS or UDP (supported only in Octavia). Changing this creates a new Listener.
protocolPort number: The port on which to listen for client traffic. Changing this creates a new Listener.
region string: 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.
sniContainerRefs string[]: A list of references to Barbican Secrets containers which store SNI information. See here for more information.
tenantId string: 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.
timeoutClientData number: The client inactivity timeout in milliseconds.
timeoutMemberConnect number: The member connection timeout in milliseconds.
timeoutMemberData number: The member inactivity timeout in milliseconds.
timeoutTcpInspect number: The time in milliseconds, to wait for additional TCP packets for content inspection.

admin_state_up bool: The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
connection_limit float: The maximum number of connections allowed for the Listener.
default_pool_id str: The ID of the default pool with which the Listener is associated.
default_tls_container_ref str: 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.
description str: Human-readable description for the Listener.
insert_headers Dict[str, Any]: 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.
loadbalancer_id str: The load balancer on which to provision this Listener. Changing this creates a new Listener.
name str: Human-readable name for the Listener. Does not have to be unique.
protocol str: The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS or UDP (supported only in Octavia). Changing this creates a new Listener.
protocol_port float: The port on which to listen for client traffic. Changing this creates a new Listener.
region str: 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.
sni_container_refs List[str]: A list of references to Barbican Secrets containers which store SNI information. See here for more information.
tenant_id str: 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.
timeout_client_data float: The client inactivity timeout in milliseconds.
timeout_member_connect float: The member connection timeout in milliseconds.
timeout_member_data float: The member inactivity timeout in milliseconds.
timeout_tcp_inspect float: The time in milliseconds, to wait for additional TCP packets for content inspection.

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud