Class LoadBalancer
Manages a V2 loadbalancer resource within OpenStack.
Example Usage
using Pulumi;
using OpenStack = Pulumi.OpenStack;
class MyStack : Stack
{
public MyStack()
{
var lb1 = new OpenStack.LoadBalancer.LoadBalancer("lb1", new OpenStack.LoadBalancer.LoadBalancerArgs
{
VipSubnetId = "d9415786-5f1a-428b-b35f-2f1523e146d2",
});
}
}
Inherited Members
Namespace: Pulumi.OpenStack.LoadBalancer
Assembly: Pulumi.OpenStack.dll
Syntax
public class LoadBalancer : CustomResource
Constructors
View SourceLoadBalancer(String, LoadBalancerArgs, CustomResourceOptions)
Create a LoadBalancer resource with the given unique name, arguments, and options.
Declaration
public LoadBalancer(string name, LoadBalancerArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| LoadBalancerArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceAdminStateUp
The administrative state of the Loadbalancer. 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 Loadbalancer.
Declaration
public Output<string> Description { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
FlavorId
The UUID of a flavor. Changing this creates a new loadbalancer.
Declaration
public Output<string> FlavorId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
LoadbalancerProvider
The name of the provider. Changing this creates a new loadbalancer.
Declaration
public Output<string> LoadbalancerProvider { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Name
Human-readable name for the Loadbalancer. Does not have to be unique.
Declaration
public Output<string> Name { 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 LB member. If omitted, the
region argument of the provider is used. Changing this creates a new
LB member.
Declaration
public Output<string> Region { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecurityGroupIds
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).
Declaration
public Output<ImmutableArray<string>> SecurityGroupIds { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<System.String>> |
TenantId
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.
Declaration
public Output<string> TenantId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
VipAddress
The ip address of the load balancer. Changing this creates a new loadbalancer.
Declaration
public Output<string> VipAddress { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
VipPortId
The Port ID of the Load Balancer IP.
Declaration
public Output<string> VipPortId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
VipSubnetId
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.
Declaration
public Output<string> VipSubnetId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, LoadBalancerState, CustomResourceOptions)
Get an existing LoadBalancer resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static LoadBalancer Get(string name, Input<string> id, LoadBalancerState 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. |
| LoadBalancerState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| LoadBalancer |