@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
135 lines (134 loc) • 6.22 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a Linode NodeBalancer Node resource. This can be used to create, modify, and delete Linodes NodeBalancer Nodes.
* For more information, see [Getting Started with NodeBalancers](https://www.linode.com/docs/platform/nodebalancer/getting-started-with-nodebalancers/) and the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/post-node-balancer-node).
*
* ## Import
*
* NodeBalancer Nodes can be imported using the NodeBalancer `nodebalancer_id` followed by the NodeBalancer Config `config_id` followed by the NodeBalancer Node `id`, separated by a comma, e.g.
*
* ```sh
* $ pulumi import linode:index/nodeBalancerNode:NodeBalancerNode https-foobar-1 1234567,7654321,9999999
* ```
*/
export declare class NodeBalancerNode extends pulumi.CustomResource {
/**
* Get an existing NodeBalancerNode 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?: NodeBalancerNodeState, opts?: pulumi.CustomResourceOptions): NodeBalancerNode;
/**
* Returns true if the given object is an instance of NodeBalancerNode. 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 NodeBalancerNode;
/**
* The private IP Address where this backend can be reached. This must be a private IP address.
*
* - - -
*/
readonly address: pulumi.Output<string>;
/**
* The ID of the NodeBalancerConfig to access.
*/
readonly configId: pulumi.Output<number>;
/**
* The label of the Linode NodeBalancer Node. This is for display purposes only.
*/
readonly label: pulumi.Output<string>;
/**
* The mode this NodeBalancer should use when sending traffic to this backend. If set to `accept` this backend is accepting traffic. If set to `reject` this backend will not receive traffic. If set to `drain` this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (`accept`, `reject`, `drain`, `backup`)
*/
readonly mode: pulumi.Output<string>;
/**
* The ID of the NodeBalancer to access.
*/
readonly nodebalancerId: pulumi.Output<number>;
/**
* The current status of this node, based on the configured checks of its NodeBalancer Config. (`unknown`, `UP`, `DOWN`).
*/
readonly status: pulumi.Output<string>;
/**
* Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
*/
readonly weight: pulumi.Output<number>;
/**
* Create a NodeBalancerNode 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: NodeBalancerNodeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NodeBalancerNode resources.
*/
export interface NodeBalancerNodeState {
/**
* The private IP Address where this backend can be reached. This must be a private IP address.
*
* - - -
*/
address?: pulumi.Input<string>;
/**
* The ID of the NodeBalancerConfig to access.
*/
configId?: pulumi.Input<number>;
/**
* The label of the Linode NodeBalancer Node. This is for display purposes only.
*/
label?: pulumi.Input<string>;
/**
* The mode this NodeBalancer should use when sending traffic to this backend. If set to `accept` this backend is accepting traffic. If set to `reject` this backend will not receive traffic. If set to `drain` this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (`accept`, `reject`, `drain`, `backup`)
*/
mode?: pulumi.Input<string>;
/**
* The ID of the NodeBalancer to access.
*/
nodebalancerId?: pulumi.Input<number>;
/**
* The current status of this node, based on the configured checks of its NodeBalancer Config. (`unknown`, `UP`, `DOWN`).
*/
status?: pulumi.Input<string>;
/**
* Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
*/
weight?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a NodeBalancerNode resource.
*/
export interface NodeBalancerNodeArgs {
/**
* The private IP Address where this backend can be reached. This must be a private IP address.
*
* - - -
*/
address: pulumi.Input<string>;
/**
* The ID of the NodeBalancerConfig to access.
*/
configId: pulumi.Input<number>;
/**
* The label of the Linode NodeBalancer Node. This is for display purposes only.
*/
label: pulumi.Input<string>;
/**
* The mode this NodeBalancer should use when sending traffic to this backend. If set to `accept` this backend is accepting traffic. If set to `reject` this backend will not receive traffic. If set to `drain` this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. (`accept`, `reject`, `drain`, `backup`)
*/
mode?: pulumi.Input<string>;
/**
* The ID of the NodeBalancer to access.
*/
nodebalancerId: pulumi.Input<number>;
/**
* Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).
*/
weight?: pulumi.Input<number>;
}