Member

Manages a V2 member resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var member1 = new OpenStack.LoadBalancer.Member("member1", new OpenStack.LoadBalancer.MemberArgs
        {
            Address = "192.168.199.23",
            PoolId = "935685fb-a896-40f9-9ff4-ae531a3a00fe",
            ProtocolPort = 8080,
        });
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

member1 = openstack.loadbalancer.Member("member1",
    address="192.168.199.23",
    pool_id="935685fb-a896-40f9-9ff4-ae531a3a00fe",
    protocol_port=8080)
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const member1 = new openstack.loadbalancer.Member("member_1", {
    address: "192.168.199.23",
    poolId: "935685fb-a896-40f9-9ff4-ae531a3a00fe",
    protocolPort: 8080,
});

Create a Member Resource

new Member(name: string, args: MemberArgs, opts?: CustomResourceOptions);
def Member(resource_name, opts=None, address=None, admin_state_up=None, name=None, pool_id=None, protocol_port=None, region=None, subnet_id=None, tenant_id=None, weight=None, __props__=None);
func NewMember(ctx *Context, name string, args MemberArgs, opts ...ResourceOption) (*Member, error)
public Member(string name, MemberArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args MemberArgs
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 MemberArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MemberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Member Resource Properties

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

Inputs

The Member resource accepts the following input properties:

Address string

The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.

PoolId string

The id of the pool that this member will be assigned to. Changing this creates a new member.

ProtocolPort int

The port on which to listen for client traffic. Changing this creates a new member.

AdminStateUp bool

The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.

Name string

Human-readable name for the member.

Region string

The region in which to obtain the V2 Networking client. A Networking client is needed to create a member. If omitted, the region argument of the provider is used. Changing this creates a new member.

SubnetId string

The subnet in which to access the member. Changing this creates a new member.

TenantId string

Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.

Weight int

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

The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.

PoolId string

The id of the pool that this member will be assigned to. Changing this creates a new member.

ProtocolPort int

The port on which to listen for client traffic. Changing this creates a new member.

AdminStateUp bool

The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.

Name string

Human-readable name for the member.

Region string

The region in which to obtain the V2 Networking client. A Networking client is needed to create a member. If omitted, the region argument of the provider is used. Changing this creates a new member.

SubnetId string

The subnet in which to access the member. Changing this creates a new member.

TenantId string

Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.

Weight int

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

The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.

poolId string

The id of the pool that this member will be assigned to. Changing this creates a new member.

protocolPort number

The port on which to listen for client traffic. Changing this creates a new member.

adminStateUp boolean

The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.

name string

Human-readable name for the member.

region string

The region in which to obtain the V2 Networking client. A Networking client is needed to create a member. If omitted, the region argument of the provider is used. Changing this creates a new member.

subnetId string

The subnet in which to access the member. Changing this creates a new member.

tenantId string

Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.

weight 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

The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.

pool_id str

The id of the pool that this member will be assigned to. Changing this creates a new member.

protocol_port float

The port on which to listen for client traffic. Changing this creates a new member.

admin_state_up bool

The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.

name str

Human-readable name for the member.

region str

The region in which to obtain the V2 Networking client. A Networking client is needed to create a member. If omitted, the region argument of the provider is used. Changing this creates a new member.

subnet_id str

The subnet in which to access the member. Changing this creates a new member.

tenant_id str

Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.

weight float

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 Member 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 Member Resource

Get an existing Member 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?: MemberState, opts?: CustomResourceOptions): Member
static get(resource_name, id, opts=None, address=None, admin_state_up=None, name=None, pool_id=None, protocol_port=None, region=None, subnet_id=None, tenant_id=None, weight=None, __props__=None);
func GetMember(ctx *Context, name string, id IDInput, state *MemberState, opts ...ResourceOption) (*Member, error)
public static Member Get(string name, Input<string> id, MemberState? 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:

Address string

The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.

AdminStateUp bool

The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.

Name string

Human-readable name for the member.

PoolId string

The id of the pool that this member will be assigned to. Changing this creates a new member.

ProtocolPort int

The port on which to listen for client traffic. Changing this creates a new member.

Region string

The region in which to obtain the V2 Networking client. A Networking client is needed to create a member. If omitted, the region argument of the provider is used. Changing this creates a new member.

SubnetId string

The subnet in which to access the member. Changing this creates a new member.

TenantId string

Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.

Weight int

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

The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.

AdminStateUp bool

The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.

Name string

Human-readable name for the member.

PoolId string

The id of the pool that this member will be assigned to. Changing this creates a new member.

ProtocolPort int

The port on which to listen for client traffic. Changing this creates a new member.

Region string

The region in which to obtain the V2 Networking client. A Networking client is needed to create a member. If omitted, the region argument of the provider is used. Changing this creates a new member.

SubnetId string

The subnet in which to access the member. Changing this creates a new member.

TenantId string

Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.

Weight int

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

The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.

adminStateUp boolean

The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.

name string

Human-readable name for the member.

poolId string

The id of the pool that this member will be assigned to. Changing this creates a new member.

protocolPort number

The port on which to listen for client traffic. Changing this creates a new member.

region string

The region in which to obtain the V2 Networking client. A Networking client is needed to create a member. If omitted, the region argument of the provider is used. Changing this creates a new member.

subnetId string

The subnet in which to access the member. Changing this creates a new member.

tenantId string

Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.

weight 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

The IP address of the member to receive traffic from the load balancer. Changing this creates a new member.

admin_state_up bool

The administrative state of the member. A valid value is true (UP) or false (DOWN). Defaults to true.

name str

Human-readable name for the member.

pool_id str

The id of the pool that this member will be assigned to. Changing this creates a new member.

protocol_port float

The port on which to listen for client traffic. Changing this creates a new member.

region str

The region in which to obtain the V2 Networking client. A Networking client is needed to create a member. If omitted, the region argument of the provider is used. Changing this creates a new member.

subnet_id str

The subnet in which to access the member. Changing this creates a new member.

tenant_id str

Required for admins. The UUID of the tenant who owns the member. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new member.

weight float

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.

Package Details

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