Class Pool

Manages a V2 pool resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
public MyStack()
{
    var pool1 = new OpenStack.LoadBalancer.Pool("pool1", new OpenStack.LoadBalancer.PoolArgs
    {
        LbMethod = "ROUND_ROBIN",
        ListenerId = "d9415786-5f1a-428b-b35f-2f1523e146d2",
        Persistence = new OpenStack.LoadBalancer.Inputs.PoolPersistenceArgs
        {
            CookieName = "testCookie",
            Type = "APP_COOKIE",
        },
        Protocol = "HTTP",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Pool

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.OpenStack.LoadBalancer

Assembly: Pulumi.OpenStack.dll

Syntax

public class Pool : CustomResource

Constructors

Pool(String, PoolArgs, CustomResourceOptions)

Create a Pool resource with the given unique name, arguments, and options.

Declaration

public Pool(string name, PoolArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
PoolArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AdminStateUp

The administrative state of the pool. A valid value is true (UP) or false (DOWN).

Declaration

public Output<bool?> AdminStateUp { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Description

Human-readable description for the pool.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

LbMethod

The load balancing algorithm to distribute traffic to the pool's members. Must be one of ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP, or SOURCE_IP_PORT (supported only in Octavia).

Declaration

public Output<string> LbMethod { get; }

Property Value

Type	Description
Output<System.String>

ListenerId

The Listener on which the members of the pool will be associated with. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.

Declaration

public Output<string> ListenerId { get; }

Property Value

Type	Description
Output<System.String>

LoadbalancerId

The load balancer on which to provision this pool. Changing this creates a new pool. Note: One of LoadbalancerID or ListenerID must be provided.

Declaration

public Output<string> LoadbalancerId { get; }

Property Value

Type	Description
Output<System.String>

Name

Human-readable name for the pool.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Persistence

Omit this field to prevent session persistence. Indicates whether connections in the same session will be processed by the same Pool member or not. Changing this creates a new pool.

Declaration

public Output<PoolPersistence> Persistence { get; }

Property Value

Type	Description
Output<PoolPersistence>

Protocol

The protocol - can either be TCP, HTTP, HTTPS, PROXY or UDP (supported only in Octavia). Changing this creates a new pool.

Declaration

public Output<string> Protocol { get; }

Property Value

Type	Description
Output<System.String>

Region

The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new pool.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

TenantId

Required for admins. The UUID of the tenant who owns the pool. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new pool.

Declaration

public Output<string> TenantId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, PoolState, CustomResourceOptions)

Get an existing Pool resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Pool Get(string name, Input<string> id, PoolState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
PoolState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Pool