@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
189 lines (188 loc) • 7.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides a Linode NodeBalancer resource. This can be used to create, modify, and delete Linodes NodeBalancers in Linode's managed load balancer service.
* 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).
*
* ## Example Usage
*
* The following example shows how one might use this resource to configure a NodeBalancer.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const foobar = new linode.NodeBalancer("foobar", {
* label: "mynodebalancer",
* region: "us-east",
* clientConnThrottle: 20,
* tags: ["foobar"],
* });
* ```
*
* ## Import
*
* Linodes NodeBalancers can be imported using the Linode NodeBalancer `id`, e.g.
*
* ```sh
* $ pulumi import linode:index/nodeBalancer:NodeBalancer mynodebalancer 1234567
* ```
*/
export declare class NodeBalancer extends pulumi.CustomResource {
/**
* Get an existing NodeBalancer 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?: NodeBalancerState, opts?: pulumi.CustomResourceOptions): NodeBalancer;
/**
* Returns true if the given object is an instance of NodeBalancer. 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 NodeBalancer;
/**
* Throttle connections per second (0-20). Set to 0 (default) to disable throttling.
*/
readonly clientConnThrottle: pulumi.Output<number>;
/**
* When this firewall was created.
*/
readonly created: pulumi.Output<string>;
/**
* ID for the firewall you'd like to use with this NodeBalancer.
*/
readonly firewallId: pulumi.Output<number | undefined>;
/**
* A list of Firewalls assigned to this NodeBalancer.
*/
readonly firewalls: pulumi.Output<outputs.NodeBalancerFirewall[]>;
/**
* This NodeBalancer's hostname, ending with .nodebalancer.linode.com
*/
readonly hostname: pulumi.Output<string>;
/**
* A list of IPv4 addresses or networks. Must be in IP/mask format.
*/
readonly ipv4: pulumi.Output<string>;
/**
* A list of IPv6 addresses or networks. Must be in IP/mask format.
*/
readonly ipv6: pulumi.Output<string>;
/**
* The label of the Linode NodeBalancer
*/
readonly label: pulumi.Output<string | undefined>;
/**
* The region where this NodeBalancer will be deployed. Examples are `"us-east"`, `"us-west"`, `"ap-south"`, etc. See all regions [here](https://api.linode.com/v4/regions). *Changing `region` forces the creation of a new Linode NodeBalancer.*.
*
* - - -
*/
readonly region: pulumi.Output<string>;
/**
* A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
*/
readonly tags: pulumi.Output<string[]>;
/**
* Information about the amount of transfer this NodeBalancer has had so far this month.
*/
readonly transfers: pulumi.Output<outputs.NodeBalancerTransfer[]>;
/**
* When this firewall was last updated.
*/
readonly updated: pulumi.Output<string>;
/**
* Create a NodeBalancer 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?: NodeBalancerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NodeBalancer resources.
*/
export interface NodeBalancerState {
/**
* Throttle connections per second (0-20). Set to 0 (default) to disable throttling.
*/
clientConnThrottle?: pulumi.Input<number>;
/**
* When this firewall was created.
*/
created?: pulumi.Input<string>;
/**
* ID for the firewall you'd like to use with this NodeBalancer.
*/
firewallId?: pulumi.Input<number>;
/**
* A list of Firewalls assigned to this NodeBalancer.
*/
firewalls?: pulumi.Input<pulumi.Input<inputs.NodeBalancerFirewall>[]>;
/**
* This NodeBalancer's hostname, ending with .nodebalancer.linode.com
*/
hostname?: pulumi.Input<string>;
/**
* A list of IPv4 addresses or networks. Must be in IP/mask format.
*/
ipv4?: pulumi.Input<string>;
/**
* A list of IPv6 addresses or networks. Must be in IP/mask format.
*/
ipv6?: pulumi.Input<string>;
/**
* The label of the Linode NodeBalancer
*/
label?: pulumi.Input<string>;
/**
* The region where this NodeBalancer will be deployed. Examples are `"us-east"`, `"us-west"`, `"ap-south"`, etc. See all regions [here](https://api.linode.com/v4/regions). *Changing `region` forces the creation of a new Linode NodeBalancer.*.
*
* - - -
*/
region?: pulumi.Input<string>;
/**
* A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Information about the amount of transfer this NodeBalancer has had so far this month.
*/
transfers?: pulumi.Input<pulumi.Input<inputs.NodeBalancerTransfer>[]>;
/**
* When this firewall was last updated.
*/
updated?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NodeBalancer resource.
*/
export interface NodeBalancerArgs {
/**
* Throttle connections per second (0-20). Set to 0 (default) to disable throttling.
*/
clientConnThrottle?: pulumi.Input<number>;
/**
* ID for the firewall you'd like to use with this NodeBalancer.
*/
firewallId?: pulumi.Input<number>;
/**
* The label of the Linode NodeBalancer
*/
label?: pulumi.Input<string>;
/**
* The region where this NodeBalancer will be deployed. Examples are `"us-east"`, `"us-west"`, `"ap-south"`, etc. See all regions [here](https://api.linode.com/v4/regions). *Changing `region` forces the creation of a new Linode NodeBalancer.*.
*
* - - -
*/
region?: pulumi.Input<string>;
/**
* A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}