Members

Manages a V2 members resource within OpenStack (batch members update).

Note: This resource works only within Octavia API. For legacy Neutron LBaaS v2 extension please use openstack.loadbalancer.Member resource.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var members1 = new OpenStack.LoadBalancer.Members("members1", new OpenStack.LoadBalancer.MembersArgs
        {
            Members = 
            {
                new OpenStack.LoadBalancer.Inputs.MembersMemberArgs
                {
                    Address = "192.168.199.23",
                    ProtocolPort = 8080,
                },
                new OpenStack.LoadBalancer.Inputs.MembersMemberArgs
                {
                    Address = "192.168.199.24",
                    ProtocolPort = 8080,
                },
            },
            PoolId = "935685fb-a896-40f9-9ff4-ae531a3a00fe",
        });
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

members1 = openstack.loadbalancer.Members("members1",
    members=[
        {
            "address": "192.168.199.23",
            "protocol_port": 8080,
        },
        {
            "address": "192.168.199.24",
            "protocol_port": 8080,
        },
    ],
    pool_id="935685fb-a896-40f9-9ff4-ae531a3a00fe")

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

const members1 = new openstack.loadbalancer.Members("members_1", {
    members: [
        {
            address: "192.168.199.23",
            protocolPort: 8080,
        },
        {
            address: "192.168.199.24",
            protocolPort: 8080,
        },
    ],
    poolId: "935685fb-a896-40f9-9ff4-ae531a3a00fe",
});

Create a Members Resource

new Members(name: string, args: MembersArgs, opts?: CustomResourceOptions);

def Members(resource_name, opts=None, members=None, pool_id=None, region=None, __props__=None);

func NewMembers(ctx *Context, name string, args MembersArgs, opts ...ResourceOption) (*Members, error)

public Members(string name, MembersArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args MembersArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MembersArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MembersArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Members Resource Properties

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

Inputs

The Members resource accepts the following input properties:

PoolId string: The id of the pool that members will be assigned to. Changing this creates a new members resource.
MemberList List<Pulumi.OpenStack.LoadBalancer.Inputs.MembersMemberArgs>: A set of dictionaries containing member parameters. The structure is described below.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create pool members. If omitted, the region argument of the provider is used. Changing this creates a new members resource.

PoolId string: The id of the pool that members will be assigned to. Changing this creates a new members resource.
Members []MembersMember: A set of dictionaries containing member parameters. The structure is described below.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create pool members. If omitted, the region argument of the provider is used. Changing this creates a new members resource.

poolId string: The id of the pool that members will be assigned to. Changing this creates a new members resource.
members MembersMember[]: A set of dictionaries containing member parameters. The structure is described below.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create pool members. If omitted, the region argument of the provider is used. Changing this creates a new members resource.

pool_id str: The id of the pool that members will be assigned to. Changing this creates a new members resource.
members List[MembersMember]: A set of dictionaries containing member parameters. The structure is described below.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create pool members. If omitted, the region argument of the provider is used. Changing this creates a new members resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Members 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing Members Resource

Get an existing Members 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?: MembersState, opts?: CustomResourceOptions): Members

static get(resource_name, id, opts=None, members=None, pool_id=None, region=None, __props__=None);

func GetMembers(ctx *Context, name string, id IDInput, state *MembersState, opts ...ResourceOption) (*Members, error)

public static Members Get(string name, Input<string> id, MembersState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

MemberList List<Pulumi.OpenStack.LoadBalancer.Inputs.MembersMemberArgs>: A set of dictionaries containing member parameters. The structure is described below.
PoolId string: The id of the pool that members will be assigned to. Changing this creates a new members resource.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create pool members. If omitted, the region argument of the provider is used. Changing this creates a new members resource.

Members []MembersMember: A set of dictionaries containing member parameters. The structure is described below.
PoolId string: The id of the pool that members will be assigned to. Changing this creates a new members resource.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create pool members. If omitted, the region argument of the provider is used. Changing this creates a new members resource.

members MembersMember[]: A set of dictionaries containing member parameters. The structure is described below.
poolId string: The id of the pool that members will be assigned to. Changing this creates a new members resource.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create pool members. If omitted, the region argument of the provider is used. Changing this creates a new members resource.

members List[MembersMember]: A set of dictionaries containing member parameters. The structure is described below.
pool_id str: The id of the pool that members will be assigned to. Changing this creates a new members resource.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create pool members. If omitted, the region argument of the provider is used. Changing this creates a new members resource.

Supporting Types

MembersMember

See the input and output API doc for this type.

Address string: The IP address of the members to receive traffic from the load balancer.
ProtocolPort int: The port on which to listen for client traffic.
AdminStateUp bool: The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
Id string: The unique ID for the members.
Name string: Human-readable name for the member.
SubnetId string: The subnet in which to access the member.
Weight int: 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 string: The IP address of the members to receive traffic from the load balancer.
ProtocolPort int: The port on which to listen for client traffic.
AdminStateUp bool: The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
Id string: The unique ID for the members.
Name string: Human-readable name for the member.
SubnetId string: The subnet in which to access the member.
Weight int: 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 string: The IP address of the members to receive traffic from the load balancer.
protocolPort number: The port on which to listen for client traffic.
adminStateUp boolean: The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
id string: The unique ID for the members.
name string: Human-readable name for the member.
subnetId string: The subnet in which to access the member.
weight 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 str: The IP address of the members to receive traffic from the load balancer.
protocol_port float: The port on which to listen for client traffic.
admin_state_up bool: The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.
id str: The unique ID for the members.
name str: Human-readable name for the member.
subnet_id str: The subnet in which to access the member.
weight float: 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.

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud