@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
266 lines (265 loc) • 9.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a V2 member resource within OpenStack.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const member1 = new openstack.loadbalancer.Member("member_1", {
* poolId: "935685fb-a896-40f9-9ff4-ae531a3a00fe",
* address: "192.168.199.23",
* protocolPort: 8080,
* });
* ```
*
* ## Import
*
* Load Balancer Pool Member can be imported using the Pool ID and Member ID
* separated by a slash, e.g.:
*
* ```sh
* $ pulumi import openstack:loadbalancer/member:Member member_1 c22974d2-4c95-4bcb-9819-0afc5ed303d5/9563b79c-8460-47da-8a95-2711b746510f
* ```
*/
export declare class Member extends pulumi.CustomResource {
/**
* Get an existing Member resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MemberState, opts?: pulumi.CustomResourceOptions): Member;
/**
* Returns true if the given object is an instance of Member. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Member;
/**
* The IP address of the member to receive traffic from
* the load balancer. Changing this creates a new member.
*/
readonly address: pulumi.Output<string>;
/**
* The administrative state of the member.
* A valid value is true (UP) or false (DOWN). Defaults to true.
*/
readonly adminStateUp: pulumi.Output<boolean | undefined>;
/**
* Boolean that indicates whether that member works as a backup or not. Available
* only for Octavia >= 2.1.
*/
readonly backup: pulumi.Output<boolean | undefined>;
/**
* An alternate IP address used for health monitoring a backend member.
* Available only for Octavia
*/
readonly monitorAddress: pulumi.Output<string | undefined>;
/**
* An alternate protocol port used for health monitoring a backend member.
* Available only for Octavia
*/
readonly monitorPort: pulumi.Output<number | undefined>;
/**
* Human-readable name for the member.
*/
readonly name: pulumi.Output<string>;
/**
* The id of the pool that this member will be assigned
* to. Changing this creates a new member.
*/
readonly poolId: pulumi.Output<string>;
/**
* The port on which to listen for client traffic.
* Changing this creates a new member.
*/
readonly protocolPort: pulumi.Output<number>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* The subnet in which to access the member. Changing
* this creates a new member.
*/
readonly subnetId: pulumi.Output<string | undefined>;
/**
* A list of simple strings assigned to the member.
* Available only for Octavia >= 2.5.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* 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.
*/
readonly tenantId: pulumi.Output<string>;
/**
* 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.
*/
readonly weight: pulumi.Output<number>;
/**
* Create a Member resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MemberArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Member resources.
*/
export interface MemberState {
/**
* The IP address of the member to receive traffic from
* the load balancer. Changing this creates a new member.
*/
address?: pulumi.Input<string>;
/**
* The administrative state of the member.
* A valid value is true (UP) or false (DOWN). Defaults to true.
*/
adminStateUp?: pulumi.Input<boolean>;
/**
* Boolean that indicates whether that member works as a backup or not. Available
* only for Octavia >= 2.1.
*/
backup?: pulumi.Input<boolean>;
/**
* An alternate IP address used for health monitoring a backend member.
* Available only for Octavia
*/
monitorAddress?: pulumi.Input<string>;
/**
* An alternate protocol port used for health monitoring a backend member.
* Available only for Octavia
*/
monitorPort?: pulumi.Input<number>;
/**
* Human-readable name for the member.
*/
name?: pulumi.Input<string>;
/**
* The id of the pool that this member will be assigned
* to. Changing this creates a new member.
*/
poolId?: pulumi.Input<string>;
/**
* The port on which to listen for client traffic.
* Changing this creates a new member.
*/
protocolPort?: pulumi.Input<number>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* The subnet in which to access the member. Changing
* this creates a new member.
*/
subnetId?: pulumi.Input<string>;
/**
* A list of simple strings assigned to the member.
* Available only for Octavia >= 2.5.
*/
tags?: pulumi.Input<pulumi.Input<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.
*/
tenantId?: pulumi.Input<string>;
/**
* 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.
*/
weight?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Member resource.
*/
export interface MemberArgs {
/**
* The IP address of the member to receive traffic from
* the load balancer. Changing this creates a new member.
*/
address: pulumi.Input<string>;
/**
* The administrative state of the member.
* A valid value is true (UP) or false (DOWN). Defaults to true.
*/
adminStateUp?: pulumi.Input<boolean>;
/**
* Boolean that indicates whether that member works as a backup or not. Available
* only for Octavia >= 2.1.
*/
backup?: pulumi.Input<boolean>;
/**
* An alternate IP address used for health monitoring a backend member.
* Available only for Octavia
*/
monitorAddress?: pulumi.Input<string>;
/**
* An alternate protocol port used for health monitoring a backend member.
* Available only for Octavia
*/
monitorPort?: pulumi.Input<number>;
/**
* Human-readable name for the member.
*/
name?: pulumi.Input<string>;
/**
* The id of the pool that this member will be assigned
* to. Changing this creates a new member.
*/
poolId: pulumi.Input<string>;
/**
* The port on which to listen for client traffic.
* Changing this creates a new member.
*/
protocolPort: pulumi.Input<number>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* The subnet in which to access the member. Changing
* this creates a new member.
*/
subnetId?: pulumi.Input<string>;
/**
* A list of simple strings assigned to the member.
* Available only for Octavia >= 2.5.
*/
tags?: pulumi.Input<pulumi.Input<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.
*/
tenantId?: pulumi.Input<string>;
/**
* 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.
*/
weight?: pulumi.Input<number>;
}