@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
206 lines (205 loc) • 7.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* `f5bigip.ltm.Node` Manages a node configuration
*
* For resources should be named with their `full path`.The full path is the combination of the `partition + name` of the resource( example: `/Common/my-node` ) or `partition + Direcroty + name` of the resource ( example: `/Common/test/my-node` ).
* When including directory in `full path` we have to make sure it is created in the given partition before using it.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as f5bigip from "@pulumi/f5bigip";
*
* const node = new f5bigip.ltm.Node("node", {
* name: "/Common/terraform_node1",
* address: "192.168.30.1",
* connectionLimit: 0,
* dynamicRatio: 1,
* monitor: "/Common/icmp",
* description: "Test-Node",
* rateLimit: "disabled",
* fqdn: {
* addressFamily: "ipv4",
* interval: "3000",
* },
* });
* ```
*
* ## Importing
*
* An existing Node can be imported into this resource by supplying Node Name in `full path` as `id`.
* An example is below:
* ```sh
* $ terraform import bigip_ltm_node.site2_node "/TEST/testnode"
* (or)
* $ terraform import bigip_ltm_node.site2_node "/Common/3.3.3.3"
*
* ```
*/
export declare class Node extends pulumi.CustomResource {
/**
* Get an existing Node 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?: NodeState, opts?: pulumi.CustomResourceOptions): Node;
/**
* Returns true if the given object is an instance of Node. 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 Node;
/**
* IP or hostname of the node
*/
readonly address: pulumi.Output<string>;
/**
* Specifies the maximum number of connections allowed for the node or node address.
*/
readonly connectionLimit: pulumi.Output<number>;
/**
* User-defined description give ltm_node
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Specifies the fixed ratio value used for a node during ratio load balancing.
*/
readonly dynamicRatio: pulumi.Output<number>;
readonly fqdn: pulumi.Output<outputs.ltm.NodeFqdn | undefined>;
/**
* specifies the name of the monitor or monitor rule that you want to associate with the node.
*/
readonly monitor: pulumi.Output<string | undefined>;
/**
* Name of the node
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
*/
readonly rateLimit: pulumi.Output<string>;
/**
* Sets the ratio number for the node.
*/
readonly ratio: pulumi.Output<number>;
/**
* Enables or disables the node for new sessions. The default value is user-enabled.
*/
readonly session: pulumi.Output<string>;
/**
* Default is "user-up" you can set to "user-down" if you want to disable
*
* > *NOTE* Below attributes needs to be configured under fqdn option.
*/
readonly state: pulumi.Output<string>;
/**
* Create a Node 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: NodeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Node resources.
*/
export interface NodeState {
/**
* IP or hostname of the node
*/
address?: pulumi.Input<string>;
/**
* Specifies the maximum number of connections allowed for the node or node address.
*/
connectionLimit?: pulumi.Input<number>;
/**
* User-defined description give ltm_node
*/
description?: pulumi.Input<string>;
/**
* Specifies the fixed ratio value used for a node during ratio load balancing.
*/
dynamicRatio?: pulumi.Input<number>;
fqdn?: pulumi.Input<inputs.ltm.NodeFqdn>;
/**
* specifies the name of the monitor or monitor rule that you want to associate with the node.
*/
monitor?: pulumi.Input<string>;
/**
* Name of the node
*/
name?: pulumi.Input<string>;
/**
* Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
*/
rateLimit?: pulumi.Input<string>;
/**
* Sets the ratio number for the node.
*/
ratio?: pulumi.Input<number>;
/**
* Enables or disables the node for new sessions. The default value is user-enabled.
*/
session?: pulumi.Input<string>;
/**
* Default is "user-up" you can set to "user-down" if you want to disable
*
* > *NOTE* Below attributes needs to be configured under fqdn option.
*/
state?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Node resource.
*/
export interface NodeArgs {
/**
* IP or hostname of the node
*/
address: pulumi.Input<string>;
/**
* Specifies the maximum number of connections allowed for the node or node address.
*/
connectionLimit?: pulumi.Input<number>;
/**
* User-defined description give ltm_node
*/
description?: pulumi.Input<string>;
/**
* Specifies the fixed ratio value used for a node during ratio load balancing.
*/
dynamicRatio?: pulumi.Input<number>;
fqdn?: pulumi.Input<inputs.ltm.NodeFqdn>;
/**
* specifies the name of the monitor or monitor rule that you want to associate with the node.
*/
monitor?: pulumi.Input<string>;
/**
* Name of the node
*/
name: pulumi.Input<string>;
/**
* Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
*/
rateLimit?: pulumi.Input<string>;
/**
* Sets the ratio number for the node.
*/
ratio?: pulumi.Input<number>;
/**
* Enables or disables the node for new sessions. The default value is user-enabled.
*/
session?: pulumi.Input<string>;
/**
* Default is "user-up" you can set to "user-down" if you want to disable
*
* > *NOTE* Below attributes needs to be configured under fqdn option.
*/
state?: pulumi.Input<string>;
}