@pulumi/hcloud
Version:
A Pulumi package for creating and managing hcloud cloud resources.
169 lines • 6.25 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Define services for Hetzner Cloud Load Balancers.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as hcloud from "@pulumi/hcloud";
*
* const loadBalancer = new hcloud.LoadBalancer("load_balancer", {
* name: "my-load-balancer",
* loadBalancerType: "lb11",
* location: "nbg1",
* });
* const loadBalancerService = new hcloud.LoadBalancerService("load_balancer_service", {
* loadBalancerId: loadBalancer.id,
* protocol: "http",
* http: {
* stickySessions: true,
* cookieName: "EXAMPLE_STICKY",
* },
* healthCheck: {
* protocol: "http",
* port: 80,
* interval: 10,
* timeout: 5,
* http: {
* domain: "example.com",
* path: "/healthz",
* response: "OK",
* tls: true,
* statusCodes: ["200"],
* },
* },
* });
* ```
*
* ## Import
*
* Load Balancer Service entries can be imported using a compound ID with the following format:
* `<load-balancer-id>__<listen-port>`
*
* ```sh
* $ pulumi import hcloud:index/loadBalancerService:LoadBalancerService example "${LOAD_BALANCER_ID}__${LISTEN_PORT}"
* ```
*/
export declare class LoadBalancerService extends pulumi.CustomResource {
/**
* Get an existing LoadBalancerService 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?: LoadBalancerServiceState, opts?: pulumi.CustomResourceOptions): LoadBalancerService;
/**
* Returns true if the given object is an instance of LoadBalancerService. 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 LoadBalancerService;
/**
* Port the service connects to the targets on, required if protocol is `tcp`. Can be everything between `1` and `65535`.
*/
readonly destinationPort: pulumi.Output<number>;
/**
* Health Check configuration when `protocol` is `http` or `https`.
*/
readonly healthCheck: pulumi.Output<outputs.LoadBalancerServiceHealthCheck>;
/**
* HTTP configuration when `protocol` is `http` or `https`.
*/
readonly http: pulumi.Output<outputs.LoadBalancerServiceHttp>;
/**
* Port the service listen on, required if protocol is `tcp`. Can be everything between `1` and `65535`. Must be unique per Load Balancer.
*/
readonly listenPort: pulumi.Output<number>;
/**
* Id of the load balancer this service belongs to.
*/
readonly loadBalancerId: pulumi.Output<string>;
/**
* Protocol of the service. `http`, `https` or `tcp`
*/
readonly protocol: pulumi.Output<string>;
/**
* Enable proxyprotocol.
*/
readonly proxyprotocol: pulumi.Output<boolean>;
/**
* Create a LoadBalancerService 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: LoadBalancerServiceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LoadBalancerService resources.
*/
export interface LoadBalancerServiceState {
/**
* Port the service connects to the targets on, required if protocol is `tcp`. Can be everything between `1` and `65535`.
*/
destinationPort?: pulumi.Input<number | undefined>;
/**
* Health Check configuration when `protocol` is `http` or `https`.
*/
healthCheck?: pulumi.Input<inputs.LoadBalancerServiceHealthCheck | undefined>;
/**
* HTTP configuration when `protocol` is `http` or `https`.
*/
http?: pulumi.Input<inputs.LoadBalancerServiceHttp | undefined>;
/**
* Port the service listen on, required if protocol is `tcp`. Can be everything between `1` and `65535`. Must be unique per Load Balancer.
*/
listenPort?: pulumi.Input<number | undefined>;
/**
* Id of the load balancer this service belongs to.
*/
loadBalancerId?: pulumi.Input<string | undefined>;
/**
* Protocol of the service. `http`, `https` or `tcp`
*/
protocol?: pulumi.Input<string | undefined>;
/**
* Enable proxyprotocol.
*/
proxyprotocol?: pulumi.Input<boolean | undefined>;
}
/**
* The set of arguments for constructing a LoadBalancerService resource.
*/
export interface LoadBalancerServiceArgs {
/**
* Port the service connects to the targets on, required if protocol is `tcp`. Can be everything between `1` and `65535`.
*/
destinationPort?: pulumi.Input<number | undefined>;
/**
* Health Check configuration when `protocol` is `http` or `https`.
*/
healthCheck?: pulumi.Input<inputs.LoadBalancerServiceHealthCheck | undefined>;
/**
* HTTP configuration when `protocol` is `http` or `https`.
*/
http?: pulumi.Input<inputs.LoadBalancerServiceHttp | undefined>;
/**
* Port the service listen on, required if protocol is `tcp`. Can be everything between `1` and `65535`. Must be unique per Load Balancer.
*/
listenPort?: pulumi.Input<number | undefined>;
/**
* Id of the load balancer this service belongs to.
*/
loadBalancerId: pulumi.Input<string>;
/**
* Protocol of the service. `http`, `https` or `tcp`
*/
protocol: pulumi.Input<string>;
/**
* Enable proxyprotocol.
*/
proxyprotocol?: pulumi.Input<boolean | undefined>;
}
//# sourceMappingURL=loadBalancerService.d.ts.map