Docs Packages
  1. Packages
  2. OpenStack
  3. API Docs
  4. loadbalancer
  5. LoadBalancer
OpenStack v3.15.2 published on Friday, Mar 29, 2024 by Pulumi
pulumi/pulumi-openstack

openstack.loadbalancer.LoadBalancer

Explore with Pulumi AI

openstack logo
OpenStack v3.15.2 published on Friday, Mar 29, 2024 by Pulumi
pulumi/pulumi-openstack

    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

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

const lb1 = new openstack.loadbalancer.LoadBalancer("lb1", {vipSubnetId: "d9415786-5f1a-428b-b35f-2f1523e146d2"});

    import pulumi
import pulumi_openstack as openstack

lb1 = openstack.loadbalancer.LoadBalancer("lb1", vip_subnet_id="d9415786-5f1a-428b-b35f-2f1523e146d2")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancer.NewLoadBalancer(ctx, "lb1", &loadbalancer.LoadBalancerArgs{
			VipSubnetId: pulumi.String("d9415786-5f1a-428b-b35f-2f1523e146d2"),
		})
		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 lb1 = new OpenStack.LoadBalancer.LoadBalancer("lb1", new()
    {
        VipSubnetId = "d9415786-5f1a-428b-b35f-2f1523e146d2",
    });

});

    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());

    }
}

    resources:
  lb1:
    type: openstack:loadbalancer:LoadBalancer
    properties:
      vipSubnetId: d9415786-5f1a-428b-b35f-2f1523e146d2

    Create LoadBalancer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LoadBalancer(name: string, args?: LoadBalancerArgs, opts?: CustomResourceOptions);
    @overload
