@pulumi/hcloud/storageBoxSubaccount.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 Subaccount resource.
 *
 * See the [Storage Box Subaccounts API documentation](https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccounts) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as hcloud from "@pulumi/hcloud";
 *
 * const config = new pulumi.Config();
 * const teamBadgerPassword = config.require("teamBadgerPassword");
 * const main = new hcloud.StorageBox("main", {});
 * const teamBadger = new hcloud.StorageBoxSubaccount("team_badger", {
 *     storageBoxId: main.id.apply(x =>Number(x)),
 *     name: "badger",
 *     homeDirectory: "teams/badger/",
 *     password: teamBadgerPassword,
 *     accessSettings: {
 *         reachableExternally: true,
 *         sambaEnabled: true,
 *     },
 *     description: "Primary account for the Badger team to upload files.",
 *     labels: {
 *         env: "production",
 *         team: "badger",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * The `pulumi import` command can be used, for example:
 *
 * ```sh
 * $ pulumi import hcloud:index/storageBoxSubaccount:StorageBoxSubaccount example "$STORAGE_BOX_ID/$STORAGE_BOX_SUBACCOUNT_ID"
 * ```
 */
export declare class StorageBoxSubaccount extends pulumi.CustomResource {
    /**
     * Get an existing StorageBoxSubaccount 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?: StorageBoxSubaccountState, opts?: pulumi.CustomResourceOptions): StorageBoxSubaccount;
    /**
     * Returns true if the given object is an instance of StorageBoxSubaccount.  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 StorageBoxSubaccount;
    /**
     * Access settings for the Subaccount.
     */
    readonly accessSettings: pulumi.Output<outputs.StorageBoxSubaccountAccessSettings>;
    /**
     * A description of the Storage Box Subaccount.
     */
    readonly description: pulumi.Output<string>;
    /**
     * Home directory of the Storage Box Subaccount. The directory will be created if it doesn't exist yet. Must not include a leading slash (`/`).
     */
    readonly homeDirectory: pulumi.Output<string>;
    /**
     * 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 Subaccount.
     */
    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 Subaccount.
     */
    readonly server: pulumi.Output<string>;
    /**
     * ID of the Storage Box.
     */
    readonly storageBoxId: pulumi.Output<number>;
    /**
     * Username of the Storage Box Subaccount.
     */
    readonly username: pulumi.Output<string>;
    /**
     * Create a StorageBoxSubaccount 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: StorageBoxSubaccountArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering StorageBoxSubaccount resources.
 */
export interface StorageBoxSubaccountState {
    /**
     * Access settings for the Subaccount.
     */
    accessSettings?: pulumi.Input<inputs.StorageBoxSubaccountAccessSettings | undefined>;
    /**
     * A description of the Storage Box Subaccount.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Home directory of the Storage Box Subaccount. The directory will be created if it doesn't exist yet. Must not include a leading slash (`/`).
     */
    homeDirectory?: 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>;
    /**
     * Name of the Storage Box Subaccount.
     */
    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 Subaccount.
     */
    server?: pulumi.Input<string | undefined>;
    /**
     * ID of the Storage Box.
     */
    storageBoxId?: pulumi.Input<number | undefined>;
    /**
     * Username of the Storage Box Subaccount.
     */
    username?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a StorageBoxSubaccount resource.
 */
export interface StorageBoxSubaccountArgs {
    /**
     * Access settings for the Subaccount.
     */
    accessSettings?: pulumi.Input<inputs.StorageBoxSubaccountAccessSettings | undefined>;
    /**
     * A description of the Storage Box Subaccount.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Home directory of the Storage Box Subaccount. The directory will be created if it doesn't exist yet. Must not include a leading slash (`/`).
     */
    homeDirectory: pulumi.Input<string>;
    /**
     * 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 Subaccount.
     */
    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>;
    /**
     * ID of the Storage Box.
     */
    storageBoxId: pulumi.Input<number>;
}
//# sourceMappingURL=storageBoxSubaccount.d.ts.map