@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
190 lines (189 loc) • 9.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* `f5bigip.ltm.Pool` Manages F5 BIG-IP LTM pools via iControl REST API.
*
* For resources should be named with their `full path`. The full path is the combination of the `partition + name` of the resource or `partition + directory + name`.
* For example `/Common/my-pool`.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as f5bigip from "@pulumi/f5bigip";
*
* const monitor = new f5bigip.ltm.Monitor("monitor", {
* name: "/Common/terraform_monitor",
* parent: "/Common/http",
* });
* const pool = new f5bigip.ltm.Pool("pool", {
* name: "/Common/Axiom_Environment_APP1_Pool",
* loadBalancingMode: "round-robin",
* minimumActiveMembers: 1,
* monitors: [monitor.name],
* });
* ```
*
* ## Importing
*
* An existing pool can be imported into this resource by supplying pool Name in `full path` as `id`.
* An example is below:
* ```sh
* $ terraform import bigip_ltm_pool.k8s_prod_import /Common/k8prod_Pool
*
* ```
*/
export declare class Pool extends pulumi.CustomResource {
/**
* Get an existing Pool 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?: PoolState, opts?: pulumi.CustomResourceOptions): Pool;
/**
* Returns true if the given object is an instance of Pool. 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 Pool;
/**
* Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : `yes`, Possible Values `yes` or `no`].
*/
readonly allowNat: pulumi.Output<string>;
/**
* Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : `yes`, Possible Values `yes` or `no`].
*/
readonly allowSnat: pulumi.Output<string>;
/**
* Specifies descriptive text that identifies the pool.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Specifies the load balancing method. The default is `round-robin`. Possible options: [`dynamic-ratio-member`,`dynamic-ratio-node`, `fastest-app-response`,`fastest-node`, `least-connections-members`,`least-connections-node`,`least-sessions`,`observed-member`,`observed-node`,`predictive-member`,`predictive-node`,`ratio-least-connections-member`,`ratio-least-connections-node`,`ratio-member`,`ratio-node`,`ratio-session`,`round-robin`,`weighted-least-connections-member`,`weighted-least-connections-node`]
*/
readonly loadBalancingMode: pulumi.Output<string>;
/**
* Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is `0` meaning `disabled`.
*/
readonly minimumActiveMembers: pulumi.Output<number>;
/**
* List of monitor names to associate with the pool
*/
readonly monitors: pulumi.Output<string[]>;
/**
* Name of the pool,it should be `full path`.The full path is the combination of the `partition + name` of the pool.(For example `/Common/my-pool`)
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the number of times the system tries to contact a new pool member after a passive failure.
*/
readonly reselectTries: pulumi.Output<number>;
/**
* Specifies how the system should respond when the target pool member becomes unavailable. The default is `None`, Possible values: `[none, reset, reselect, drop]`.
*/
readonly serviceDownAction: pulumi.Output<string>;
/**
* Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
*/
readonly slowRampTime: pulumi.Output<number>;
/**
* Create a Pool 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: PoolArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Pool resources.
*/
export interface PoolState {
/**
* Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : `yes`, Possible Values `yes` or `no`].
*/
allowNat?: pulumi.Input<string>;
/**
* Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : `yes`, Possible Values `yes` or `no`].
*/
allowSnat?: pulumi.Input<string>;
/**
* Specifies descriptive text that identifies the pool.
*/
description?: pulumi.Input<string>;
/**
* Specifies the load balancing method. The default is `round-robin`. Possible options: [`dynamic-ratio-member`,`dynamic-ratio-node`, `fastest-app-response`,`fastest-node`, `least-connections-members`,`least-connections-node`,`least-sessions`,`observed-member`,`observed-node`,`predictive-member`,`predictive-node`,`ratio-least-connections-member`,`ratio-least-connections-node`,`ratio-member`,`ratio-node`,`ratio-session`,`round-robin`,`weighted-least-connections-member`,`weighted-least-connections-node`]
*/
loadBalancingMode?: pulumi.Input<string>;
/**
* Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is `0` meaning `disabled`.
*/
minimumActiveMembers?: pulumi.Input<number>;
/**
* List of monitor names to associate with the pool
*/
monitors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the pool,it should be `full path`.The full path is the combination of the `partition + name` of the pool.(For example `/Common/my-pool`)
*/
name?: pulumi.Input<string>;
/**
* Specifies the number of times the system tries to contact a new pool member after a passive failure.
*/
reselectTries?: pulumi.Input<number>;
/**
* Specifies how the system should respond when the target pool member becomes unavailable. The default is `None`, Possible values: `[none, reset, reselect, drop]`.
*/
serviceDownAction?: pulumi.Input<string>;
/**
* Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
*/
slowRampTime?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Pool resource.
*/
export interface PoolArgs {
/**
* Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : `yes`, Possible Values `yes` or `no`].
*/
allowNat?: pulumi.Input<string>;
/**
* Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : `yes`, Possible Values `yes` or `no`].
*/
allowSnat?: pulumi.Input<string>;
/**
* Specifies descriptive text that identifies the pool.
*/
description?: pulumi.Input<string>;
/**
* Specifies the load balancing method. The default is `round-robin`. Possible options: [`dynamic-ratio-member`,`dynamic-ratio-node`, `fastest-app-response`,`fastest-node`, `least-connections-members`,`least-connections-node`,`least-sessions`,`observed-member`,`observed-node`,`predictive-member`,`predictive-node`,`ratio-least-connections-member`,`ratio-least-connections-node`,`ratio-member`,`ratio-node`,`ratio-session`,`round-robin`,`weighted-least-connections-member`,`weighted-least-connections-node`]
*/
loadBalancingMode?: pulumi.Input<string>;
/**
* Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is `0` meaning `disabled`.
*/
minimumActiveMembers?: pulumi.Input<number>;
/**
* List of monitor names to associate with the pool
*/
monitors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the pool,it should be `full path`.The full path is the combination of the `partition + name` of the pool.(For example `/Common/my-pool`)
*/
name: pulumi.Input<string>;
/**
* Specifies the number of times the system tries to contact a new pool member after a passive failure.
*/
reselectTries?: pulumi.Input<number>;
/**
* Specifies how the system should respond when the target pool member becomes unavailable. The default is `None`, Possible values: `[none, reset, reselect, drop]`.
*/
serviceDownAction?: pulumi.Input<string>;
/**
* Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
*/
slowRampTime?: pulumi.Input<number>;
}