Package com.pulumi.openstack.loadbalancer

Class Listener

  • public class Listener
extends com.pulumi.resources.CustomResource
    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 ```java 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() .insertHeaders(Map.of("X-Forwarded-For", "true")) .loadbalancerId("d9415786-5f1a-428b-b35f-2f1523e146d2") .protocol("HTTP") .protocolPort(8080) .build()); } } ``` ## Import Load Balancer Listener can be imported using the Listener ID, e.g.: ```sh $ pulumi import openstack:loadbalancer/listener:Listener listener_1 b67ce64e-8b26-405d-afeb-4a078901f15a ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Listener​(java.lang.String name)  
      Listener​(java.lang.String name, ListenerArgs args)  
      Listener​(java.lang.String name, ListenerArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> adminStateUp()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> allowedCidrs()  
      com.pulumi.core.Output<java.lang.Integer> connectionLimit()  
      com.pulumi.core.Output<java.lang.String> defaultPoolId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultTlsContainerRef()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static Listener get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ListenerState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> insertHeaders()  
      com.pulumi.core.Output<java.lang.String> loadbalancerId()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> protocol()  
      com.pulumi.core.Output<java.lang.Integer> protocolPort()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> sniContainerRefs()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> tags()  
      com.pulumi.core.Output<java.lang.String> tenantId()  
      com.pulumi.core.Output<java.lang.Integer> timeoutClientData()  
      com.pulumi.core.Output<java.lang.Integer> timeoutMemberConnect()  
      com.pulumi.core.Output<java.lang.Integer> timeoutMemberData()  
      com.pulumi.core.Output<java.lang.Integer> timeoutTcpInspect()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Listener

        public Listener​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Listener

        public Listener​(java.lang.String name,
                ListenerArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Listener

        public Listener​(java.lang.String name,
                ListenerArgs args,
                @Nullable
                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • adminStateUp

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> adminStateUp()
        Returns:
        The administrative state of the Listener. A valid value is true (UP) or false (DOWN).

      • allowedCidrs

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> allowedCidrs()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.Integer> connectionLimit()
        Returns:
        The maximum number of connections allowed for the Listener.

      • defaultPoolId

        public com.pulumi.core.Output<java.lang.String> defaultPoolId()
        Returns:
        The ID of the default pool with which the Listener is associated.

      • defaultTlsContainerRef

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultTlsContainerRef()
        Returns:
        A reference to a Barbican Secrets container which stores TLS information. This is required if the protocol is `TERMINATED_HTTPS`. See [here](https://wiki.openstack.org/wiki/Network/LBaaS/docs/how-to-create-tls-loadbalancer) for more information.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Human-readable description for the Listener.

      • insertHeaders

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> insertHeaders()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> loadbalancerId()
        Returns:
        The load balancer on which to provision this Listener. Changing this creates a new Listener.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Human-readable name for the Listener. Does not have to be unique.

      • protocol

        public com.pulumi.core.Output<java.lang.String> protocol()
        Returns:
        The protocol - can either be TCP, HTTP, HTTPS, TERMINATED_HTTPS, UDP (supported only in Octavia), 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

        public com.pulumi.core.Output<java.lang.Integer> protocolPort()
        Returns:
        The port on which to listen for client traffic. Changing this creates a new Listener.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> sniContainerRefs()
        Returns:
        A list of references to Barbican Secrets containers which store SNI information. See [here](https://wiki.openstack.org/wiki/Network/LBaaS/docs/how-to-create-tls-loadbalancer) for more information.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> tags()

      • tenantId

        public com.pulumi.core.Output<java.lang.String> tenantId()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.Integer> timeoutClientData()
        Returns:
        The client inactivity timeout in milliseconds.

      • timeoutMemberConnect

        public com.pulumi.core.Output<java.lang.Integer> timeoutMemberConnect()
        Returns:
        The member connection timeout in milliseconds.

      • timeoutMemberData

        public com.pulumi.core.Output<java.lang.Integer> timeoutMemberData()
        Returns:
        The member inactivity timeout in milliseconds.

      • timeoutTcpInspect

        public com.pulumi.core.Output<java.lang.Integer> timeoutTcpInspect()
        Returns:
        The time in milliseconds, to wait for additional TCP packets for content inspection.

      • get

        public static Listener get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           ListenerState state,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.