@pulumi/vsphere/file.d.ts

A Pulumi package for creating vsphere resources

import * as pulumi from "@pulumi/pulumi";
/**
 * ## Example Usage
 *
 * ### Uploading a File
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as vsphere from "@pulumi/vsphere";
 *
 * const ubuntuVmdkUpload = new vsphere.File("ubuntu_vmdk_upload", {
 *     datacenter: "dc-01",
 *     datastore: "datastore-01",
 *     sourceFile: "/my/src/path/custom_ubuntu.vmdk",
 *     destinationFile: "/my/dst/path/custom_ubuntu.vmdk",
 *     createDirectories: true,
 * });
 * ```
 *
 * ### Copying a File
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as vsphere from "@pulumi/vsphere";
 *
 * const ubuntuCopy = new vsphere.File("ubuntu_copy", {
 *     sourceDatacenter: "dc-01",
 *     datacenter: "dc-01",
 *     sourceDatastore: "datastore-01",
 *     datastore: "datastore-01",
 *     sourceFile: "/my/src/path/custom_ubuntu.vmdk",
 *     destinationFile: "/my/dst/path/custom_ubuntu.vmdk",
 *     createDirectories: true,
 * });
 * ```
 */
export declare class File extends pulumi.CustomResource {
    /**
     * Get an existing File 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?: FileState, opts?: pulumi.CustomResourceOptions): File;
    /**
     * Returns true if the given object is an instance of File.  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 File;
    /**
     * Specifies whether to create the parent directories of the destination file if they do not exist.
     */
    readonly createDirectories: pulumi.Output<boolean | undefined>;
    /**
     * The name of a datacenter to which the file will be
     * uploaded.
     */
    readonly datacenter: pulumi.Output<string | undefined>;
    /**
     * The name of the datastore to which to upload the
     * file.
     */
    readonly datastore: pulumi.Output<string>;
    /**
     * The path to where the file should be uploaded
     * or copied to on the destination datastore.
     */
    readonly destinationFile: pulumi.Output<string>;
    /**
     * The name of a datacenter from which the file
     * will be copied. Forces a new resource if changed.
     */
    readonly sourceDatacenter: pulumi.Output<string | undefined>;
    /**
     * The name of the datastore from which file will
     * be copied. Forces a new resource if changed.
     */
    readonly sourceDatastore: pulumi.Output<string | undefined>;
    /**
     * The path to the file being uploaded from or copied.
     * Forces a new resource if changed.
     */
    readonly sourceFile: pulumi.Output<string>;
    /**
     * Create a File 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: FileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering File resources.
 */
export interface FileState {
    /**
     * Specifies whether to create the parent directories of the destination file if they do not exist.
     */
    createDirectories?: pulumi.Input<boolean>;
    /**
     * The name of a datacenter to which the file will be
     * uploaded.
     */
    datacenter?: pulumi.Input<string>;
    /**
     * The name of the datastore to which to upload the
     * file.
     */
    datastore?: pulumi.Input<string>;
    /**
     * The path to where the file should be uploaded
     * or copied to on the destination datastore.
     */
    destinationFile?: pulumi.Input<string>;
    /**
     * The name of a datacenter from which the file
     * will be copied. Forces a new resource if changed.
     */
    sourceDatacenter?: pulumi.Input<string>;
    /**
     * The name of the datastore from which file will
     * be copied. Forces a new resource if changed.
     */
    sourceDatastore?: pulumi.Input<string>;
    /**
     * The path to the file being uploaded from or copied.
     * Forces a new resource if changed.
     */
    sourceFile?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a File resource.
 */
export interface FileArgs {
    /**
     * Specifies whether to create the parent directories of the destination file if they do not exist.
     */
    createDirectories?: pulumi.Input<boolean>;
    /**
     * The name of a datacenter to which the file will be
     * uploaded.
     */
    datacenter?: pulumi.Input<string>;
    /**
     * The name of the datastore to which to upload the
     * file.
     */
    datastore: pulumi.Input<string>;
    /**
     * The path to where the file should be uploaded
     * or copied to on the destination datastore.
     */
    destinationFile: pulumi.Input<string>;
    /**
     * The name of a datacenter from which the file
     * will be copied. Forces a new resource if changed.
     */
    sourceDatacenter?: pulumi.Input<string>;
    /**
     * The name of the datastore from which file will
     * be copied. Forces a new resource if changed.
     */
    sourceDatastore?: pulumi.Input<string>;
    /**
     * The path to the file being uploaded from or copied.
     * Forces a new resource if changed.
     */
    sourceFile: pulumi.Input<string>;
}