Class Vip

Manages a V1 load balancer vip resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
public MyStack()
{
    var vip1 = new OpenStack.LoadBalancer.Vip(&quot;vip1&quot;, new OpenStack.LoadBalancer.VipArgs
    {
        PoolId = &quot;67890&quot;,
        Port = 80,
        Protocol = &quot;HTTP&quot;,
        SubnetId = &quot;12345&quot;,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Vip

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 Vip : CustomResource

Constructors

View Source

Vip(String, VipArgs, CustomResourceOptions)

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

Declaration

public Vip(string name, VipArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

View Source

Address

The IP address of the vip. Changing this creates a new vip.

Declaration

public Output<string> Address { get; }

Property Value

Type	Description
Output<System.String>

View Source

AdminStateUp

The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.

Declaration

public Output<bool> AdminStateUp { get; }

Property Value

Type	Description
Output<System.Boolean>

View Source

ConnLimit

The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.

Declaration

public Output<int> ConnLimit { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

Description

Human-readable description for the vip. Changing this updates the description of the existing vip.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

FloatingIp

A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.

Declaration

public Output<string> FloatingIp { get; }

Property Value

Type	Description
Output<System.String>

View Source

Name

The name of the vip. Changing this updates the name of the existing vip.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

Persistence

Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.

Declaration

public Output<ImmutableDictionary<string, object>> Persistence { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

PoolId

The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.

Declaration

public Output<string> PoolId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Port

The port on which to listen for client traffic. Changing this creates a new vip.

Declaration

public Output<int> Port { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

PortId

Port UUID for this VIP at associated floating IP (if any).

Declaration

public Output<string> PortId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Protocol

The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.

Declaration

public Output<string> Protocol { get; }

Property Value

Type	Description
Output<System.String>

View Source

Region

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

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

View Source

SubnetId

The network on which to allocate the vip's address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.

Declaration

public Output<string> SubnetId { get; }

Property Value

Type	Description
Output<System.String>

View Source

TenantId

The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

Declaration

public Output<string> TenantId { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

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

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

Declaration

public static Vip Get(string name, Input<string> id, VipState 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.
VipState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Vip