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

openstack.loadbalancer.PoolV1

Explore with Pulumi AI

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

    Manages a V1 load balancer pool resource within OpenStack.

    Example Usage

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

const pool1 = new openstack.loadbalancer.PoolV1("pool1", {
    lbMethod: "ROUND_ROBIN",
    lbProvider: "haproxy",
    monitorIds: ["67890"],
    protocol: "HTTP",
    subnetId: "12345",
});

    import pulumi
import pulumi_openstack as openstack

pool1 = openstack.loadbalancer.PoolV1("pool1",
    lb_method="ROUND_ROBIN",
    lb_provider="haproxy",
    monitor_ids=["67890"],
    protocol="HTTP",
    subnet_id="12345")

    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.NewPoolV1(ctx, "pool1", &loadbalancer.PoolV1Args{
			LbMethod:   pulumi.String("ROUND_ROBIN"),
			LbProvider: pulumi.String("haproxy"),
			MonitorIds: pulumi.StringArray{
				pulumi.String("67890"),
			},
			Protocol: pulumi.String("HTTP"),
			SubnetId: pulumi.String("12345"),
		})
		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 pool1 = new OpenStack.LoadBalancer.PoolV1("pool1", new()
    {
        LbMethod = "ROUND_ROBIN",
        LbProvider = "haproxy",
        MonitorIds = new[]
        {
            "67890",
        },
        Protocol = "HTTP",
        SubnetId = "12345",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.loadbalancer.PoolV1;
import com.pulumi.openstack.loadbalancer.PoolV1Args;
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 pool1 = new PoolV1("pool1", PoolV1Args.builder()        
            .lbMethod("ROUND_ROBIN")
            .lbProvider("haproxy")
            .monitorIds("67890")
            .protocol("HTTP")
            .subnetId("12345")
            .build());

    }
}

    resources:
  pool1:
    type: openstack:loadbalancer:PoolV1
    properties:
      lbMethod: ROUND_ROBIN
      lbProvider: haproxy
      monitorIds:
        - '67890'
      protocol: HTTP
      subnetId: '12345'

    Complete Load Balancing Stack Example

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

const network1 = new openstack.networking.Network("network1", {adminStateUp: true});
const subnet1 = new openstack.networking.Subnet("subnet1", {
    networkId: network1.id,
    cidr: "192.168.199.0/24",
    ipVersion: 4,
});
const secgroup1 = new openstack.compute.SecGroup("secgroup1", {
    description: "Rules for secgroup_1",
    rules: [
        {
            fromPort: -1,
            toPort: -1,
            ipProtocol: "icmp",
            cidr: "0.0.0.0/0",
        },
        {
            fromPort: 80,
            toPort: 80,
            ipProtocol: "tcp",
            cidr: "0.0.0.0/0",
        },
    ],
});
const instance1 = new openstack.compute.Instance("instance1", {
    securityGroups: [
        "default",
        secgroup1.name,
    ],
    networks: [{
        uuid: network1.id,
    }],
});
const instance2 = new openstack.compute.Instance("instance2", {
    securityGroups: [
        "default",
        secgroup1.name,
    ],
    networks: [{
        uuid: network1.id,
    }],
});
const monitor1 = new openstack.loadbalancer.MonitorV1("monitor1", {
    type: "TCP",
    delay: 30,
    timeout: 5,
    maxRetries: 3,
    adminStateUp: "true",
});
const pool1 = new openstack.loadbalancer.PoolV1("pool1", {
    protocol: "TCP",
    subnetId: subnet1.id,
    lbMethod: "ROUND_ROBIN",
    monitorIds: [monitor1.id],
});
const member1 = new openstack.loadbalancer.MemberV1("member1", {
    poolId: pool1.id,
    address: instance1.accessIpV4,
    port: 80,
});
const member2 = new openstack.loadbalancer.MemberV1("member2", {
    poolId: pool1.id,
    address: instance2.accessIpV4,
    port: 80,
});
const vip1 = new openstack.loadbalancer.Vip("vip1", {
    subnetId: subnet1.id,
    protocol: "TCP",
    port: 80,
    poolId: pool1.id,
});

    import pulumi
