1. Packages
  2. Vkcs Provider
  3. API Docs
  4. LbMember
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.LbMember

Explore with Pulumi AI

Manages a member resource within VKCS.

Example Usage

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

const frontHttp = new vkcs.LbMember("frontHttp", {
    poolId: vkcs_lb_pool.http.id,
    address: "192.168.199.110",
    protocolPort: 8080,
});
Copy
import pulumi
import pulumi_vkcs as vkcs

front_http = vkcs.LbMember("frontHttp",
    pool_id=vkcs_lb_pool["http"]["id"],
    address="192.168.199.110",
    protocol_port=8080)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.NewLbMember(ctx, "frontHttp", &vkcs.LbMemberArgs{
			PoolId:       pulumi.Any(vkcs_lb_pool.Http.Id),
			Address:      pulumi.String("192.168.199.110"),
			ProtocolPort: pulumi.Float64(8080),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var frontHttp = new Vkcs.LbMember("frontHttp", new()
    {
        PoolId = vkcs_lb_pool.Http.Id,
        Address = "192.168.199.110",
        ProtocolPort = 8080,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.LbMember;
import com.pulumi.vkcs.LbMemberArgs;
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 frontHttp = new LbMember("frontHttp", LbMemberArgs.builder()
            .poolId(vkcs_lb_pool.http().id())
            .address("192.168.199.110")
            .protocolPort(8080)
            .build());

    }
}
Copy
resources:
  frontHttp:
    type: vkcs:LbMember
    properties:
      poolId: ${vkcs_lb_pool.http.id}
      address: 192.168.199.110
      protocolPort: 8080
Copy

Create LbMember Resource

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

Constructor syntax

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

@overload
def LbMember(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             address: Optional[str] = None,
             pool_id: Optional[str] = None,
             protocol_port: Optional[float] = None,
             admin_state_up: Optional[bool] = None,
             lb_member_id: Optional[str] = None,
             name: Optional[str] = None,
             region: Optional[str] = None,
             subnet_id: Optional[str] = None,
             timeouts: Optional[LbMemberTimeoutsArgs] = None,
             weight: Optional[float] = None)
func NewLbMember(ctx *Context, name string, args LbMemberArgs, opts ...ResourceOption) (*LbMember, error)
public LbMember(string name, LbMemberArgs args, CustomResourceOptions? opts = null)
public LbMember(String name, LbMemberArgs args)
public LbMember(String name, LbMemberArgs args, CustomResourceOptions options)
type: vkcs:LbMember
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LbMemberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LbMemberArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LbMemberArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LbMemberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LbMemberArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var lbMemberResource = new Vkcs.LbMember("lbMemberResource", new()
{
    Address = "string",
    PoolId = "string",
    ProtocolPort = 0,
    AdminStateUp = false,
    LbMemberId = "string",
    Name = "string",
    Region = "string",
    SubnetId = "string",
    Timeouts = new Vkcs.Inputs.LbMemberTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    Weight = 0,
});
Copy
example, err := vkcs.NewLbMember(ctx, "lbMemberResource", &vkcs.LbMemberArgs{
Address: pulumi.String("string"),
PoolId: pulumi.String("string"),
ProtocolPort: pulumi.Float64(0),
AdminStateUp: pulumi.Bool(false),
LbMemberId: pulumi.String("string"),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
SubnetId: pulumi.String("string"),
Timeouts: &.LbMemberTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
Weight: pulumi.Float64(0),
})
Copy
var lbMemberResource = new LbMember("lbMemberResource", LbMemberArgs.builder()
    .address("string")
    .poolId("string")
    .protocolPort(0)
    .adminStateUp(false)
    .lbMemberId("string")
    .name("string")
    .region("string")
    .subnetId("string")
    .timeouts(LbMemberTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .weight(0)
    .build());
Copy
lb_member_resource = vkcs.LbMember("lbMemberResource",
    address="string",
    pool_id="string",
    protocol_port=0,
    admin_state_up=False,
    lb_member_id="string",
    name="string",
    region="string",
    subnet_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    weight=0)
Copy
const lbMemberResource = new vkcs.LbMember("lbMemberResource", {
    address: "string",
    poolId: "string",
    protocolPort: 0,
    adminStateUp: false,
    lbMemberId: "string",
    name: "string",
    region: "string",
    subnetId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    weight: 0,
});
Copy
type: vkcs:LbMember
properties:
    address: string
    adminStateUp: false
    lbMemberId: string
    name: string
    poolId: string
    protocolPort: 0
    region: string
    subnetId: string
    timeouts:
        create: string
        delete: string
        update: string
    weight: 0
Copy

LbMember Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The LbMember resource accepts the following input properties:

Address This property is required. string
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
PoolId This property is required. string
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
ProtocolPort This property is required. double
required number → The port on which to listen for client traffic. Changing this creates a new member.
AdminStateUp bool
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
LbMemberId string
string → ID of the resource.
Name string
optional string → Human-readable name for the member.
Region string
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
SubnetId string
optional string → The subnet in which to access the member. Changing this creates a new member.
Timeouts LbMemberTimeouts
Weight double
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
Address This property is required. string
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
PoolId This property is required. string
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
ProtocolPort This property is required. float64
required number → The port on which to listen for client traffic. Changing this creates a new member.
AdminStateUp bool
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
LbMemberId string
string → ID of the resource.
Name string
optional string → Human-readable name for the member.
Region string
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
SubnetId string
optional string → The subnet in which to access the member. Changing this creates a new member.
Timeouts LbMemberTimeoutsArgs
Weight float64
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
address This property is required. String
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
poolId This property is required. String
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
protocolPort This property is required. Double
required number → The port on which to listen for client traffic. Changing this creates a new member.
adminStateUp Boolean
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
lbMemberId String
string → ID of the resource.
name String
optional string → Human-readable name for the member.
region String
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
subnetId String
optional string → The subnet in which to access the member. Changing this creates a new member.
timeouts LbMemberTimeouts
weight Double
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
address This property is required. string
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
poolId This property is required. string
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
protocolPort This property is required. number
required number → The port on which to listen for client traffic. Changing this creates a new member.
adminStateUp boolean
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
lbMemberId string
string → ID of the resource.
name string
optional string → Human-readable name for the member.
region string
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
subnetId string
optional string → The subnet in which to access the member. Changing this creates a new member.
timeouts LbMemberTimeouts
weight number
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
address This property is required. str
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
pool_id This property is required. str
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
protocol_port This property is required. float
required number → The port on which to listen for client traffic. Changing this creates a new member.
admin_state_up bool
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
lb_member_id str
string → ID of the resource.
name str
optional string → Human-readable name for the member.
region str
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
subnet_id str
optional string → The subnet in which to access the member. Changing this creates a new member.
timeouts LbMemberTimeoutsArgs
weight float
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
address This property is required. String
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
poolId This property is required. String
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
protocolPort This property is required. Number
required number → The port on which to listen for client traffic. Changing this creates a new member.
adminStateUp Boolean
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
lbMemberId String
string → ID of the resource.
name String
optional string → Human-readable name for the member.
region String
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
subnetId String
optional string → The subnet in which to access the member. Changing this creates a new member.
timeouts Property Map
weight Number
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.

Outputs

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

Get an existing LbMember 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?: LbMemberState, opts?: CustomResourceOptions): LbMember
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        admin_state_up: Optional[bool] = None,
        lb_member_id: Optional[str] = None,
        name: Optional[str] = None,
        pool_id: Optional[str] = None,
        protocol_port: Optional[float] = None,
        region: Optional[str] = None,
        subnet_id: Optional[str] = None,
        timeouts: Optional[LbMemberTimeoutsArgs] = None,
        weight: Optional[float] = None) -> LbMember
func GetLbMember(ctx *Context, name string, id IDInput, state *LbMemberState, opts ...ResourceOption) (*LbMember, error)
public static LbMember Get(string name, Input<string> id, LbMemberState? state, CustomResourceOptions? opts = null)
public static LbMember get(String name, Output<String> id, LbMemberState state, CustomResourceOptions options)
resources:  _:    type: vkcs:LbMember    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
AdminStateUp bool
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
LbMemberId string
string → ID of the resource.
Name string
optional string → Human-readable name for the member.
PoolId string
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
ProtocolPort double
required number → The port on which to listen for client traffic. Changing this creates a new member.
Region string
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
SubnetId string
optional string → The subnet in which to access the member. Changing this creates a new member.
Timeouts LbMemberTimeouts
Weight double
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
Address string
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
AdminStateUp bool
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
LbMemberId string
string → ID of the resource.
Name string
optional string → Human-readable name for the member.
PoolId string
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
ProtocolPort float64
required number → The port on which to listen for client traffic. Changing this creates a new member.
Region string
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
SubnetId string
optional string → The subnet in which to access the member. Changing this creates a new member.
Timeouts LbMemberTimeoutsArgs
Weight float64
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
address String
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
adminStateUp Boolean
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
lbMemberId String
string → ID of the resource.
name String
optional string → Human-readable name for the member.
poolId String
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
protocolPort Double
required number → The port on which to listen for client traffic. Changing this creates a new member.
region String
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
subnetId String
optional string → The subnet in which to access the member. Changing this creates a new member.
timeouts LbMemberTimeouts
weight Double
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
address string
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
adminStateUp boolean
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
lbMemberId string
string → ID of the resource.
name string
optional string → Human-readable name for the member.
poolId string
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
protocolPort number
required number → The port on which to listen for client traffic. Changing this creates a new member.
region string
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
subnetId string
optional string → The subnet in which to access the member. Changing this creates a new member.
timeouts LbMemberTimeouts
weight number
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
address str
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
admin_state_up bool
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
lb_member_id str
string → ID of the resource.
name str
optional string → Human-readable name for the member.
pool_id str
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
protocol_port float
required number → The port on which to listen for client traffic. Changing this creates a new member.
region str
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
subnet_id str
optional string → The subnet in which to access the member. Changing this creates a new member.
timeouts LbMemberTimeoutsArgs
weight float
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.
address String
required string → The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.
adminStateUp Boolean
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
lbMemberId String
string → ID of the resource.
name String
optional string → Human-readable name for the member.
poolId String
required string → The id of the pool that this member will be assigned to. Changing this creates a new member.
protocolPort Number
required number → The port on which to listen for client traffic. Changing this creates a new member.
region String
optional string → The region in which to obtain the Loadbalancer client. If omitted, the region argument of the provider is used. Changing this creates a new member.
subnetId String
optional string → The subnet in which to access the member. Changing this creates a new member.
timeouts Property Map
weight Number
optional number → A positive integer value that indicates the relative portion of traffic that this member should receive from the pool. For example, a member with a weight of 10 receives five times as much traffic as a member with a weight of 2. Defaults to 1.

Supporting Types

LbMemberTimeouts
, LbMemberTimeoutsArgs

Create string
Delete string
Update string
Create string
Delete string
Update string
create String
delete String
update String
create string
delete string
update string
create str
delete str
update str
create String
delete String
update String

Import

Load Balancer Pool Member can be imported using the Pool ID and Member ID separated by a slash, e.g.:

$ pulumi import vkcs:index/lbMember:LbMember member_1 c22974d2-4c95-4bcb-9819-0afc5ed303d5/9563b79c-8460-47da-8a95-2711b746510f
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
vkcs vk-cs/terraform-provider-vkcs
License
Notes
This Pulumi package is based on the vkcs Terraform Provider.