pulumi-incus/sdk/nodejs/getStorageBucket.ts

// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** 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";

/**
 * ## # incus.StorageBucket
 *
 * Provides information about an Incus storage bucket.
 * See Incus storage bucket [configuration reference](https://linuxcontainers.org/incus/docs/main/howto/storage_buckets/) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as incus from "@kiterun/incus";
 *
 * const _this = incus.getStorageBucket({
 *     name: "default",
 *     storagePool: "parent",
 * });
 * export const storageBucketName = _this.then(_this => _this.name);
 * ```
 */
export function getStorageBucket(args: GetStorageBucketArgs, opts?: pulumi.InvokeOptions): Promise<GetStorageBucketResult> {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("incus:index/getStorageBucket:getStorageBucket", {
        "description": args.description,
        "location": args.location,
        "name": args.name,
        "project": args.project,
        "remote": args.remote,
        "s3Url": args.s3Url,
        "storagePool": args.storagePool,
        "target": args.target,
    }, opts);
}

/**
 * A collection of arguments for invoking getStorageBucket.
 */
export interface GetStorageBucketArgs {
    /**
     * Description of the storage bucket.
     */
    description?: string;
    /**
     * Location of the storage bucket.
     */
    location?: string;
    /**
     * **Required** - Name of the storage bucket.
     */
    name: string;
    /**
     * *Optional* - Name of the project where the storage bucket is be stored.
     */
    project?: string;
    /**
     * *Optional* - The remote in which the resource was created. If
     * not provided, the provider's default remote will be used.
     */
    remote?: string;
    /**
     * Storage Bucket S3 URL.
     */
    s3Url?: string;
    /**
     * **Required** - Name of the parent storage pool.
     */
    storagePool: string;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    target?: string;
}

/**
 * A collection of values returned by getStorageBucket.
 */
export interface GetStorageBucketResult {
    /**
     * Map of key/value pairs of config settings.
     * [storage bucket config settings](https://linuxcontainers.org/incus/docs/main/reference/storage_drivers/)
     */
    readonly config: {[key: string]: string};
    /**
     * Description of the storage bucket.
     */
    readonly description: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Location of the storage bucket.
     */
    readonly location: string;
    readonly name: string;
    readonly project?: string;
    readonly remote?: string;
    /**
     * Storage Bucket S3 URL.
     */
    readonly s3Url: string;
    readonly storagePool: string;
    readonly target?: string;
}
/**
 * ## # incus.StorageBucket
 *
 * Provides information about an Incus storage bucket.
 * See Incus storage bucket [configuration reference](https://linuxcontainers.org/incus/docs/main/howto/storage_buckets/) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as incus from "@kiterun/incus";
 *
 * const _this = incus.getStorageBucket({
 *     name: "default",
 *     storagePool: "parent",
 * });
 * export const storageBucketName = _this.then(_this => _this.name);
 * ```
 */
export function getStorageBucketOutput(args: GetStorageBucketOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStorageBucketResult> {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("incus:index/getStorageBucket:getStorageBucket", {
        "description": args.description,
        "location": args.location,
        "name": args.name,
        "project": args.project,
        "remote": args.remote,
        "s3Url": args.s3Url,
        "storagePool": args.storagePool,
        "target": args.target,
    }, opts);
}

/**
 * A collection of arguments for invoking getStorageBucket.
 */
export interface GetStorageBucketOutputArgs {
    /**
     * Description of the storage bucket.
     */
    description?: pulumi.Input<string>;
    /**
     * Location of the storage bucket.
     */
    location?: pulumi.Input<string>;
    /**
     * **Required** - Name of the storage bucket.
     */
    name: pulumi.Input<string>;
    /**
     * *Optional* - Name of the project where the storage bucket is be stored.
     */
    project?: pulumi.Input<string>;
    /**
     * *Optional* - The remote in which the resource was created. If
     * not provided, the provider's default remote will be used.
     */
    remote?: pulumi.Input<string>;
    /**
     * Storage Bucket S3 URL.
     */
    s3Url?: pulumi.Input<string>;
    /**
     * **Required** - Name of the parent storage pool.
     */
    storagePool: pulumi.Input<string>;
    /**
     * *Optional* - Specify a target node in a cluster.
     */
    target?: pulumi.Input<string>;
}