pulumi-incus/sdk/nodejs/storagePool.ts

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

import * as pulumi from "@pulumi/pulumi";
import * as utilities from "./utilities";

export class StoragePool extends pulumi.CustomResource {
    /**
     * Get an existing StoragePool 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.
     */
    public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StoragePoolState, opts?: pulumi.CustomResourceOptions): StoragePool {
        return new StoragePool(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'incus:index/storagePool:StoragePool';

    /**
     * Returns true if the given object is an instance of StoragePool.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    public static isInstance(obj: any): obj is StoragePool {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === StoragePool.__pulumiType;
    }

    /**
     * *Optional* - Map of key/value pairs of
     * [storage pool config settings](https://linuxcontainers.org/incus/docs/main/reference/storage_drivers/).
     * Config settings vary from driver to driver.
     */
    public readonly config!: pulumi.Output<{[key: string]: string}>;
    /**
     * *Optional* - Description of the storage pool.
     */
    public readonly description!: pulumi.Output<string>;
    /**
     * **Required** - Storage Pool driver. Must be one of `dir`, `zfs`, `lvm`, `btrfs`, `ceph`, `cephfs`, or `cephobject`.
     */
    public readonly driver!: pulumi.Output<string>;
    /**
     * **Required** - Name of the storage pool.
     */
    public readonly name!: pulumi.Output<string>;
    /**
     * *Optional* - Name of the project where the storage pool will be stored.
     */
    public readonly project!: pulumi.Output<string>;
    /**
     * *Optional* - The remote in which the resource will be created. If
     * not provided, the provider's default remote will be used.
     */
    public readonly remote!: pulumi.Output<string | undefined>;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    public readonly target!: pulumi.Output<string | undefined>;

    /**
     * Create a StoragePool 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: StoragePoolArgs, opts?: pulumi.CustomResourceOptions)
    constructor(name: string, argsOrState?: StoragePoolArgs | StoragePoolState, opts?: pulumi.CustomResourceOptions) {
        let resourceInputs: pulumi.Inputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState as StoragePoolState | undefined;
            resourceInputs["config"] = state ? state.config : undefined;
            resourceInputs["description"] = state ? state.description : undefined;
            resourceInputs["driver"] = state ? state.driver : undefined;
            resourceInputs["name"] = state ? state.name : undefined;
            resourceInputs["project"] = state ? state.project : undefined;
            resourceInputs["remote"] = state ? state.remote : undefined;
            resourceInputs["target"] = state ? state.target : undefined;
        } else {
            const args = argsOrState as StoragePoolArgs | undefined;
            if ((!args || args.driver === undefined) && !opts.urn) {
                throw new Error("Missing required property 'driver'");
            }
            resourceInputs["config"] = args ? args.config : undefined;
            resourceInputs["description"] = args ? args.description : undefined;
            resourceInputs["driver"] = args ? args.driver : undefined;
            resourceInputs["name"] = args ? args.name : undefined;
            resourceInputs["project"] = (args ? args.project : undefined) ?? "default";
            resourceInputs["remote"] = args ? args.remote : undefined;
            resourceInputs["target"] = args ? args.target : undefined;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(StoragePool.__pulumiType, name, resourceInputs, opts);
    }
}

/**
 * Input properties used for looking up and filtering StoragePool resources.
 */
export interface StoragePoolState {
    /**
     * *Optional* - Map of key/value pairs of
     * [storage pool config settings](https://linuxcontainers.org/incus/docs/main/reference/storage_drivers/).
     * Config settings vary from driver to driver.
     */
    config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    /**
     * *Optional* - Description of the storage pool.
     */
    description?: pulumi.Input<string>;
    /**
     * **Required** - Storage Pool driver. Must be one of `dir`, `zfs`, `lvm`, `btrfs`, `ceph`, `cephfs`, or `cephobject`.
     */
    driver?: pulumi.Input<string>;
    /**
     * **Required** - Name of the storage pool.
     */
    name?: pulumi.Input<string>;
    /**
     * *Optional* - Name of the project where the storage pool will be stored.
     */
    project?: pulumi.Input<string>;
    /**
     * *Optional* - The remote in which the resource will be created. If
     * not provided, the provider's default remote will be used.
     */
    remote?: pulumi.Input<string>;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    target?: pulumi.Input<string>;
}

/**
 * The set of arguments for constructing a StoragePool resource.
 */
export interface StoragePoolArgs {
    /**
     * *Optional* - Map of key/value pairs of
     * [storage pool config settings](https://linuxcontainers.org/incus/docs/main/reference/storage_drivers/).
     * Config settings vary from driver to driver.
     */
    config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    /**
     * *Optional* - Description of the storage pool.
     */
    description?: pulumi.Input<string>;
    /**
     * **Required** - Storage Pool driver. Must be one of `dir`, `zfs`, `lvm`, `btrfs`, `ceph`, `cephfs`, or `cephobject`.
     */
    driver: pulumi.Input<string>;
    /**
     * **Required** - Name of the storage pool.
     */
    name?: pulumi.Input<string>;
    /**
     * *Optional* - Name of the project where the storage pool will be stored.
     */
    project?: pulumi.Input<string>;
    /**
     * *Optional* - The remote in which the resource will be created. If
     * not provided, the provider's default remote will be used.
     */
    remote?: pulumi.Input<string>;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    target?: pulumi.Input<string>;
}