UNPKG

@muhlba91/pulumi-proxmoxve

Version:

A Pulumi package for creating and managing Proxmox Virtual Environment cloud resources.

135 lines (134 loc) 4.9 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages a High Availability group in a Proxmox VE cluster. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as proxmoxve from "@muhlba91/pulumi-proxmoxve"; * * const example = new proxmoxve.ha.HAGroup("example", { * group: "example", * comment: "This is a comment.", * nodes: { * node1: null, * node2: 2, * node3: 1, * }, * restricted: true, * noFailback: false, * }); * ``` * * ## Import * * #!/usr/bin/env sh * * HA groups can be imported using their name, e.g.: * * ```sh * $ pulumi import proxmoxve:HA/hAGroup:HAGroup example example * ``` */ export declare class HAGroup extends pulumi.CustomResource { /** * Get an existing HAGroup 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?: HAGroupState, opts?: pulumi.CustomResourceOptions): HAGroup; /** * Returns true if the given object is an instance of HAGroup. 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 HAGroup; /** * The comment associated with this group */ readonly comment: pulumi.Output<string | undefined>; /** * The identifier of the High Availability group to manage. */ readonly group: pulumi.Output<string>; /** * A flag that indicates that failing back to a higher priority node is disabled for this HA group. Defaults to `false`. */ readonly noFailback: pulumi.Output<boolean>; /** * The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or `null` for unset priorities. */ readonly nodes: pulumi.Output<{ [key: string]: number; }>; /** * A flag that indicates that other nodes may not be used to run resources associated to this HA group. Defaults to `false`. */ readonly restricted: pulumi.Output<boolean>; /** * Create a HAGroup 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: HAGroupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering HAGroup resources. */ export interface HAGroupState { /** * The comment associated with this group */ comment?: pulumi.Input<string>; /** * The identifier of the High Availability group to manage. */ group?: pulumi.Input<string>; /** * A flag that indicates that failing back to a higher priority node is disabled for this HA group. Defaults to `false`. */ noFailback?: pulumi.Input<boolean>; /** * The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or `null` for unset priorities. */ nodes?: pulumi.Input<{ [key: string]: pulumi.Input<number>; }>; /** * A flag that indicates that other nodes may not be used to run resources associated to this HA group. Defaults to `false`. */ restricted?: pulumi.Input<boolean>; } /** * The set of arguments for constructing a HAGroup resource. */ export interface HAGroupArgs { /** * The comment associated with this group */ comment?: pulumi.Input<string>; /** * The identifier of the High Availability group to manage. */ group: pulumi.Input<string>; /** * A flag that indicates that failing back to a higher priority node is disabled for this HA group. Defaults to `false`. */ noFailback?: pulumi.Input<boolean>; /** * The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or `null` for unset priorities. */ nodes: pulumi.Input<{ [key: string]: pulumi.Input<number>; }>; /** * A flag that indicates that other nodes may not be used to run resources associated to this HA group. Defaults to `false`. */ restricted?: pulumi.Input<boolean>; }