import pulumi_openstack as openstack

network1 = openstack.networking.Network("network1", admin_state_up=True)
subnet1 = openstack.networking.Subnet("subnet1",
    network_id=network1.id,
    cidr="192.168.199.0/24",
    ip_version=4)
secgroup1 = openstack.compute.SecGroup("secgroup1",
    description="Rules for secgroup_1",
    rules=[
        openstack.compute.SecGroupRuleArgs(
            from_port=-1,
            to_port=-1,
            ip_protocol="icmp",
            cidr="0.0.0.0/0",
        ),
        openstack.compute.SecGroupRuleArgs(
            from_port=80,
            to_port=80,
            ip_protocol="tcp",
            cidr="0.0.0.0/0",
        ),
    ])
instance1 = openstack.compute.Instance("instance1",
    security_groups=[
        "default",
        secgroup1.name,
    ],
    networks=[openstack.compute.InstanceNetworkArgs(
        uuid=network1.id,
    )])
instance2 = openstack.compute.Instance("instance2",
    security_groups=[
        "default",
        secgroup1.name,
    ],
    networks=[openstack.compute.InstanceNetworkArgs(
        uuid=network1.id,
    )])
monitor1 = openstack.loadbalancer.MonitorV1("monitor1",
    type="TCP",
    delay=30,
    timeout=5,
    max_retries=3,
    admin_state_up="true")
pool1 = openstack.loadbalancer.PoolV1("pool1",
    protocol="TCP",
    subnet_id=subnet1.id,
    lb_method="ROUND_ROBIN",
    monitor_ids=[monitor1.id])
member1 = openstack.loadbalancer.MemberV1("member1",
    pool_id=pool1.id,
    address=instance1.access_ip_v4,
    port=80)
member2 = openstack.loadbalancer.MemberV1("member2",
    pool_id=pool1.id,
    address=instance2.access_ip_v4,
    port=80)
