@muhlba91/pulumi-proxmoxve
Version:
A Pulumi package for creating and managing Proxmox Virtual Environment cloud resources.
103 lines (102 loc) • 3.24 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* Manages a directory mapping 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.hardware.mapping.Dir("example", {
* comment: "This is a comment",
* maps: [{
* node: "pve",
* path: "/mnt/data",
* }],
* });
* ```
*
* ## Import
*
* #!/usr/bin/env sh
*
* A directory mapping can be imported using their name, e.g.:
*
* ```sh
* $ pulumi import proxmoxve:Hardware/mapping/dir:Dir example example
* ```
*/
export declare class Dir extends pulumi.CustomResource {
/**
* Get an existing Dir 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?: DirState, opts?: pulumi.CustomResourceOptions): Dir;
/**
* Returns true if the given object is an instance of Dir. 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 Dir;
/**
* The comment of this directory mapping.
*/
readonly comment: pulumi.Output<string | undefined>;
/**
* The actual map of devices for the hardware mapping.
*/
readonly maps: pulumi.Output<outputs.Hardware.mapping.DirMap[]>;
/**
* The name of this directory mapping.
*/
readonly name: pulumi.Output<string>;
/**
* Create a Dir 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: DirArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Dir resources.
*/
export interface DirState {
/**
* The comment of this directory mapping.
*/
comment?: pulumi.Input<string>;
/**
* The actual map of devices for the hardware mapping.
*/
maps?: pulumi.Input<pulumi.Input<inputs.Hardware.mapping.DirMap>[]>;
/**
* The name of this directory mapping.
*/
name?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Dir resource.
*/
export interface DirArgs {
/**
* The comment of this directory mapping.
*/
comment?: pulumi.Input<string>;
/**
* The actual map of devices for the hardware mapping.
*/
maps: pulumi.Input<pulumi.Input<inputs.Hardware.mapping.DirMap>[]>;
/**
* The name of this directory mapping.
*/
name?: pulumi.Input<string>;
}