@pulumi/hcloud/storageBox.d.ts

A Pulumi package for creating and managing hcloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Provides a Hetzner Storage Box resource.
 *
 * See the [Storage Box API documentation](https://docs.hetzner.cloud/reference/hetzner#storage-boxes) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as hcloud from "@pulumi/hcloud";
 * import * as std from "@pulumi/std";
 *
 * const backups = new hcloud.StorageBox("backups", {
 *     name: "backups",
 *     storageBoxType: "bx21",
 *     location: "hel1",
 *     password: storageBoxPassword,
 *     labels: {
 *         foo: "bar",
 *     },
 *     accessSettings: {
 *         reachableExternally: true,
 *         sambaEnabled: true,
 *         sshEnabled: true,
 *         webdavEnabled: true,
 *         zfsEnabled: true,
 *     },
 *     snapshotPlan: {
 *         maxSnapshots: 10,
 *         minute: 16,
 *         hour: 18,
 *         dayOfWeek: 3,
 *     },
 *     deleteProtection: true,
 * });
 * const sshKey = new hcloud.StorageBox("ssh_key", {
 *     name: "backups",
 *     storageBoxType: "bx21",
 *     location: "hel1",
 *     password: storageBoxPassword,
 *     sshKeys: [
 *         myKey.publicKey,
 *         std.file({
 *             input: "~/.ssh/id_ed25519.pub",
 *         }).then(invoke => invoke.result),
 *     ],
 * });
 * ```
 *
 * ## Import
 *
 * The `pulumi import` command can be used, for example:
 *
 * ```sh
 * $ pulumi import hcloud:index/storageBox:StorageBox example "$STORAGE_BOX_ID"
 * ```
 */
export declare class StorageBox extends pulumi.CustomResource {
    /**
     * Get an existing StorageBox 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?: StorageBoxState, opts?: pulumi.CustomResourceOptions): StorageBox;
    /**
     * Returns true if the given object is an instance of StorageBox.  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 StorageBox;
    /**
     * Access settings of the Storage Box.
     */
    readonly accessSettings: pulumi.Output<outputs.StorageBoxAccessSettings>;
    /**
     * Prevent the Storage Box from being accidentally deleted outside of Terraform.
     */
    readonly deleteProtection: 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 Location.
     */
    readonly location: pulumi.Output<string>;
    /**
     * Name of the Storage Box.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Password of the Storage Box. For more details, see the [Storage Boxes password policy](https://docs.hetzner.cloud/reference/hetzner#storage-boxes-password-policy).
     */
    readonly password: pulumi.Output<string>;
    /**
     * FQDN of the Storage Box.
     */
    readonly server: pulumi.Output<string>;
    /**
     * Details of the active snapshot plan.
     */
    readonly snapshotPlan: pulumi.Output<outputs.StorageBoxSnapshotPlan | undefined>;
    /**
     * SSH public keys in OpenSSH format to inject into the Storage Box. It is not possible to update the SSH Keys through the API, so changing this attribute forces a replace of the Storage Box.
     */
    readonly sshKeys: pulumi.Output<string[]>;
    /**
     * Name of the Storage Box Type.
     */
    readonly storageBoxType: pulumi.Output<string>;
    /**
     * Host system of the Storage Box.
     */
    readonly system: pulumi.Output<string>;
    /**
     * Primary username of the Storage Box.
     */
    readonly username: pulumi.Output<string>;
    /**
     * Create a StorageBox 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: StorageBoxArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering StorageBox resources.
 */
export interface StorageBoxState {
    /**
     * Access settings of the Storage Box.
     */
    accessSettings?: pulumi.Input<inputs.StorageBoxAccessSettings | undefined>;
    /**
     * Prevent the Storage Box from being accidentally deleted outside of Terraform.
     */
    deleteProtection?: 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 Location.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * Name of the Storage Box.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Password of the Storage Box. For more details, see the [Storage Boxes password policy](https://docs.hetzner.cloud/reference/hetzner#storage-boxes-password-policy).
     */
    password?: pulumi.Input<string | undefined>;
    /**
     * FQDN of the Storage Box.
     */
    server?: pulumi.Input<string | undefined>;
    /**
     * Details of the active snapshot plan.
     */
    snapshotPlan?: pulumi.Input<inputs.StorageBoxSnapshotPlan | undefined>;
    /**
     * SSH public keys in OpenSSH format to inject into the Storage Box. It is not possible to update the SSH Keys through the API, so changing this attribute forces a replace of the Storage Box.
     */
    sshKeys?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * Name of the Storage Box Type.
     */
    storageBoxType?: pulumi.Input<string | undefined>;
    /**
     * Host system of the Storage Box.
     */
    system?: pulumi.Input<string | undefined>;
    /**
     * Primary username of the Storage Box.
     */
    username?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a StorageBox resource.
 */
export interface StorageBoxArgs {
    /**
     * Access settings of the Storage Box.
     */
    accessSettings?: pulumi.Input<inputs.StorageBoxAccessSettings | undefined>;
    /**
     * Prevent the Storage Box from being accidentally deleted outside of Terraform.
     */
    deleteProtection?: 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 Location.
     */
    location: pulumi.Input<string>;
    /**
     * Name of the Storage Box.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Password of the Storage Box. For more details, see the [Storage Boxes password policy](https://docs.hetzner.cloud/reference/hetzner#storage-boxes-password-policy).
     */
    password: pulumi.Input<string>;
    /**
     * Details of the active snapshot plan.
     */
    snapshotPlan?: pulumi.Input<inputs.StorageBoxSnapshotPlan | undefined>;
    /**
     * SSH public keys in OpenSSH format to inject into the Storage Box. It is not possible to update the SSH Keys through the API, so changing this attribute forces a replace of the Storage Box.
     */
    sshKeys?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * Name of the Storage Box Type.
     */
    storageBoxType: pulumi.Input<string>;
}
//# sourceMappingURL=storageBox.d.ts.map