vip1 = openstack.loadbalancer.Vip("vip1",
    subnet_id=subnet1.id,
    protocol="TCP",
    port=80,
    pool_id=pool1.id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network1, err := networking.NewNetwork(ctx, "network1", &networking.NetworkArgs{
			AdminStateUp: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		subnet1, err := networking.NewSubnet(ctx, "subnet1", &networking.SubnetArgs{
			NetworkId: network1.ID(),
			Cidr:      pulumi.String("192.168.199.0/24"),
			IpVersion: pulumi.Int(4),
		})
		if err != nil {
			return err
		}
		secgroup1, err := compute.NewSecGroup(ctx, "secgroup1", &compute.SecGroupArgs{
			Description: pulumi.String("Rules for secgroup_1"),
			Rules: compute.SecGroupRuleArray{
				&compute.SecGroupRuleArgs{
					FromPort:   -1,
					ToPort:     -1,
					IpProtocol: pulumi.String("icmp"),
					Cidr:       pulumi.String("0.0.0.0/0"),
				},
				&compute.SecGroupRuleArgs{
					FromPort:   pulumi.Int(80),
					ToPort:     pulumi.Int(80),
					IpProtocol: pulumi.String("tcp"),
					Cidr:       pulumi.String("0.0.0.0/0"),
				},
			},
		})
		if err != nil {
			return err
		}
		instance1, err := compute.NewInstance(ctx, "instance1", &compute.InstanceArgs{
			SecurityGroups: pulumi.StringArray{
				pulumi.String("default"),
				secgroup1.Name,
			},
			Networks: compute.InstanceNetworkArray{
				&compute.InstanceNetworkArgs{
					Uuid: network1.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		instance2, err := compute.NewInstance(ctx, "instance2", &compute.InstanceArgs{
			SecurityGroups: pulumi.StringArray{
				pulumi.String("default"),
				secgroup1.Name,
			},
			Networks: compute.InstanceNetworkArray{
				&compute.InstanceNetworkArgs{
					Uuid: network1.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		monitor1, err := loadbalancer.NewMonitorV1(ctx, "monitor1", &loadbalancer.MonitorV1Args{
			Type:         pulumi.String("TCP"),
			Delay:        pulumi.Int(30),
			Timeout:      pulumi.Int(5),
			MaxRetries:   pulumi.Int(3),
			AdminStateUp: pulumi.String("true"),
		})
		if err != nil {
			return err
		}
		pool1, err := loadbalancer.NewPoolV1(ctx, "pool1", &loadbalancer.PoolV1Args{
			Protocol: pulumi.String("TCP"),
			SubnetId: subnet1.ID(),
			LbMethod: pulumi.String("ROUND_ROBIN"),
			MonitorIds: pulumi.StringArray{
				monitor1.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = loadbalancer.NewMemberV1(ctx, "member1", &loadbalancer.MemberV1Args{
			PoolId:  pool1.ID(),
			Address: instance1.AccessIpV4,
			Port:    pulumi.Int(80),
		})
		if err != nil {
			return err
		}
		_, err = loadbalancer.NewMemberV1(ctx, "member2", &loadbalancer.MemberV1Args{
			PoolId:  pool1.ID(),
			Address: instance2.AccessIpV4,
			Port:    pulumi.Int(80),
		})
		if err != nil {
			return err
		}
		_, err = loadbalancer.NewVip(ctx, "vip1", &loadbalancer.VipArgs{
			SubnetId: subnet1.ID(),
			Protocol: pulumi.String("TCP"),
			Port:     pulumi.Int(80),
			PoolId:   pool1.ID(),
		})
		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 network1 = new OpenStack.Networking.Network("network1", new()
    {
        AdminStateUp = true,
    });

    var subnet1 = new OpenStack.Networking.Subnet("subnet1", new()
    {
        NetworkId = network1.Id,
        Cidr = "192.168.199.0/24",
        IpVersion = 4,
    });

    var secgroup1 = new OpenStack.Compute.SecGroup("secgroup1", new()
    {
        Description = "Rules for secgroup_1",
        Rules = new[]
        {
            new OpenStack.Compute.Inputs.SecGroupRuleArgs
            {
                FromPort = -1,
                ToPort = -1,
                IpProtocol = "icmp",
                Cidr = "0.0.0.0/0",
            },
            new OpenStack.Compute.Inputs.SecGroupRuleArgs
            {
                FromPort = 80,
                ToPort = 80,
                IpProtocol = "tcp",
                Cidr = "0.0.0.0/0",
            },
        },
    });

    var instance1 = new OpenStack.Compute.Instance("instance1", new()
    {
        SecurityGroups = new[]
        {
            "default",
            secgroup1.Name,
        },
        Networks = new[]
        {
            new OpenStack.Compute.Inputs.InstanceNetworkArgs
            {
                Uuid = network1.Id,
            },
        },
    });

    var instance2 = new OpenStack.Compute.Instance("instance2", new()
    {
        SecurityGroups = new[]
        {
            "default",
            secgroup1.Name,
        },
        Networks = new[]
        {
            new OpenStack.Compute.Inputs.InstanceNetworkArgs
            {
                Uuid = network1.Id,
            },
        },
    });

    var monitor1 = new OpenStack.LoadBalancer.MonitorV1("monitor1", new()
    {
        Type = "TCP",
        Delay = 30,
        Timeout = 5,
        MaxRetries = 3,
        AdminStateUp = "true",
    });

    var pool1 = new OpenStack.LoadBalancer.PoolV1("pool1", new()
    {
        Protocol = "TCP",
        SubnetId = subnet1.Id,
        LbMethod = "ROUND_ROBIN",
        MonitorIds = new[]
        {
            monitor1.Id,
        },
    });

    var member1 = new OpenStack.LoadBalancer.MemberV1("member1", new()
    {
        PoolId = pool1.Id,
        Address = instance1.AccessIpV4,
        Port = 80,
    });

    var member2 = new OpenStack.LoadBalancer.MemberV1("member2", new()
    {
        PoolId = pool1.Id,
        Address = instance2.AccessIpV4,
        Port = 80,
    });

    var vip1 = new OpenStack.LoadBalancer.Vip("vip1", new()
    {
        SubnetId = subnet1.Id,
        Protocol = "TCP",
        Port = 80,
        PoolId = pool1.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.networking.Network;
import com.pulumi.openstack.networking.NetworkArgs;
import com.pulumi.openstack.networking.Subnet;
import com.pulumi.openstack.networking.SubnetArgs;
import com.pulumi.openstack.compute.SecGroup;
import com.pulumi.openstack.compute.SecGroupArgs;
import com.pulumi.openstack.compute.inputs.SecGroupRuleArgs;
import com.pulumi.openstack.compute.Instance;
import com.pulumi.openstack.compute.InstanceArgs;
import com.pulumi.openstack.compute.inputs.InstanceNetworkArgs;
import com.pulumi.openstack.loadbalancer.MonitorV1;
import com.pulumi.openstack.loadbalancer.MonitorV1Args;
import com.pulumi.openstack.loadbalancer.PoolV1;
import com.pulumi.openstack.loadbalancer.PoolV1Args;
import com.pulumi.openstack.loadbalancer.MemberV1;
import com.pulumi.openstack.loadbalancer.MemberV1Args;
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 network1 = new Network("network1", NetworkArgs.builder()        
            .adminStateUp("true")
            .build());

        var subnet1 = new Subnet("subnet1", SubnetArgs.builder()        
            .networkId(network1.id())
            .cidr("192.168.199.0/24")
            .ipVersion(4)
            .build());

        var secgroup1 = new SecGroup("secgroup1", SecGroupArgs.builder()        
            .description("Rules for secgroup_1")
            .rules(            
                SecGroupRuleArgs.builder()
                    .fromPort("TODO: GenUnaryOpExpression")
                    .toPort("TODO: GenUnaryOpExpression")
                    .ipProtocol("icmp")
                    .cidr("0.0.0.0/0")
                    .build(),
                SecGroupRuleArgs.builder()
                    .fromPort(80)
                    .toPort(80)
                    .ipProtocol("tcp")
                    .cidr("0.0.0.0/0")
                    .build())
            .build());

        var instance1 = new Instance("instance1", InstanceArgs.builder()        
            .securityGroups(            
                "default",
                secgroup1.name())
            .networks(InstanceNetworkArgs.builder()
                .uuid(network1.id())
                .build())
            .build());

        var instance2 = new Instance("instance2", InstanceArgs.builder()        
            .securityGroups(            
                "default",
                secgroup1.name())
            .networks(InstanceNetworkArgs.builder()
                .uuid(network1.id())
                .build())
            .build());

        var monitor1 = new MonitorV1("monitor1", MonitorV1Args.builder()        
            .type("TCP")
            .delay(30)
            .timeout(5)
            .maxRetries(3)
            .adminStateUp("true")
            .build());

        var pool1 = new PoolV1("pool1", PoolV1Args.builder()        
            .protocol("TCP")
            .subnetId(subnet1.id())
            .lbMethod("ROUND_ROBIN")
            .monitorIds(monitor1.id())
            .build());

        var member1 = new MemberV1("member1", MemberV1Args.builder()        
            .poolId(pool1.id())
            .address(instance1.accessIpV4())
            .port(80)
            .build());

        var member2 = new MemberV1("member2", MemberV1Args.builder()        
            .poolId(pool1.id())
            .address(instance2.accessIpV4())
            .port(80)
            .build());

        var vip1 = new Vip("vip1", VipArgs.builder()        
            .subnetId(subnet1.id())
            .protocol("TCP")
            .port(80)
            .poolId(pool1.id())
            .build());

    }
}

    Coming soon!

    Notes

    The member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Create PoolV1 Resource

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

    Constructor syntax

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

@overload
def PoolV1(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           lb_method: Optional[str] = None,
           protocol: Optional[str] = None,
           subnet_id: Optional[str] = None,
           lb_provider: Optional[str] = None,
           members: Optional[Sequence[str]] = None,
           monitor_ids: Optional[Sequence[str]] = None,
           name: Optional[str] = None,
           region: Optional[str] = None,
           tenant_id: Optional[str] = None)
    func NewPoolV1(ctx *Context, name string, args PoolV1Args, opts ...ResourceOption) (*PoolV1, error)
    public PoolV1(string name, PoolV1Args args, CustomResourceOptions? opts = null)
    public PoolV1(String name, PoolV1Args args)
public PoolV1(String name, PoolV1Args args, CustomResourceOptions options)

    type: openstack:loadbalancer:PoolV1
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 PoolV1Args
    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 PoolV1Args
    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 PoolV1Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PoolV1Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PoolV1Args
    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 poolV1Resource = new OpenStack.LoadBalancer.PoolV1("poolV1Resource", new()
{
    LbMethod = "string",
    Protocol = "string",
    SubnetId = "string",
    LbProvider = "string",
    MonitorIds = new[]
    {
        "string",
    },
    Name = "string",
    Region = "string",
    TenantId = "string",
});

    example, err := loadbalancer.NewPoolV1(ctx, "poolV1Resource", &loadbalancer.PoolV1Args{
	LbMethod:   pulumi.String("string"),
	Protocol:   pulumi.String("string"),
	SubnetId:   pulumi.String("string"),
	LbProvider: pulumi.String("string"),
	MonitorIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:     pulumi.String("string"),
	Region:   pulumi.String("string"),
	TenantId: pulumi.String("string"),
})

    var poolV1Resource = new PoolV1("poolV1Resource", PoolV1Args.builder()        
    .lbMethod("string")
    .protocol("string")
    .subnetId("string")
    .lbProvider("string")
    .monitorIds("string")
    .name("string")
    .region("string")
    .tenantId("string")
    .build());

    pool_v1_resource = openstack.loadbalancer.PoolV1("poolV1Resource",
    lb_method="string",
    protocol="string",
    subnet_id="string",
    lb_provider="string",
    monitor_ids=["string"],
    name="string",
    region="string",
    tenant_id="string")

    const poolV1Resource = new openstack.loadbalancer.PoolV1("poolV1Resource", {
    lbMethod: "string",
    protocol: "string",
    subnetId: "string",
    lbProvider: "string",
    monitorIds: ["string"],
    name: "string",
    region: "string",
    tenantId: "string",
});

    type: openstack:loadbalancer:PoolV1
properties:
    lbMethod: string
    lbProvider: string
    monitorIds:
        - string
    name: string
    protocol: string
    region: string
    subnetId: string
    tenantId: string

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

    LbMethod string
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    Protocol string
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    SubnetId string
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    LbProvider string
    The backend load balancing provider. For example: haproxy, F5, etc.
    Members List<string>
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    MonitorIds List<string>
    A list of IDs of monitors to associate with the pool.
    Name string
    The name of the pool. Changing this updates the name of the existing pool.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    TenantId string
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    LbMethod string
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    Protocol string
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    SubnetId string
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    LbProvider string
    The backend load balancing provider. For example: haproxy, F5, etc.
    Members []string
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    MonitorIds []string
    A list of IDs of monitors to associate with the pool.
    Name string
    The name of the pool. Changing this updates the name of the existing pool.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    TenantId string
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    lbMethod String
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    protocol String
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    subnetId String
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    lbProvider String
    The backend load balancing provider. For example: haproxy, F5, etc.
    members List<String>
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    monitorIds List<String>
    A list of IDs of monitors to associate with the pool.
    name String
    The name of the pool. Changing this updates the name of the existing pool.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    tenantId String
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    lbMethod string
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    protocol string
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    subnetId string
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    lbProvider string
    The backend load balancing provider. For example: haproxy, F5, etc.
    members string[]
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    monitorIds string[]
    A list of IDs of monitors to associate with the pool.
    name string
    The name of the pool. Changing this updates the name of the existing pool.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    tenantId string
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    lb_method str
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    protocol str
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    subnet_id str
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    lb_provider str
    The backend load balancing provider. For example: haproxy, F5, etc.
    members Sequence[str]
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    monitor_ids Sequence[str]
    A list of IDs of monitors to associate with the pool.
    name str
    The name of the pool. Changing this updates the name of the existing pool.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    tenant_id str
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    lbMethod String
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    protocol String
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    subnetId String
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    lbProvider String
    The backend load balancing provider. For example: haproxy, F5, etc.
    members List<String>
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    monitorIds List<String>
    A list of IDs of monitors to associate with the pool.
    name String
    The name of the pool. Changing this updates the name of the existing pool.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    tenantId String
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.

    Outputs

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

    Get an existing PoolV1 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?: PoolV1State, opts?: CustomResourceOptions): PoolV1
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        lb_method: Optional[str] = None,
        lb_provider: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        monitor_ids: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        protocol: Optional[str] = None,
        region: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tenant_id: Optional[str] = None) -> PoolV1
    func GetPoolV1(ctx *Context, name string, id IDInput, state *PoolV1State, opts ...ResourceOption) (*PoolV1, error)
    public static PoolV1 Get(string name, Input<string> id, PoolV1State? state, CustomResourceOptions? opts = null)
    public static PoolV1 get(String name, Output<String> id, PoolV1State 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:
    LbMethod string
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    LbProvider string
    The backend load balancing provider. For example: haproxy, F5, etc.
    Members List<string>
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    MonitorIds List<string>
    A list of IDs of monitors to associate with the pool.
    Name string
    The name of the pool. Changing this updates the name of the existing pool.
    Protocol string
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    SubnetId string
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    TenantId string
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    LbMethod string
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    LbProvider string
    The backend load balancing provider. For example: haproxy, F5, etc.
    Members []string
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    MonitorIds []string
    A list of IDs of monitors to associate with the pool.
    Name string
    The name of the pool. Changing this updates the name of the existing pool.
    Protocol string
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    SubnetId string
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    TenantId string
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    lbMethod String
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    lbProvider String
    The backend load balancing provider. For example: haproxy, F5, etc.
    members List<String>
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    monitorIds List<String>
    A list of IDs of monitors to associate with the pool.
    name String
    The name of the pool. Changing this updates the name of the existing pool.
    protocol String
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    subnetId String
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    tenantId String
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    lbMethod string
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    lbProvider string
    The backend load balancing provider. For example: haproxy, F5, etc.
    members string[]
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    monitorIds string[]
    A list of IDs of monitors to associate with the pool.
    name string
    The name of the pool. Changing this updates the name of the existing pool.
    protocol string
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    subnetId string
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    tenantId string
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    lb_method str
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    lb_provider str
    The backend load balancing provider. For example: haproxy, F5, etc.
    members Sequence[str]
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    monitor_ids Sequence[str]
    A list of IDs of monitors to associate with the pool.
    name str
    The name of the pool. Changing this updates the name of the existing pool.
    protocol str
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    subnet_id str
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    tenant_id str
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.
    lbMethod String
    The algorithm used to distribute load between the members of the pool. The current specification supports 'ROUND_ROBIN' and 'LEAST_CONNECTIONS' as valid values for this attribute.
    lbProvider String
    The backend load balancing provider. For example: haproxy, F5, etc.
    members List<String>
    An existing node to add to the pool. Changing this updates the members of the pool. The member object structure is documented below. Please note that the member block is deprecated in favor of the openstack.loadbalancer.MemberV1 resource.

    Deprecated: Use openstack.loadbalancer.MemberV1 instead

    monitorIds List<String>
    A list of IDs of monitors to associate with the pool.
    name String
    The name of the pool. Changing this updates the name of the existing pool.
    protocol String
    The protocol used by the pool members, you can use either 'TCP, 'HTTP', or 'HTTPS'. Changing this creates a new pool.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB pool. If omitted, the region argument of the provider is used. Changing this creates a new LB pool.
    subnetId String
    The network on which the members of the pool will be located. Only members that are on this network can be added to the pool. Changing this creates a new pool.
    tenantId String
    The owner of the pool. Required if admin wants to create a pool member for another tenant. Changing this creates a new pool.

    Import

    Load Balancer Pools can be imported using the id, e.g.

    $ pulumi import openstack:loadbalancer/poolV1:PoolV1 pool_1 b255e6ba-02ad-43e6-8951-3428ca26b713

    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