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

openstack.loadbalancer.Vip

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 vip resource within OpenStack.

    Example Usage

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

const vip1 = new openstack.loadbalancer.Vip("vip1", {
    poolId: "67890",
    port: 80,
    protocol: "HTTP",
    subnetId: "12345",
});

    import pulumi
import pulumi_openstack as openstack

vip1 = openstack.loadbalancer.Vip("vip1",
    pool_id="67890",
    port=80,
    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.NewVip(ctx, "vip1", &loadbalancer.VipArgs{
			PoolId:   pulumi.String("67890"),
			Port:     pulumi.Int(80),
			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 vip1 = new OpenStack.LoadBalancer.Vip("vip1", new()
    {
        PoolId = "67890",
        Port = 80,
        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.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 vip1 = new Vip("vip1", VipArgs.builder()        
            .poolId("67890")
            .port(80)
            .protocol("HTTP")
            .subnetId("12345")
            .build());

    }
}

    resources:
  vip1:
    type: openstack:loadbalancer:Vip
    properties:
      poolId: '67890'
      port: 80
      protocol: HTTP
      subnetId: '12345'

    Create Vip Resource

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

    Constructor syntax

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

@overload
def Vip(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        pool_id: Optional[str] = None,
        subnet_id: Optional[str] = None,
        protocol: Optional[str] = None,
        port: Optional[int] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        persistence: Optional[Mapping[str, Any]] = None,
        floating_ip: Optional[str] = None,
        address: Optional[str] = None,
        conn_limit: Optional[int] = None,
        region: Optional[str] = None,
        admin_state_up: Optional[bool] = None,
        tenant_id: Optional[str] = None)
    func NewVip(ctx *Context, name string, args VipArgs, opts ...ResourceOption) (*Vip, error)
    public Vip(string name, VipArgs args, CustomResourceOptions? opts = null)
    public Vip(String name, VipArgs args)
public Vip(String name, VipArgs args, CustomResourceOptions options)

    type: openstack:loadbalancer:Vip
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 VipArgs
    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 VipArgs
    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 VipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VipArgs
    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 vipResource = new OpenStack.LoadBalancer.Vip("vipResource", new()
{
    PoolId = "string",
    SubnetId = "string",
    Protocol = "string",
    Port = 0,
    Description = "string",
    Name = "string",
    Persistence = 
    {
        { "string", "any" },
    },
    FloatingIp = "string",
    Address = "string",
    ConnLimit = 0,
    Region = "string",
    AdminStateUp = false,
    TenantId = "string",
});

    example, err := loadbalancer.NewVip(ctx, "vipResource", &loadbalancer.VipArgs{
	PoolId:      pulumi.String("string"),
	SubnetId:    pulumi.String("string"),
	Protocol:    pulumi.String("string"),
	Port:        pulumi.Int(0),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Persistence: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	FloatingIp:   pulumi.String("string"),
	Address:      pulumi.String("string"),
	ConnLimit:    pulumi.Int(0),
	Region:       pulumi.String("string"),
	AdminStateUp: pulumi.Bool(false),
	TenantId:     pulumi.String("string"),
})

    var vipResource = new Vip("vipResource", VipArgs.builder()        
    .poolId("string")
    .subnetId("string")
    .protocol("string")
    .port(0)
    .description("string")
    .name("string")
    .persistence(Map.of("string", "any"))
    .floatingIp("string")
    .address("string")
    .connLimit(0)
    .region("string")
    .adminStateUp(false)
    .tenantId("string")
    .build());

    vip_resource = openstack.loadbalancer.Vip("vipResource",
    pool_id="string",
    subnet_id="string",
    protocol="string",
    port=0,
    description="string",
    name="string",
    persistence={
        "string": "any",
    },
    floating_ip="string",
    address="string",
    conn_limit=0,
    region="string",
    admin_state_up=False,
    tenant_id="string")

    const vipResource = new openstack.loadbalancer.Vip("vipResource", {
    poolId: "string",
    subnetId: "string",
    protocol: "string",
    port: 0,
    description: "string",
    name: "string",
    persistence: {
        string: "any",
    },
    floatingIp: "string",
    address: "string",
    connLimit: 0,
    region: "string",
    adminStateUp: false,
    tenantId: "string",
});

    type: openstack:loadbalancer:Vip
properties:
    address: string
    adminStateUp: false
    connLimit: 0
    description: string
    floatingIp: string
    name: string
    persistence:
        string: any
    poolId: string
    port: 0
    protocol: string
    region: string
    subnetId: string
    tenantId: string

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

    PoolId string
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    Port int
    The port on which to listen for client traffic. Changing this creates a new vip.
    Protocol string
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    SubnetId string
    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.
    Address string
    The IP address of the vip. Changing this creates a new vip.
    AdminStateUp bool
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    ConnLimit int
    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.
    Description string
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    FloatingIp string
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    Name string
    The name of the vip. Changing this updates the name of the existing vip.
    Persistence Dictionary<string, object>
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    Region string
    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.
    TenantId string
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    PoolId string
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    Port int
    The port on which to listen for client traffic. Changing this creates a new vip.
    Protocol string
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    SubnetId string
    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.
    Address string
    The IP address of the vip. Changing this creates a new vip.
    AdminStateUp bool
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    ConnLimit int
    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.
    Description string
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    FloatingIp string
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    Name string
    The name of the vip. Changing this updates the name of the existing vip.
    Persistence map[string]interface{}
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    Region string
    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.
    TenantId string
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    poolId String
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    port Integer
    The port on which to listen for client traffic. Changing this creates a new vip.
    protocol String
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    subnetId String
    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.
    address String
    The IP address of the vip. Changing this creates a new vip.
    adminStateUp Boolean
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    connLimit Integer
    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.
    description String
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    floatingIp String
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    name String
    The name of the vip. Changing this updates the name of the existing vip.
    persistence Map<String,Object>
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    region String
    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.
    tenantId String
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    poolId string
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    port number
    The port on which to listen for client traffic. Changing this creates a new vip.
    protocol string
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    subnetId string
    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.
    address string
    The IP address of the vip. Changing this creates a new vip.
    adminStateUp boolean
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    connLimit number
    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.
    description string
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    floatingIp string
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    name string
    The name of the vip. Changing this updates the name of the existing vip.
    persistence {[key: string]: any}
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    region string
    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.
    tenantId string
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    pool_id str
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    port int
    The port on which to listen for client traffic. Changing this creates a new vip.
    protocol str
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    subnet_id str
    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.
    address str
    The IP address of the vip. Changing this creates a new vip.
    admin_state_up bool
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    conn_limit int
    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.
    description str
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    floating_ip str
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    name str
    The name of the vip. Changing this updates the name of the existing vip.
    persistence Mapping[str, Any]
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    region str
    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.
    tenant_id str
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    poolId String
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    port Number
    The port on which to listen for client traffic. Changing this creates a new vip.
    protocol String
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    subnetId String
    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.
    address String
    The IP address of the vip. Changing this creates a new vip.
    adminStateUp Boolean
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    connLimit Number
    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.
    description String
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    floatingIp String
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    name String
    The name of the vip. Changing this updates the name of the existing vip.
    persistence Map<Any>
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    region String
    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.
    tenantId String
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Vip resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PortId string
    Port UUID for this VIP at associated floating IP (if any).
    Id string
    The provider-assigned unique ID for this managed resource.
    PortId string
    Port UUID for this VIP at associated floating IP (if any).
    id String
    The provider-assigned unique ID for this managed resource.
    portId String
    Port UUID for this VIP at associated floating IP (if any).
    id string
    The provider-assigned unique ID for this managed resource.
    portId string
    Port UUID for this VIP at associated floating IP (if any).
    id str
    The provider-assigned unique ID for this managed resource.
    port_id str
    Port UUID for this VIP at associated floating IP (if any).
    id String
    The provider-assigned unique ID for this managed resource.
    portId String
    Port UUID for this VIP at associated floating IP (if any).

    Look up Existing Vip Resource

    Get an existing Vip 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?: VipState, opts?: CustomResourceOptions): Vip
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        admin_state_up: Optional[bool] = None,
        conn_limit: Optional[int] = None,
        description: Optional[str] = None,
        floating_ip: Optional[str] = None,
        name: Optional[str] = None,
        persistence: Optional[Mapping[str, Any]] = None,
        pool_id: Optional[str] = None,
        port: Optional[int] = None,
        port_id: Optional[str] = None,
        protocol: Optional[str] = None,
        region: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tenant_id: Optional[str] = None) -> Vip
    func GetVip(ctx *Context, name string, id IDInput, state *VipState, opts ...ResourceOption) (*Vip, error)
    public static Vip Get(string name, Input<string> id, VipState? state, CustomResourceOptions? opts = null)
    public static Vip get(String name, Output<String> id, VipState 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:
    Address string
    The IP address of the vip. Changing this creates a new vip.
    AdminStateUp bool
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    ConnLimit int
    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.
    Description string
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    FloatingIp string
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    Name string
    The name of the vip. Changing this updates the name of the existing vip.
    Persistence Dictionary<string, object>
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    PoolId string
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    Port int
    The port on which to listen for client traffic. Changing this creates a new vip.
    PortId string
    Port UUID for this VIP at associated floating IP (if any).
    Protocol string
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    Region string
    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.
    SubnetId string
    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.
    TenantId string
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    Address string
    The IP address of the vip. Changing this creates a new vip.
    AdminStateUp bool
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    ConnLimit int
    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.
    Description string
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    FloatingIp string
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    Name string
    The name of the vip. Changing this updates the name of the existing vip.
    Persistence map[string]interface{}
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    PoolId string
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    Port int
    The port on which to listen for client traffic. Changing this creates a new vip.
    PortId string
    Port UUID for this VIP at associated floating IP (if any).
    Protocol string
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    Region string
    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.
    SubnetId string
    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.
    TenantId string
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    address String
    The IP address of the vip. Changing this creates a new vip.
    adminStateUp Boolean
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    connLimit Integer
    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.
    description String
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    floatingIp String
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    name String
    The name of the vip. Changing this updates the name of the existing vip.
    persistence Map<String,Object>
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    poolId String
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    port Integer
    The port on which to listen for client traffic. Changing this creates a new vip.
    portId String
    Port UUID for this VIP at associated floating IP (if any).
    protocol String
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    region String
    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.
    subnetId String
    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.
    tenantId String
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    address string
    The IP address of the vip. Changing this creates a new vip.
    adminStateUp boolean
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    connLimit number
    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.
    description string
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    floatingIp string
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    name string
    The name of the vip. Changing this updates the name of the existing vip.
    persistence {[key: string]: any}
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    poolId string
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    port number
    The port on which to listen for client traffic. Changing this creates a new vip.
    portId string
    Port UUID for this VIP at associated floating IP (if any).
    protocol string
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    region string
    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.
    subnetId string
    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.
    tenantId string
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    address str
    The IP address of the vip. Changing this creates a new vip.
    admin_state_up bool
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    conn_limit int
    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.
    description str
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    floating_ip str
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    name str
    The name of the vip. Changing this updates the name of the existing vip.
    persistence Mapping[str, Any]
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    pool_id str
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    port int
    The port on which to listen for client traffic. Changing this creates a new vip.
    port_id str
    Port UUID for this VIP at associated floating IP (if any).
    protocol str
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    region str
    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.
    subnet_id str
    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.
    tenant_id str
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.
    address String
    The IP address of the vip. Changing this creates a new vip.
    adminStateUp Boolean
    The administrative state of the vip. Acceptable values are "true" and "false". Changing this value updates the state of the existing vip.
    connLimit Number
    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.
    description String
    Human-readable description for the vip. Changing this updates the description of the existing vip.
    floatingIp String
    A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
    name String
    The name of the vip. Changing this updates the name of the existing vip.
    persistence Map<Any>
    Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
    poolId String
    The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
    port Number
    The port on which to listen for client traffic. Changing this creates a new vip.
    portId String
    Port UUID for this VIP at associated floating IP (if any).
    protocol String
    The protocol - can be either 'TCP, 'HTTP', or HTTPS'. Changing this creates a new vip.
    region String
    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.
    subnetId String
    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.
    tenantId String
    The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

    Import

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

    $ pulumi import openstack:loadbalancer/vip:Vip vip_1 50e16b26-89c1-475e-a492-76167182511e

    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