def LoadBalancer(resource_name: str,
                 args: Optional[LoadBalancerArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def LoadBalancer(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 admin_state_up: Optional[bool] = None,
                 availability_zone: Optional[str] = None,
                 description: Optional[str] = None,
                 flavor_id: Optional[str] = None,
                 loadbalancer_provider: Optional[str] = None,
                 name: Optional[str] = None,
                 region: Optional[str] = None,
                 security_group_ids: Optional[Sequence[str]] = None,
                 tags: Optional[Sequence[str]] = None,
                 tenant_id: Optional[str] = None,
                 vip_address: Optional[str] = None,
                 vip_network_id: Optional[str] = None,
                 vip_port_id: Optional[str] = None,
                 vip_subnet_id: Optional[str] = None)
    func NewLoadBalancer(ctx *Context, name string, args *LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)
    public LoadBalancer(string name, LoadBalancerArgs? args = null, CustomResourceOptions? opts = null)
    public LoadBalancer(String name, LoadBalancerArgs args)
public LoadBalancer(String name, LoadBalancerArgs args, CustomResourceOptions options)

    type: openstack:loadbalancer:LoadBalancer
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 LoadBalancerArgs
    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 LoadBalancerArgs
    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 LoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var loadBalancerResource = new OpenStack.LoadBalancer.LoadBalancer("loadBalancerResource", new()
{
    AdminStateUp = false,
    AvailabilityZone = "string",
    Description = "string",
    FlavorId = "string",
    LoadbalancerProvider = "string",
    Name = "string",
    Region = "string",
    SecurityGroupIds = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
    TenantId = "string",
    VipAddress = "string",
    VipNetworkId = "string",
    VipPortId = "string",
    VipSubnetId = "string",
});

    example, err := loadbalancer.NewLoadBalancer(ctx, "loadBalancerResource", &loadbalancer.LoadBalancerArgs{
	AdminStateUp:         pulumi.Bool(false),
	AvailabilityZone:     pulumi.String("string"),
	Description:          pulumi.String("string"),
	FlavorId:             pulumi.String("string"),
	LoadbalancerProvider: pulumi.String("string"),
	Name:                 pulumi.String("string"),
	Region:               pulumi.String("string"),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantId:     pulumi.String("string"),
	VipAddress:   pulumi.String("string"),
	VipNetworkId: pulumi.String("string"),
	VipPortId:    pulumi.String("string"),
	VipSubnetId:  pulumi.String("string"),
})

    var loadBalancerResource = new LoadBalancer("loadBalancerResource", LoadBalancerArgs.builder()        
    .adminStateUp(false)
    .availabilityZone("string")
    .description("string")
    .flavorId("string")
    .loadbalancerProvider("string")
    .name("string")
    .region("string")
    .securityGroupIds("string")
    .tags("string")
    .tenantId("string")
    .vipAddress("string")
    .vipNetworkId("string")
    .vipPortId("string")
    .vipSubnetId("string")
    .build());

    load_balancer_resource = openstack.loadbalancer.LoadBalancer("loadBalancerResource",
    admin_state_up=False,
    availability_zone="string",
    description="string",
    flavor_id="string",
    loadbalancer_provider="string",
    name="string",
    region="string",
    security_group_ids=["string"],
    tags=["string"],
    tenant_id="string",
    vip_address="string",
    vip_network_id="string",
    vip_port_id="string",
    vip_subnet_id="string")

    const loadBalancerResource = new openstack.loadbalancer.LoadBalancer("loadBalancerResource", {
    adminStateUp: false,
    availabilityZone: "string",
    description: "string",
    flavorId: "string",
    loadbalancerProvider: "string",
    name: "string",
    region: "string",
    securityGroupIds: ["string"],
    tags: ["string"],
    tenantId: "string",
    vipAddress: "string",
    vipNetworkId: "string",
    vipPortId: "string",
    vipSubnetId: "string",
});

    type: openstack:loadbalancer:LoadBalancer
properties:
    adminStateUp: false
    availabilityZone: string
    description: string
    flavorId: string
    loadbalancerProvider: string
    name: string
    region: string
    securityGroupIds:
        - string
    tags:
        - string
    tenantId: string
    vipAddress: string
    vipNetworkId: string
    vipPortId: string
    vipSubnetId: string

    LoadBalancer 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 LoadBalancer resource accepts the following input properties:

    AdminStateUp bool
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    AvailabilityZone string
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    Description string
    Human-readable description for the Loadbalancer.
    FlavorId string
    The UUID of a flavor. Changing this creates a new loadbalancer.
    LoadbalancerProvider string
    The name of the provider. Changing this creates a new loadbalancer.
    Name string
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    SecurityGroupIds List<string>
    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 List<string>
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    TenantId string
    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 string
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    VipNetworkId string
    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 string
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    VipSubnetId string
    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.
    AdminStateUp bool
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    AvailabilityZone string
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    Description string
    Human-readable description for the Loadbalancer.
    FlavorId string
    The UUID of a flavor. Changing this creates a new loadbalancer.
    LoadbalancerProvider string
    The name of the provider. Changing this creates a new loadbalancer.
    Name string
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    SecurityGroupIds []string
    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 []string
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    TenantId string
    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 string
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    VipNetworkId string
    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 string
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    VipSubnetId string
    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.
    adminStateUp Boolean
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    availabilityZone String
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    description String
    Human-readable description for the Loadbalancer.
    flavorId String
    The UUID of a flavor. Changing this creates a new loadbalancer.
    loadbalancerProvider String
    The name of the provider. Changing this creates a new loadbalancer.
    name String
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    securityGroupIds List<String>
    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 List<String>
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    tenantId String
    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 String
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    vipNetworkId String
    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 String
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    vipSubnetId String
    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.
    adminStateUp boolean
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    availabilityZone string
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    description string
    Human-readable description for the Loadbalancer.
    flavorId string
    The UUID of a flavor. Changing this creates a new loadbalancer.
    loadbalancerProvider string
    The name of the provider. Changing this creates a new loadbalancer.
    name string
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    securityGroupIds string[]
    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 string[]
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    tenantId string
    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 string
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    vipNetworkId string
    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 string
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    vipSubnetId string
    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.
    admin_state_up bool
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    availability_zone str
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    description str
    Human-readable description for the Loadbalancer.
    flavor_id str
    The UUID of a flavor. Changing this creates a new loadbalancer.
    loadbalancer_provider str
    The name of the provider. Changing this creates a new loadbalancer.
    name str
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    security_group_ids Sequence[str]
    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 Sequence[str]
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    tenant_id str
    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.
    vip_address str
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    vip_network_id str
    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.
    vip_port_id str
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    vip_subnet_id str
    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.
    adminStateUp Boolean
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    availabilityZone String
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    description String
    Human-readable description for the Loadbalancer.
    flavorId String
    The UUID of a flavor. Changing this creates a new loadbalancer.
    loadbalancerProvider String
    The name of the provider. Changing this creates a new loadbalancer.
    name String
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    securityGroupIds List<String>
    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 List<String>
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    tenantId String
    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 String
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    vipNetworkId String
    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 String
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    vipSubnetId String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LoadBalancer 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 LoadBalancer Resource

    Get an existing LoadBalancer 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?: LoadBalancerState, opts?: CustomResourceOptions): LoadBalancer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state_up: Optional[bool] = None,
        availability_zone: Optional[str] = None,
        description: Optional[str] = None,
        flavor_id: Optional[str] = None,
        loadbalancer_provider: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None,
        tenant_id: Optional[str] = None,
        vip_address: Optional[str] = None,
        vip_network_id: Optional[str] = None,
        vip_port_id: Optional[str] = None,
        vip_subnet_id: Optional[str] = None) -> LoadBalancer
    func GetLoadBalancer(ctx *Context, name string, id IDInput, state *LoadBalancerState, opts ...ResourceOption) (*LoadBalancer, error)
    public static LoadBalancer Get(string name, Input<string> id, LoadBalancerState? state, CustomResourceOptions? opts = null)
    public static LoadBalancer get(String name, Output<String> id, LoadBalancerState 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 Loadbalancer. A valid value is true (UP) or false (DOWN).
    AvailabilityZone string
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    Description string
    Human-readable description for the Loadbalancer.
    FlavorId string
    The UUID of a flavor. Changing this creates a new loadbalancer.
    LoadbalancerProvider string
    The name of the provider. Changing this creates a new loadbalancer.
    Name string
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    SecurityGroupIds List<string>
    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 List<string>
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    TenantId string
    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 string
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    VipNetworkId string
    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 string
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    VipSubnetId string
    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.
    AdminStateUp bool
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    AvailabilityZone string
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    Description string
    Human-readable description for the Loadbalancer.
    FlavorId string
    The UUID of a flavor. Changing this creates a new loadbalancer.
    LoadbalancerProvider string
    The name of the provider. Changing this creates a new loadbalancer.
    Name string
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    SecurityGroupIds []string
    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 []string
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    TenantId string
    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 string
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    VipNetworkId string
    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 string
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    VipSubnetId string
    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.
    adminStateUp Boolean
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    availabilityZone String
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    description String
    Human-readable description for the Loadbalancer.
    flavorId String
    The UUID of a flavor. Changing this creates a new loadbalancer.
    loadbalancerProvider String
    The name of the provider. Changing this creates a new loadbalancer.
    name String
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    securityGroupIds List<String>
    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 List<String>
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    tenantId String
    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 String
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    vipNetworkId String
    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 String
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    vipSubnetId String
    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.
    adminStateUp boolean
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    availabilityZone string
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    description string
    Human-readable description for the Loadbalancer.
    flavorId string
    The UUID of a flavor. Changing this creates a new loadbalancer.
    loadbalancerProvider string
    The name of the provider. Changing this creates a new loadbalancer.
    name string
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    securityGroupIds string[]
    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 string[]
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    tenantId string
    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 string
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    vipNetworkId string
    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 string
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    vipSubnetId string
    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.
    admin_state_up bool
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    availability_zone str
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    description str
    Human-readable description for the Loadbalancer.
    flavor_id str
    The UUID of a flavor. Changing this creates a new loadbalancer.
    loadbalancer_provider str
    The name of the provider. Changing this creates a new loadbalancer.
    name str
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    security_group_ids Sequence[str]
    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 Sequence[str]
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    tenant_id str
    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.
    vip_address str
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    vip_network_id str
    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.
    vip_port_id str
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    vip_subnet_id str
    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.
    adminStateUp Boolean
    The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN).
    availabilityZone String
    The availability zone of the Loadbalancer. Changing this creates a new loadbalancer. Available only for Octavia minor version 2.14 or later.
    description String
    Human-readable description for the Loadbalancer.
    flavorId String
    The UUID of a flavor. Changing this creates a new loadbalancer.
    loadbalancerProvider String
    The name of the provider. Changing this creates a new loadbalancer.
    name String
    Human-readable name for the Loadbalancer. 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 LB member. If omitted, the region argument of the provider is used. Changing this creates a new LB member.
    securityGroupIds List<String>
    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 List<String>
    A list of simple strings assigned to the loadbalancer. Available only for Octavia minor version 2.5 or later.
    tenantId String
    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 String
    The ip address of the load balancer. Changing this creates a new loadbalancer.
    vipNetworkId String
    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 String
    The port UUID that the loadbalancer will use. Changing this creates a new loadbalancer. It is available only for Octavia.
    vipSubnetId String
    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.

    Import

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

    $ pulumi import openstack:loadbalancer/loadBalancer:LoadBalancer loadbalancer_1 19bcfdc7-c521-4a7e-9459-6750bd16df76

    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 v3.15.2 published on Friday, Mar 29, 2024 by Pulumi
    pulumi/pulumi-openstack