Package com.pulumi.openstack.loadbalancer

Class Vip

  • public class Vip
extends com.pulumi.resources.CustomResource
    Manages a V1 load balancer vip resource within OpenStack. ## Example Usage ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.openstack.loadbalancer.Vip; import com.pulumi.openstack.loadbalancer.VipArgs; 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 vip1 = new Vip("vip1", VipArgs.builder() .poolId("67890") .port(80) .protocol("HTTP") .subnetId("12345") .build()); } } ``` ## Import Load Balancer VIPs can be imported using the `id`, e.g. ```sh $ pulumi import openstack:loadbalancer/vip:Vip vip_1 50e16b26-89c1-475e-a492-76167182511e ```

    • 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
      Vip​(java.lang.String name)  
      Vip​(java.lang.String name, VipArgs args)  
      Vip​(java.lang.String name, VipArgs 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.lang.String> address()  
      com.pulumi.core.Output<java.lang.Boolean> adminStateUp()  
      com.pulumi.core.Output<java.lang.Integer> connLimit()  
      com.pulumi.core.Output<java.lang.String> description()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> floatingIp()  
      static Vip get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VipState 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.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> persistence()  
      com.pulumi.core.Output<java.lang.String> poolId()  
      com.pulumi.core.Output<java.lang.Integer> port()  
      com.pulumi.core.Output<java.lang.String> portId()  
      com.pulumi.core.Output<java.lang.String> protocol()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> subnetId()  
      com.pulumi.core.Output<java.lang.String> tenantId()  

      • 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

      • Vip

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

      • Vip

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

      • Vip

        public Vip​(java.lang.String name,
           VipArgs 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

      • address

        public com.pulumi.core.Output<java.lang.String> address()
        Returns:
        The IP address of the vip. Changing this creates a new vip.

      • adminStateUp

        public com.pulumi.core.Output<java.lang.Boolean> adminStateUp()
        Returns:
        The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.

      • connLimit

        public com.pulumi.core.Output<java.lang.Integer> connLimit()
        Returns:
        The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        Human-readable description for the vip. Changing this updates the description of the existing vip.

      • floatingIp

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> floatingIp()
        Returns:
        A *Networking* Floating IP that will be associated with the vip. The Floating IP must be provisioned already.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the vip. Changing this updates the name of the existing vip.

      • persistence

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> persistence()
        Returns:
        Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.

      • poolId

        public com.pulumi.core.Output<java.lang.String> poolId()
        Returns:
        The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.

      • port

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

      • portId

        public com.pulumi.core.Output<java.lang.String> portId()
        Returns:
        Port UUID for this VIP at associated floating IP (if any).

      • protocol

        public com.pulumi.core.Output<java.lang.String> protocol()
        Returns:
        The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.

      • 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 a VIP. If omitted, the `region` argument of the provider is used. Changing this creates a new VIP.

      • subnetId

        public com.pulumi.core.Output<java.lang.String> subnetId()
        Returns:
        The network on which to allocate the vip's address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.

      • tenantId

        public com.pulumi.core.Output<java.lang.String> tenantId()
        Returns:
        The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

      • get

        public static Vip get​(java.lang.String name,
                      com.pulumi.core.Output<java.lang.String> id,
                      @Nullable
                      VipState 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.