UNPKG

@pulumi/consul

Version:

A Pulumi package for creating and managing consul resources.

80 lines (79 loc) 2.58 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * The `consul.getAutopilotHealth` data source returns * [autopilot health information](https://www.consul.io/api/operator/autopilot.html#read-health) * about the current Consul cluster. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as consul from "@pulumi/consul"; * * const read = consul.getAutopilotHealth({}); * export const health = read.then(read => read.healthy); * ``` */ export declare function getAutopilotHealth(args?: GetAutopilotHealthArgs, opts?: pulumi.InvokeOptions): Promise<GetAutopilotHealthResult>; /** * A collection of arguments for invoking getAutopilotHealth. */ export interface GetAutopilotHealthArgs { /** * The datacenter to use. This overrides the agent's * default datacenter and the datacenter in the provider setup. */ datacenter?: string; } /** * A collection of values returned by getAutopilotHealth. */ export interface GetAutopilotHealthResult { readonly datacenter?: string; /** * The number of redundant healthy servers that could fail * without causing an outage */ readonly failureTolerance: number; /** * Whether the server is healthy according to the current Autopilot * configuration */ readonly healthy: boolean; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * A list of server health information. See below for details on the * available information. */ readonly servers: outputs.GetAutopilotHealthServer[]; } /** * The `consul.getAutopilotHealth` data source returns * [autopilot health information](https://www.consul.io/api/operator/autopilot.html#read-health) * about the current Consul cluster. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as consul from "@pulumi/consul"; * * const read = consul.getAutopilotHealth({}); * export const health = read.then(read => read.healthy); * ``` */ export declare function getAutopilotHealthOutput(args?: GetAutopilotHealthOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAutopilotHealthResult>; /** * A collection of arguments for invoking getAutopilotHealth. */ export interface GetAutopilotHealthOutputArgs { /** * The datacenter to use. This overrides the agent's * default datacenter and the datacenter in the provider setup. */ datacenter?: pulumi.Input<string>; }