@pulumi/hcloud/storageBoxSnapshot.d.ts

A Pulumi package for creating and managing hcloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a Hetzner Storage Box Snapshot resource.
 *
 * See the [Storage Box Snapshots API documentation](https://docs.hetzner.cloud/reference/hetzner#storage-box-snapshots) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as hcloud from "@pulumi/hcloud";
 *
 * const main = new hcloud.StorageBox("main", {});
 * const backup = new hcloud.StorageBoxSnapshot("backup", {
 *     storageBoxId: main.id.apply(x =>Number(x)),
 *     description: "Before Tool XYZ Migration",
 *     labels: {
 *         env: "production",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * The `pulumi import` command can be used, for example:
 *
 * ```sh
 * $ pulumi import hcloud:index/storageBoxSnapshot:StorageBoxSnapshot example "$STORAGE_BOX_ID/$STORAGE_BOX_SNAPSHOT_ID"
 * ```
 */
export declare class StorageBoxSnapshot extends pulumi.CustomResource {
    /**
     * Get an existing StorageBoxSnapshot 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?: StorageBoxSnapshotState, opts?: pulumi.CustomResourceOptions): StorageBoxSnapshot;
    /**
     * Returns true if the given object is an instance of StorageBoxSnapshot.  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 StorageBoxSnapshot;
    /**
     * Description of the Storage Box Snapshot.
     */
    readonly description: pulumi.Output<string>;
    /**
     * Whether the Storage Box Snapshot was created automatically.
     */
    readonly isAutomatic: pulumi.Output<boolean>;
    /**
     * User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * Name of the Storage Box Snapshot.
     */
    readonly name: pulumi.Output<string>;
    /**
     * ID of the Storage Box.
     */
    readonly storageBoxId: pulumi.Output<number>;
    /**
     * Create a StorageBoxSnapshot 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: StorageBoxSnapshotArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering StorageBoxSnapshot resources.
 */
export interface StorageBoxSnapshotState {
    /**
     * Description of the Storage Box Snapshot.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Whether the Storage Box Snapshot was created automatically.
     */
    isAutomatic?: pulumi.Input<boolean | undefined>;
    /**
     * User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Name of the Storage Box Snapshot.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * ID of the Storage Box.
     */
    storageBoxId?: pulumi.Input<number | undefined>;
}
/**
 * The set of arguments for constructing a StorageBoxSnapshot resource.
 */
export interface StorageBoxSnapshotArgs {
    /**
     * Description of the Storage Box Snapshot.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * ID of the Storage Box.
     */
    storageBoxId: pulumi.Input<number>;
}
//# sourceMappingURL=storageBoxSnapshot.d.ts.map