// *** 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 inputs from "./types/input";
import * as outputs from "./types/output";
import * as utilities from "./utilities";

export class StorageVolume extends pulumi.CustomResource {
    /**
     * Get an existing StorageVolume 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?: StorageVolumeState, opts?: pulumi.CustomResourceOptions): StorageVolume {
        return new StorageVolume(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'incus:index/storageVolume:StorageVolume';

    /**
     * Returns true if the given object is an instance of StorageVolume.  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 StorageVolume {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === StorageVolume.__pulumiType;
    }

    /**
     * *Optional* - Map of key/value pairs of
     * [volume config settings](https://linuxcontainers.org/incus/docs/main/reference/storage_drivers/).
     * Config settings vary depending on the Storage Pool used.
     */
    public readonly config!: pulumi.Output<{[key: string]: string}>;
    /**
     * *Optional* - Volume content type (`filesystem` or `block`)
     */
    public readonly contentType!: pulumi.Output<string>;
    /**
     * *Optional* - Description of the volume.
     */
    public readonly description!: pulumi.Output<string>;
    /**
     * Name of the node where volume was created. It could be useful with Incus in cluster mode.
     */
    public /*out*/ readonly location!: pulumi.Output<string>;
    /**
     * **Required** - Name of the storage volume.
     */
    public readonly name!: pulumi.Output<string>;
    /**
     * **Required** - Name of storage pool to host the volume.
     */
    public readonly pool!: pulumi.Output<string>;
    /**
     * *Optional* - Name of the project where the volume 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* - Path to a backup file from which the volume will be created.
     */
    public readonly sourceFile!: pulumi.Output<string | undefined>;
    /**
     * *Optional* - The source volume from which the volume will be created. See reference below.
     */
    public readonly sourceVolume!: pulumi.Output<outputs.StorageVolumeSourceVolume | undefined>;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    public readonly target!: pulumi.Output<string>;
    /**
     * *Optional* - The "type" of volume. The default value is `custom`,
     * which is the type to use for storage volumes attached to instances.
     */
    public readonly type!: pulumi.Output<string>;

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

/**
 * Input properties used for looking up and filtering StorageVolume resources.
 */
export interface StorageVolumeState {
    /**
     * *Optional* - Map of key/value pairs of
     * [volume config settings](https://linuxcontainers.org/incus/docs/main/reference/storage_drivers/).
     * Config settings vary depending on the Storage Pool used.
     */
    config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    /**
     * *Optional* - Volume content type (`filesystem` or `block`)
     */
    contentType?: pulumi.Input<string>;
    /**
     * *Optional* - Description of the volume.
     */
    description?: pulumi.Input<string>;
    /**
     * Name of the node where volume was created. It could be useful with Incus in cluster mode.
     */
    location?: pulumi.Input<string>;
    /**
     * **Required** - Name of the storage volume.
     */
    name?: pulumi.Input<string>;
    /**
     * **Required** - Name of storage pool to host the volume.
     */
    pool?: pulumi.Input<string>;
    /**
     * *Optional* - Name of the project where the volume 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* - Path to a backup file from which the volume will be created.
     */
    sourceFile?: pulumi.Input<string>;
    /**
     * *Optional* - The source volume from which the volume will be created. See reference below.
     */
    sourceVolume?: pulumi.Input<inputs.StorageVolumeSourceVolume>;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    target?: pulumi.Input<string>;
    /**
     * *Optional* - The "type" of volume. The default value is `custom`,
     * which is the type to use for storage volumes attached to instances.
     */
    type?: pulumi.Input<string>;
}

/**
 * The set of arguments for constructing a StorageVolume resource.
 */
export interface StorageVolumeArgs {
    /**
     * *Optional* - Map of key/value pairs of
     * [volume config settings](https://linuxcontainers.org/incus/docs/main/reference/storage_drivers/).
     * Config settings vary depending on the Storage Pool used.
     */
    config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
    /**
     * *Optional* - Volume content type (`filesystem` or `block`)
     */
    contentType?: pulumi.Input<string>;
    /**
     * *Optional* - Description of the volume.
     */
    description?: pulumi.Input<string>;
    /**
     * **Required** - Name of the storage volume.
     */
    name?: pulumi.Input<string>;
    /**
     * **Required** - Name of storage pool to host the volume.
     */
    pool: pulumi.Input<string>;
    /**
     * *Optional* - Name of the project where the volume 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* - Path to a backup file from which the volume will be created.
     */
    sourceFile?: pulumi.Input<string>;
    /**
     * *Optional* - The source volume from which the volume will be created. See reference below.
     */
    sourceVolume?: pulumi.Input<inputs.StorageVolumeSourceVolume>;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    target?: pulumi.Input<string>;
    /**
     * *Optional* - The "type" of volume. The default value is `custom`,
     * which is the type to use for storage volumes attached to instances.
     */
    type?: pulumi.Input<string>;
}