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

vkcs.LbMembers

Explore with Pulumi AI

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  frontWorkers:
    type: vkcs:LbMembers
    properties:
      poolId: ${vkcs_lb_pool.http.id}
      dynamic:
        - forEach: ${vkcs_compute_instance.front_worker}
          content:
            - address: ${member.value.access_ip_v4}
              protocolPort: 8080
Copy

Create LbMembers Resource

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

Constructor syntax

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

@overload
def LbMembers(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              pool_id: Optional[str] = None,
              lb_members_id: Optional[str] = None,
              members: Optional[Sequence[LbMembersMemberArgs]] = None,
              region: Optional[str] = None,
              timeouts: Optional[LbMembersTimeoutsArgs] = None)
func NewLbMembers(ctx *Context, name string, args LbMembersArgs, opts ...ResourceOption) (*LbMembers, error)
public LbMembers(string name, LbMembersArgs args, CustomResourceOptions? opts = null)
public LbMembers(String name, LbMembersArgs args)
public LbMembers(String name, LbMembersArgs args, CustomResourceOptions options)
type: vkcs:LbMembers
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. LbMembersArgs
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. LbMembersArgs
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. LbMembersArgs
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. LbMembersArgs
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. LbMembersArgs
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 lbMembersResource = new Vkcs.LbMembers("lbMembersResource", new()
{
    PoolId = "string",
    LbMembersId = "string",
    Members = new[]
    {
        new Vkcs.Inputs.LbMembersMemberArgs
        {
            Address = "string",
            ProtocolPort = 0,
            AdminStateUp = false,
            Backup = false,
            Id = "string",
            Name = "string",
            SubnetId = "string",
            Weight = 0,
        },
    },
    Region = "string",
    Timeouts = new Vkcs.Inputs.LbMembersTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := vkcs.NewLbMembers(ctx, "lbMembersResource", &vkcs.LbMembersArgs{
PoolId: pulumi.String("string"),
LbMembersId: pulumi.String("string"),
Members: .LbMembersMemberArray{
&.LbMembersMemberArgs{
Address: pulumi.String("string"),
ProtocolPort: pulumi.Float64(0),
AdminStateUp: pulumi.Bool(false),
Backup: pulumi.Bool(false),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
SubnetId: pulumi.String("string"),
Weight: pulumi.Float64(0),
},
},
Region: pulumi.String("string"),
Timeouts: &.LbMembersTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var lbMembersResource = new LbMembers("lbMembersResource", LbMembersArgs.builder()
    .poolId("string")
    .lbMembersId("string")
    .members(LbMembersMemberArgs.builder()
        .address("string")
        .protocolPort(0)
        .adminStateUp(false)
        .backup(false)
        .id("string")
        .name("string")
        .subnetId("string")
        .weight(0)
        .build())
    .region("string")
    .timeouts(LbMembersTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
lb_members_resource = vkcs.LbMembers("lbMembersResource",
    pool_id="string",
    lb_members_id="string",
    members=[{
        "address": "string",
        "protocol_port": 0,
        "admin_state_up": False,
        "backup": False,
        "id": "string",
        "name": "string",
        "subnet_id": "string",
        "weight": 0,
    }],
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const lbMembersResource = new vkcs.LbMembers("lbMembersResource", {
    poolId: "string",
    lbMembersId: "string",
    members: [{
        address: "string",
        protocolPort: 0,
        adminStateUp: false,
        backup: false,
        id: "string",
        name: "string",
        subnetId: "string",
        weight: 0,
    }],
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: vkcs:LbMembers
properties:
    lbMembersId: string
    members:
        - address: string
          adminStateUp: false
          backup: false
          id: string
          name: string
          protocolPort: 0
          subnetId: string
          weight: 0
    poolId: string
    region: string
    timeouts:
        create: string
        delete: string
        update: string
Copy

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

PoolId This property is required. string
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
LbMembersId string
string → The unique ID for the member.
Members List<LbMembersMember>
optional → A set of dictionaries containing member parameters. The structure is described below.
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 members resource.
Timeouts LbMembersTimeouts
PoolId This property is required. string
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
LbMembersId string
string → The unique ID for the member.
Members []LbMembersMemberArgs
optional → A set of dictionaries containing member parameters. The structure is described below.
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 members resource.
Timeouts LbMembersTimeoutsArgs
poolId This property is required. String
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
lbMembersId String
string → The unique ID for the member.
members List<LbMembersMember>
optional → A set of dictionaries containing member parameters. The structure is described below.
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 members resource.
timeouts LbMembersTimeouts
poolId This property is required. string
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
lbMembersId string
string → The unique ID for the member.
members LbMembersMember[]
optional → A set of dictionaries containing member parameters. The structure is described below.
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 members resource.
timeouts LbMembersTimeouts
pool_id This property is required. str
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
lb_members_id str
string → The unique ID for the member.
members Sequence[LbMembersMemberArgs]
optional → A set of dictionaries containing member parameters. The structure is described below.
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 members resource.
timeouts LbMembersTimeoutsArgs
poolId This property is required. String
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
lbMembersId String
string → The unique ID for the member.
members List<Property Map>
optional → A set of dictionaries containing member parameters. The structure is described below.
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 members resource.
timeouts Property Map

Outputs

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

Get an existing LbMembers 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?: LbMembersState, opts?: CustomResourceOptions): LbMembers
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        lb_members_id: Optional[str] = None,
        members: Optional[Sequence[LbMembersMemberArgs]] = None,
        pool_id: Optional[str] = None,
        region: Optional[str] = None,
        timeouts: Optional[LbMembersTimeoutsArgs] = None) -> LbMembers
func GetLbMembers(ctx *Context, name string, id IDInput, state *LbMembersState, opts ...ResourceOption) (*LbMembers, error)
public static LbMembers Get(string name, Input<string> id, LbMembersState? state, CustomResourceOptions? opts = null)
public static LbMembers get(String name, Output<String> id, LbMembersState state, CustomResourceOptions options)
resources:  _:    type: vkcs:LbMembers    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:
LbMembersId string
string → The unique ID for the member.
Members List<LbMembersMember>
optional → A set of dictionaries containing member parameters. The structure is described below.
PoolId string
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
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 members resource.
Timeouts LbMembersTimeouts
LbMembersId string
string → The unique ID for the member.
Members []LbMembersMemberArgs
optional → A set of dictionaries containing member parameters. The structure is described below.
PoolId string
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
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 members resource.
Timeouts LbMembersTimeoutsArgs
lbMembersId String
string → The unique ID for the member.
members List<LbMembersMember>
optional → A set of dictionaries containing member parameters. The structure is described below.
poolId String
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
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 members resource.
timeouts LbMembersTimeouts
lbMembersId string
string → The unique ID for the member.
members LbMembersMember[]
optional → A set of dictionaries containing member parameters. The structure is described below.
poolId string
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
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 members resource.
timeouts LbMembersTimeouts
lb_members_id str
string → The unique ID for the member.
members Sequence[LbMembersMemberArgs]
optional → A set of dictionaries containing member parameters. The structure is described below.
pool_id str
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
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 members resource.
timeouts LbMembersTimeoutsArgs
lbMembersId String
string → The unique ID for the member.
members List<Property Map>
optional → A set of dictionaries containing member parameters. The structure is described below.
poolId String
required string → The id of the pool that members will be assigned to. Changing this creates a new members resource.
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 members resource.
timeouts Property Map

Supporting Types

LbMembersMember
, LbMembersMemberArgs

Address This property is required. string
required string → The IP address of the members to receive traffic from the load balancer.
ProtocolPort This property is required. double
required number → The port on which to listen for client traffic.
AdminStateUp bool
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
Backup bool
optional boolean → A bool that indicates whether the member is backup.
Id string
string → The unique ID for the member.
Name string
optional string → Human-readable name for the member.
SubnetId string
optional string → The subnet in which to access the member.
Weight double
optional number → A positive integer value that indicates the relative portion of traffic that this members 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 members to receive traffic from the load balancer.
ProtocolPort This property is required. float64
required number → The port on which to listen for client traffic.
AdminStateUp bool
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
Backup bool
optional boolean → A bool that indicates whether the member is backup.
Id string
string → The unique ID for the member.
Name string
optional string → Human-readable name for the member.
SubnetId string
optional string → The subnet in which to access the member.
Weight float64
optional number → A positive integer value that indicates the relative portion of traffic that this members 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 members to receive traffic from the load balancer.
protocolPort This property is required. Double
required number → The port on which to listen for client traffic.
adminStateUp Boolean
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
backup Boolean
optional boolean → A bool that indicates whether the member is backup.
id String
string → The unique ID for the member.
name String
optional string → Human-readable name for the member.
subnetId String
optional string → The subnet in which to access the member.
weight Double
optional number → A positive integer value that indicates the relative portion of traffic that this members 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 members to receive traffic from the load balancer.
protocolPort This property is required. number
required number → The port on which to listen for client traffic.
adminStateUp boolean
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
backup boolean
optional boolean → A bool that indicates whether the member is backup.
id string
string → The unique ID for the member.
name string
optional string → Human-readable name for the member.
subnetId string
optional string → The subnet in which to access the member.
weight number
optional number → A positive integer value that indicates the relative portion of traffic that this members 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 members to receive traffic from the load balancer.
protocol_port This property is required. float
required number → The port on which to listen for client traffic.
admin_state_up bool
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
backup bool
optional boolean → A bool that indicates whether the member is backup.
id str
string → The unique ID for the member.
name str
optional string → Human-readable name for the member.
subnet_id str
optional string → The subnet in which to access the member.
weight float
optional number → A positive integer value that indicates the relative portion of traffic that this members 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 members to receive traffic from the load balancer.
protocolPort This property is required. Number
required number → The port on which to listen for client traffic.
adminStateUp Boolean
optional boolean → The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
backup Boolean
optional boolean → A bool that indicates whether the member is backup.
id String
string → The unique ID for the member.
name String
optional string → Human-readable name for the member.
subnetId String
optional string → The subnet in which to access the member.
weight Number
optional number → A positive integer value that indicates the relative portion of traffic that this members 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.

LbMembersTimeouts
, LbMembersTimeoutsArgs

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 Members can be imported using the Pool ID, e.g.:

$ pulumi import vkcs:index/lbMembers:LbMembers members_1 c22974d2-4c95-4bcb-9819-0afc5ed303d5
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.