Class LoadBalancer


  • public class LoadBalancer
    extends com.pulumi.resources.CustomResource
    Manages a V2 loadbalancer 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.LoadBalancer; import com.pulumi.openstack.loadbalancer.LoadBalancerArgs; 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 lb1 = new LoadBalancer("lb1", LoadBalancerArgs.builder() .vipSubnetId("d9415786-5f1a-428b-b35f-2f1523e146d2") .build()); } } ``` ## Import Load Balancer can be imported using the Load Balancer ID, e.g.: ```sh $ pulumi import openstack:loadbalancer/loadBalancer:LoadBalancer loadbalancer_1 19bcfdc7-c521-4a7e-9459-6750bd16df76 ```
    • 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
    • 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.lang.String>> availabilityZone()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> flavorId()  
      static LoadBalancer get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, LoadBalancerState 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> loadbalancerProvider()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> securityGroupIds()  
      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.String> vipAddress()  
      com.pulumi.core.Output<java.lang.String> vipNetworkId()  
      com.pulumi.core.Output<java.lang.String> vipPortId()  
      com.pulumi.core.Output<java.lang.String> vipSubnetId()  
      • 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

      • LoadBalancer

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

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

        public LoadBalancer​(java.lang.String name,
                            @Nullable
                            LoadBalancerArgs 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 Loadbalancer. A valid value is true (UP) or false (DOWN).
      • availabilityZone

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> availabilityZone()
        Returns:
        The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia **minor version 2.14 or later**.
      • description

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

        public com.pulumi.core.Output<java.lang.String> flavorId()
        Returns:
        The UUID of a flavor. Changing this creates a new loadbalancer.
      • loadbalancerProvider

        public com.pulumi.core.Output<java.lang.String> loadbalancerProvider()
        Returns:
        The name of the provider. Changing this creates a new loadbalancer.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Human-readable name for the Loadbalancer. Does not have to be unique.
      • 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 LB member. If omitted, the `region` argument of the provider is used. Changing this creates a new LB member.
      • securityGroupIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> securityGroupIds()
        Returns:
        A list of security group IDs to apply to the loadbalancer. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> tags()
        Returns:
        A list of simple strings assigned to the loadbalancer. Available only for Octavia **minor version 2.5 or later**.
      • tenantId

        public com.pulumi.core.Output<java.lang.String> tenantId()
        Returns:
        Required for admins. The UUID of the tenant who owns the Loadbalancer. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new loadbalancer.
      • vipAddress

        public com.pulumi.core.Output<java.lang.String> vipAddress()
        Returns:
        The ip address of the load balancer. Changing this creates a new loadbalancer.
      • vipNetworkId

        public com.pulumi.core.Output<java.lang.String> vipNetworkId()
        Returns:
        The network on which to allocate the Loadbalancer's address. A tenant can only create Loadbalancers on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new loadbalancer. It is available only for Octavia.
      • vipPortId

        public com.pulumi.core.Output<java.lang.String> vipPortId()
        Returns:
        The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
      • vipSubnetId

        public com.pulumi.core.Output<java.lang.String> vipSubnetId()
        Returns:
        The subnet on which to allocate the Loadbalancer's address. A tenant can only create Loadbalancers on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new loadbalancer. It is required to Neutron LBaaS but optional for Octavia.
      • get

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