@pulumi/hcloud/loadBalancer.d.ts

A Pulumi package for creating and managing hcloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Provides a Hetzner Cloud Load Balancer to represent a Load Balancer in the Hetzner Cloud.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as hcloud from "@pulumi/hcloud";
 *
 * const myServer = new hcloud.Server("my_server", {
 *     name: "server-%d",
 *     serverType: "cx23",
 *     image: "ubuntu-24.04",
 * });
 * const loadBalancer = new hcloud.LoadBalancer("load_balancer", {
 *     name: "my-load-balancer",
 *     loadBalancerType: "lb11",
 *     location: "nbg1",
 * });
 * const loadBalancerTarget = new hcloud.LoadBalancerTarget("load_balancer_target", {
 *     type: "server",
 *     loadBalancerId: loadBalancer.id.apply(x =>Number(x)),
 *     serverId: myServer.id.apply(x =>Number(x)),
 * });
 * ```
 *
 * ## Import
 *
 * Load Balancers can be imported using its `id`:
 *
 * ```sh
 * $ pulumi import hcloud:index/loadBalancer:LoadBalancer example "$LOAD_BALANCER_ID"
 * ```
 */
export declare class LoadBalancer extends pulumi.CustomResource {
    /**
     * Get an existing LoadBalancer 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?: LoadBalancerState, opts?: pulumi.CustomResourceOptions): LoadBalancer;
    /**
     * Returns true if the given object is an instance of LoadBalancer.  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 LoadBalancer;
    /**
     * Configuration of the algorithm the Load Balancer use.
     */
    readonly algorithm: pulumi.Output<outputs.LoadBalancerAlgorithm>;
    /**
     * Enable or disable delete protection. See "Delete Protection" in the Provider Docs for details.
     */
    readonly deleteProtection: pulumi.Output<boolean | undefined>;
    /**
     * (string) IPv4 Address of the Load Balancer.
     */
    readonly ipv4: pulumi.Output<string>;
    /**
     * (string) IPv6 Address of the Load Balancer.
     */
    readonly ipv6: pulumi.Output<string>;
    /**
     * User-defined labels (key-value pairs) should be created with.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * Type of the Load Balancer.
     */
    readonly loadBalancerType: pulumi.Output<string>;
    /**
     * The location name of the Load Balancer. Require when no networkZone is set. See the [Hetzner Docs](https://docs.hetzner.com/cloud/general/locations/#what-locations-are-there) for more details about locations.
     */
    readonly location: pulumi.Output<string>;
    /**
     * Name of the Load Balancer.
     */
    readonly name: pulumi.Output<string>;
    /**
     * (int) ID of the first private network that this Load Balancer is connected to.
     */
    readonly networkId: pulumi.Output<number>;
    /**
     * (string) IP of the Load Balancer in the first private network that it is connected to.
     */
    readonly networkIp: pulumi.Output<string>;
    /**
     * The Network Zone of the Load Balancer. Require when no location is set.
     */
    readonly networkZone: pulumi.Output<string>;
    /**
     * @deprecated Use hcloud.LoadBalancerTarget resource instead. This allows the full control over the selected targets.
     */
    readonly targets: pulumi.Output<outputs.LoadBalancerTarget[]>;
    /**
     * Create a LoadBalancer 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: LoadBalancerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering LoadBalancer resources.
 */
export interface LoadBalancerState {
    /**
     * Configuration of the algorithm the Load Balancer use.
     */
    algorithm?: pulumi.Input<inputs.LoadBalancerAlgorithm | undefined>;
    /**
     * Enable or disable delete protection. See "Delete Protection" in the Provider Docs for details.
     */
    deleteProtection?: pulumi.Input<boolean | undefined>;
    /**
     * (string) IPv4 Address of the Load Balancer.
     */
    ipv4?: pulumi.Input<string | undefined>;
    /**
     * (string) IPv6 Address of the Load Balancer.
     */
    ipv6?: pulumi.Input<string | undefined>;
    /**
     * User-defined labels (key-value pairs) should be created with.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Type of the Load Balancer.
     */
    loadBalancerType?: pulumi.Input<string | undefined>;
    /**
     * The location name of the Load Balancer. Require when no networkZone is set. See the [Hetzner Docs](https://docs.hetzner.com/cloud/general/locations/#what-locations-are-there) for more details about locations.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * Name of the Load Balancer.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * (int) ID of the first private network that this Load Balancer is connected to.
     */
    networkId?: pulumi.Input<number | undefined>;
    /**
     * (string) IP of the Load Balancer in the first private network that it is connected to.
     */
    networkIp?: pulumi.Input<string | undefined>;
    /**
     * The Network Zone of the Load Balancer. Require when no location is set.
     */
    networkZone?: pulumi.Input<string | undefined>;
    /**
     * @deprecated Use hcloud.LoadBalancerTarget resource instead. This allows the full control over the selected targets.
     */
    targets?: pulumi.Input<pulumi.Input<inputs.LoadBalancerTarget>[] | undefined>;
}
/**
 * The set of arguments for constructing a LoadBalancer resource.
 */
export interface LoadBalancerArgs {
    /**
     * Configuration of the algorithm the Load Balancer use.
     */
    algorithm?: pulumi.Input<inputs.LoadBalancerAlgorithm | undefined>;
    /**
     * Enable or disable delete protection. See "Delete Protection" in the Provider Docs for details.
     */
    deleteProtection?: pulumi.Input<boolean | undefined>;
    /**
     * User-defined labels (key-value pairs) should be created with.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Type of the Load Balancer.
     */
    loadBalancerType: pulumi.Input<string>;
    /**
     * The location name of the Load Balancer. Require when no networkZone is set. See the [Hetzner Docs](https://docs.hetzner.com/cloud/general/locations/#what-locations-are-there) for more details about locations.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * Name of the Load Balancer.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The Network Zone of the Load Balancer. Require when no location is set.
     */
    networkZone?: pulumi.Input<string | undefined>;
    /**
     * @deprecated Use hcloud.LoadBalancerTarget resource instead. This allows the full control over the selected targets.
     */
    targets?: pulumi.Input<pulumi.Input<inputs.LoadBalancerTarget>[] | undefined>;
}
//# sourceMappingURL=loadBalancer.d.ts.map