Docs Packages
  1. Packages
  2. OpenStack
  3. API Docs
  4. loadbalancer
  5. Listener
OpenStack v4.0.0 published on Tuesday, May 21, 2024 by Pulumi
pulumi/pulumi-openstack

openstack.loadbalancer.Listener

Explore with Pulumi AI

openstack logo
OpenStack v4.0.0 published on Tuesday, May 21, 2024 by Pulumi
pulumi/pulumi-openstack

    Manages a V2 listener resource within OpenStack.

    Note: This resource has attributes that depend on octavia minor versions. Please ensure your Openstack cloud supports the required minor version.

    Example Usage

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

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

    import pulumi
import pulumi_openstack as openstack

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

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v4/go/openstack/loadbalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancer.NewListener(ctx, "listener_1", &loadbalancer.ListenerArgs{
			Protocol:       pulumi.String("HTTP"),
			ProtocolPort:   pulumi.Int(8080),
			LoadbalancerId: pulumi.String("d9415786-5f1a-428b-b35f-2f1523e146d2"),
			InsertHeaders: pulumi.Map{
				"X-Forwarded-For": pulumi.Any("true"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var listener1 = new OpenStack.LoadBalancer.Listener("listener_1", new()
    {
        Protocol = "HTTP",
        ProtocolPort = 8080,
        LoadbalancerId = "d9415786-5f1a-428b-b35f-2f1523e146d2",
        InsertHeaders = 
        {
            { "X-Forwarded-For", "true" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.loadbalancer.Listener;
import com.pulumi.openstack.loadbalancer.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 listener1 = new Listener("listener1", ListenerArgs.builder()        
            .protocol("HTTP")
            .protocolPort(8080)
            .loadbalancerId("d9415786-5f1a-428b-b35f-2f1523e146d2")
            .insertHeaders(Map.of("X-Forwarded-For", "true"))
            .build());

    }
}

    resources:
  listener1:
    type: openstack:loadbalancer:Listener
    name: listener_1
    properties:
      protocol: HTTP
      protocolPort: 8080
      loadbalancerId: d9415786-5f1a-428b-b35f-2f1523e146d2
      insertHeaders:
        X-Forwarded-For: 'true'

    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,
             loadbalancer_id: Optional[str] = None,
             protocol_port: Optional[int] = None,
             protocol: Optional[str] = None,
             name: Optional[str] = None,
             allowed_cidrs: Optional[Sequence[str]] = None,
             description: Optional[str] = None,
             insert_headers: Optional[Mapping[str, Any]] = None,
             default_pool_id: Optional[str] = None,
             admin_state_up: Optional[bool] = None,
             connection_limit: Optional[int] = None,
             default_tls_container_ref: Optional[str] = None,
             region: Optional[str] = None,
             sni_container_refs: Optional[Sequence[str]] = None,
             tags: Optional[Sequence[str]] = None,
             tenant_id: Optional[str] = None,
             timeout_client_data: Optional[int] = None,
             timeout_member_connect: Optional[int] = None,
             timeout_member_data: Optional[int] = None,
             timeout_tcp_inspect: 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: openstack:loadbalancer: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 listenerResource = new OpenStack.LoadBalancer.Listener("listenerResource", new()
{
    LoadbalancerId = "string",
    ProtocolPort = 0,
    Protocol = "string",
    Name = "string",
    AllowedCidrs = new[]
    {
        "string",
    },
    Description = "string",
    InsertHeaders = 
    {
        { "string", "any" },
    },
    DefaultPoolId = "string",
    AdminStateUp = false,
    ConnectionLimit = 0,
    DefaultTlsContainerRef = "string",
    Region = "string",
    SniContainerRefs = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
    TenantId = "string",
    TimeoutClientData = 0,
    TimeoutMemberConnect = 0,
    TimeoutMemberData = 0,
    TimeoutTcpInspect = 0,
});

    example, err := loadbalancer.NewListener(ctx, "listenerResource", &loadbalancer.ListenerArgs{
	LoadbalancerId: pulumi.String("string"),
	ProtocolPort:   pulumi.Int(0),
	Protocol:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	AllowedCidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	InsertHeaders: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	DefaultPoolId:          pulumi.String("string"),
	AdminStateUp:           pulumi.Bool(false),
	ConnectionLimit:        pulumi.Int(0),
	DefaultTlsContainerRef: pulumi.String("string"),
	Region:                 pulumi.String("string"),
	SniContainerRefs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantId:             pulumi.String("string"),
	TimeoutClientData:    pulumi.Int(0),
	TimeoutMemberConnect: pulumi.Int(0),
	TimeoutMemberData:    pulumi.Int(0),
	TimeoutTcpInspect:    pulumi.Int(0),
})

    var listenerResource = new Listener("listenerResource", ListenerArgs.builder()
    .loadbalancerId("string")
    .protocolPort(0)
    .protocol("string")
    .name("string")
    .allowedCidrs("string")
    .description("string")
    .insertHeaders(Map.of("string", "any"))
    .defaultPoolId("string")
    .adminStateUp(false)
    .connectionLimit(0)
    .defaultTlsContainerRef("string")
    .region("string")
    .sniContainerRefs("string")
    .tags("string")
    .tenantId("string")
    .timeoutClientData(0)
    .timeoutMemberConnect(0)
    .timeoutMemberData(0)
    .timeoutTcpInspect(0)
    .build());

    listener_resource = openstack.loadbalancer.Listener("listenerResource",
    loadbalancer_id="string",
    protocol_port=0,
    protocol="string",
    name="string",
    allowed_cidrs=["string"],
    description="string",
    insert_headers={
        "string": "any",
    },
    default_pool_id="string",
    admin_state_up=False,
    connection_limit=0,
    default_tls_container_ref="string",
    region="string",
    sni_container_refs=["string"],
    tags=["string"],
    tenant_id="string",
    timeout_client_data=0,
    timeout_member_connect=0,
    timeout_member_data=0,
    timeout_tcp_inspect=0)

    const listenerResource = new openstack.loadbalancer.Listener("listenerResource", {
    loadbalancerId: "string",
    protocolPort: 0,
    protocol: "string",
    name: "string",
    allowedCidrs: ["string"],
    description: "string",
    insertHeaders: {
        string: "any",
    },
    defaultPoolId: "string",
    adminStateUp: false,
    connectionLimit: 0,
    defaultTlsContainerRef: "string",
    region: "string",
    sniContainerRefs: ["string"],
    tags: ["string"],
    tenantId: "string",
    timeoutClientData: 0,
    timeoutMemberConnect: 0,
    timeoutMemberData: 0,
    timeoutTcpInspect: 0,
});

    type: openstack:loadbalancer:Listener
properties:
    adminStateUp: false
    allowedCidrs:
        - string
    connectionLimit: 0
    defaultPoolId: string
    defaultTlsContainerRef: string
    description: string
    insertHeaders:
        string: any
    loadbalancerId: string
    name: string
    protocol: string
    protocolPort: 0
    region: string
    sniContainerRefs:
        - string
    tags:
        - string
    tenantId: string
    timeoutClientData: 0
    timeoutMemberConnect: 0
    timeoutMemberData: 0
    timeoutTcpInspect: 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

    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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). 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).
    AllowedCidrs List<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 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.
    Tags List<string>
    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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). 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).
    AllowedCidrs []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 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.
    Tags []string
    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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). Changing this creates a new Listener.
    protocolPort Integer
    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).
    allowedCidrs List<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 Integer
    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,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.
    tags List<String>
    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 Integer
    The client inactivity timeout in milliseconds.
    timeoutMemberConnect Integer
    The member connection timeout in milliseconds.
    timeoutMemberData Integer
    The member inactivity timeout in milliseconds.
    timeoutTcpInspect Integer
    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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). 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).
    allowedCidrs 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
    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.
    tags string[]
    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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). Changing this creates a new Listener.
    protocol_port int
    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).
    allowed_cidrs Sequence[str]
    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 int
    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 Mapping[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 Sequence[str]
    A list of references to Barbican Secrets containers which store SNI information. See here for more information.
    tags Sequence[str]
    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 int
    The client inactivity timeout in milliseconds.
    timeout_member_connect int
    The member connection timeout in milliseconds.
    timeout_member_data int
    The member inactivity timeout in milliseconds.
    timeout_tcp_inspect 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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). 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).
    allowedCidrs List<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
    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<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 List<String>
    A list of references to Barbican Secrets containers which store SNI information. See here for more information.
    tags List<String>
    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.

    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,
        admin_state_up: Optional[bool] = None,
        allowed_cidrs: Optional[Sequence[str]] = None,
        connection_limit: Optional[int] = None,
        default_pool_id: Optional[str] = None,
        default_tls_container_ref: Optional[str] = None,
        description: Optional[str] = None,
        insert_headers: Optional[Mapping[str, Any]] = None,
        loadbalancer_id: Optional[str] = None,
        name: Optional[str] = None,
        protocol: Optional[str] = None,
        protocol_port: Optional[int] = None,
        region: Optional[str] = None,
        sni_container_refs: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None,
        tenant_id: Optional[str] = None,
        timeout_client_data: Optional[int] = None,
        timeout_member_connect: Optional[int] = None,
        timeout_member_data: Optional[int] = None,
        timeout_tcp_inspect: 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)
    Resource lookup is not supported in YAML
    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
    The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    AllowedCidrs List<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 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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). 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.
    Tags List<string>
    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).
    AllowedCidrs []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 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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). 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.
    Tags []string
    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).
    allowedCidrs List<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 Integer
    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,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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). Changing this creates a new Listener.
    protocolPort Integer
    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.
    tags List<String>
    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 Integer
    The client inactivity timeout in milliseconds.
    timeoutMemberConnect Integer
    The member connection timeout in milliseconds.
    timeoutMemberData Integer
    The member inactivity timeout in milliseconds.
    timeoutTcpInspect Integer
    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).
    allowedCidrs 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
    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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). 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.
    tags string[]
    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).
    allowed_cidrs Sequence[str]
    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 int
    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 Mapping[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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). Changing this creates a new Listener.
    protocol_port int
    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 Sequence[str]
    A list of references to Barbican Secrets containers which store SNI information. See here for more information.
    tags Sequence[str]
    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 int
    The client inactivity timeout in milliseconds.
    timeout_member_connect int
    The member connection timeout in milliseconds.
    timeout_member_data int
    The member inactivity timeout in milliseconds.
    timeout_tcp_inspect 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).
    allowedCidrs List<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
    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<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, UDP, SCTP (supported only in Octavia minor version >= 2.23) or PROMETHEUS (supported only in Octavia minor version >=2.25). 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 List<String>
    A list of references to Barbican Secrets containers which store SNI information. See here for more information.
    tags List<String>
    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.

    Import

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

    $ pulumi import openstack:loadbalancer/listener:Listener listener_1 b67ce64e-8b26-405d-afeb-4a078901f15a

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

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v4.0.0 published on Tuesday, May 21, 2024 by Pulumi
    pulumi/pulumi-openstack