@pulumi/command 0.0.1-alpha.100

package/remote/command.d.ts

@@ -0,0 +1,206 @@
+import * as pulumi from "@pulumi/pulumi";
+import * as inputs from "../types/input";
+import * as outputs from "../types/output";
+import * as enums from "../types/enums";
+/**
+ * A command to run on a remote host. The connection is established via ssh.
+ *
+ * ## Example Usage
+ *
+ * ### A Basic Example
+ * This program connects to a server and runs the `hostname` command. The output is then available via the `stdout` property.
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as command from "@pulumi/command";
+ *
+ * const config = new pulumi.Config();
+ * const server = config.require("server");
+ * const userName = config.require("userName");
+ * const privateKey = config.require("privateKey");
+ *
+ * const hostnameCmd = new command.remote.Command("hostnameCmd", {
+ *     create: "hostname",
+ *     connection: {
+ *         host: server,
+ *         user: userName,
+ *         privateKey: privateKey,
+ *     },
+ * });
+ * export const hostname = hostnameCmd.stdout;
+ * ```
+ *
+ * ### Triggers
+ * This example defines several trigger values of various kinds. Changes to any of them will cause `cmd` to be re-run.
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as command from "@pulumi/command";
+ * import * as random from "@pulumi/random";
+ *
+ * const str = "foo";
+ * const fileAsset = new pulumi.asset.FileAsset("Pulumi.yaml");
+ * const rand = new random.RandomString("rand", {length: 5});
+ * const localFile = new command.local.Command("localFile", {
+ *     create: "touch foo.txt",
+ *     archivePaths: ["*.txt"],
+ * });
+ * const cmd = new command.remote.Command("cmd", {
+ *     connection: {
+ *         host: "insert host here",
+ *     },
+ *     create: "echo create > op.txt",
+ *     delete: "echo delete >> op.txt",
+ *     triggers: [
+ *         str,
+ *         rand.result,
+ *         fileAsset,
+ *         localFile.archive,
+ *     ],
+ * });
+ *
+ * ```
+ */
+export declare class Command extends pulumi.CustomResource {
+    /**
+     * Get an existing Command 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 opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Command;
+    /**
+     * Returns true if the given object is an instance of Command.  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 Command;
+    /**
+     * If the previous command's stdout and stderr (as generated by the prior create/update) is
+     * injected into the environment of the next run as PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR.
+     * Defaults to true.
+     */
+    readonly addPreviousOutputInEnv: pulumi.Output<boolean | undefined>;
+    /**
+     * The parameters with which to connect to the remote host.
+     */
+    readonly connection: pulumi.Output<outputs.remote.Connection>;
+    /**
+     * The command to run on create.
+     */
+    readonly create: pulumi.Output<string | undefined>;
+    /**
+     * The command to run on delete. The environment variables PULUMI_COMMAND_STDOUT
+     * and PULUMI_COMMAND_STDERR are set to the stdout and stderr properties of the
+     * Command resource from previous create or update steps.
+     */
+    readonly delete: pulumi.Output<string | undefined>;
+    /**
+     * Additional environment variables available to the command's process.
+     * Note that this only works if the SSH server is configured to accept these variables via AcceptEnv.
+     * Alternatively, if a Bash-like shell runs the command on the remote host, you could prefix the command itself
+     * with the variables in the form 'VAR=value command'.
+     */
+    readonly environment: pulumi.Output<{
+        [key: string]: string;
+    } | undefined>;
+    /**
+     * If the command's stdout and stderr should be logged. This doesn't affect the capturing of
+     * stdout and stderr as outputs. If there might be secrets in the output, you can disable logging here and mark the
+     * outputs as secret via 'additionalSecretOutputs'. Defaults to logging both stdout and stderr.
+     */
+    readonly logging: pulumi.Output<enums.remote.Logging | undefined>;
+    /**
+     * The standard error of the command's process
+     */
+    readonly stderr: pulumi.Output<string>;
+    /**
+     * Pass a string to the command's process as standard in
+     */
+    readonly stdin: pulumi.Output<string | undefined>;
+    /**
+     * The standard output of the command's process
+     */
+    readonly stdout: pulumi.Output<string>;
+    /**
+     * Trigger a resource replacement on changes to any of these values. The
+     * trigger values can be of any type. If a value is different in the current update compared to the
+     * previous update, the resource will be replaced, i.e., the "create" command will be re-run.
+     * Please see the resource documentation for examples.
+     */
+    readonly triggers: pulumi.Output<any[] | undefined>;
+    /**
+     * The command to run on update, if empty, create will
+     * run again. The environment variables PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR
+     * are set to the stdout and stderr properties of the Command resource from previous
+     * create or update steps.
+     */
+    readonly update: pulumi.Output<string | undefined>;
+    /**
+     * Create a Command 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: CommandArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * The set of arguments for constructing a Command resource.
+ */
+export interface CommandArgs {
+    /**
+     * If the previous command's stdout and stderr (as generated by the prior create/update) is
+     * injected into the environment of the next run as PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR.
+     * Defaults to true.
+     */
+    addPreviousOutputInEnv?: pulumi.Input<boolean>;
+    /**
+     * The parameters with which to connect to the remote host.
+     */
+    connection: pulumi.Input<inputs.remote.ConnectionArgs>;
+    /**
+     * The command to run on create.
+     */
+    create?: pulumi.Input<string>;
+    /**
+     * The command to run on delete. The environment variables PULUMI_COMMAND_STDOUT
+     * and PULUMI_COMMAND_STDERR are set to the stdout and stderr properties of the
+     * Command resource from previous create or update steps.
+     */
+    delete?: pulumi.Input<string>;
+    /**
+     * Additional environment variables available to the command's process.
+     * Note that this only works if the SSH server is configured to accept these variables via AcceptEnv.
+     * Alternatively, if a Bash-like shell runs the command on the remote host, you could prefix the command itself
+     * with the variables in the form 'VAR=value command'.
+     */
+    environment?: pulumi.Input<{
+        [key: string]: pulumi.Input<string>;
+    }>;
+    /**
+     * If the command's stdout and stderr should be logged. This doesn't affect the capturing of
+     * stdout and stderr as outputs. If there might be secrets in the output, you can disable logging here and mark the
+     * outputs as secret via 'additionalSecretOutputs'. Defaults to logging both stdout and stderr.
+     */
+    logging?: pulumi.Input<enums.remote.Logging>;
+    /**
+     * Pass a string to the command's process as standard in
+     */
+    stdin?: pulumi.Input<string>;
+    /**
+     * Trigger a resource replacement on changes to any of these values. The
+     * trigger values can be of any type. If a value is different in the current update compared to the
+     * previous update, the resource will be replaced, i.e., the "create" command will be re-run.
+     * Please see the resource documentation for examples.
+     */
+    triggers?: pulumi.Input<any[]>;
+    /**
+     * The command to run on update, if empty, create will
+     * run again. The environment variables PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR
+     * are set to the stdout and stderr properties of the Command resource from previous
+     * create or update steps.
+     */
+    update?: pulumi.Input<string>;
+}

package/remote/command.js

@@ -0,0 +1,141 @@
+"use strict";
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Command = void 0;
+const pulumi = require("@pulumi/pulumi");
+const inputs = require("../types/input");
+const utilities = require("../utilities");
+/**
+ * A command to run on a remote host. The connection is established via ssh.
+ *
+ * ## Example Usage
+ *
+ * ### A Basic Example
+ * This program connects to a server and runs the `hostname` command. The output is then available via the `stdout` property.
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as command from "@pulumi/command";
+ *
+ * const config = new pulumi.Config();
+ * const server = config.require("server");
+ * const userName = config.require("userName");
+ * const privateKey = config.require("privateKey");
+ *
+ * const hostnameCmd = new command.remote.Command("hostnameCmd", {
+ *     create: "hostname",
+ *     connection: {
+ *         host: server,
+ *         user: userName,
+ *         privateKey: privateKey,
+ *     },
+ * });
+ * export const hostname = hostnameCmd.stdout;
+ * ```
+ *
+ * ### Triggers
+ * This example defines several trigger values of various kinds. Changes to any of them will cause `cmd` to be re-run.
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as command from "@pulumi/command";
+ * import * as random from "@pulumi/random";
+ *
+ * const str = "foo";
+ * const fileAsset = new pulumi.asset.FileAsset("Pulumi.yaml");
+ * const rand = new random.RandomString("rand", {length: 5});
+ * const localFile = new command.local.Command("localFile", {
+ *     create: "touch foo.txt",
+ *     archivePaths: ["*.txt"],
+ * });
+ * const cmd = new command.remote.Command("cmd", {
+ *     connection: {
+ *         host: "insert host here",
+ *     },
+ *     create: "echo create > op.txt",
+ *     delete: "echo delete >> op.txt",
+ *     triggers: [
+ *         str,
+ *         rand.result,
+ *         fileAsset,
+ *         localFile.archive,
+ *     ],
+ * });
+ *
+ * ```
+ */
+class Command extends pulumi.CustomResource {
+    /**
+     * Get an existing Command 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 opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name, id, opts) {
+        return new Command(name, undefined, Object.assign(Object.assign({}, opts), { id: id }));
+    }
+    /**
+     * Returns true if the given object is an instance of Command.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj) {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === Command.__pulumiType;
+    }
+    /**
+     * Create a Command 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, args, opts) {
+        var _a;
+        let resourceInputs = {};
+        opts = opts || {};
+        if (!opts.id) {
+            if ((!args || args.connection === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'connection'");
+            }
+            resourceInputs["addPreviousOutputInEnv"] = (_a = (args ? args.addPreviousOutputInEnv : undefined)) !== null && _a !== void 0 ? _a : true;
+            resourceInputs["connection"] = (args === null || args === void 0 ? void 0 : args.connection) ? pulumi.secret((args.connection ? pulumi.output(args.connection).apply(inputs.remote.connectionArgsProvideDefaults) : undefined)) : undefined;
+            resourceInputs["create"] = args ? args.create : undefined;
+            resourceInputs["delete"] = args ? args.delete : undefined;
+            resourceInputs["environment"] = args ? args.environment : undefined;
+            resourceInputs["logging"] = args ? args.logging : undefined;
+            resourceInputs["stdin"] = args ? args.stdin : undefined;
+            resourceInputs["triggers"] = args ? args.triggers : undefined;
+            resourceInputs["update"] = args ? args.update : undefined;
+            resourceInputs["stderr"] = undefined /*out*/;
+            resourceInputs["stdout"] = undefined /*out*/;
+        }
+        else {
+            resourceInputs["addPreviousOutputInEnv"] = undefined /*out*/;
+            resourceInputs["connection"] = undefined /*out*/;
+            resourceInputs["create"] = undefined /*out*/;
+            resourceInputs["delete"] = undefined /*out*/;
+            resourceInputs["environment"] = undefined /*out*/;
+            resourceInputs["logging"] = undefined /*out*/;
+            resourceInputs["stderr"] = undefined /*out*/;
+            resourceInputs["stdin"] = undefined /*out*/;
+            resourceInputs["stdout"] = undefined /*out*/;
+            resourceInputs["triggers"] = undefined /*out*/;
+            resourceInputs["update"] = undefined /*out*/;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        const secretOpts = { additionalSecretOutputs: ["connection"] };
+        opts = pulumi.mergeOptions(opts, secretOpts);
+        const replaceOnChanges = { replaceOnChanges: ["triggers[*]"] };
+        opts = pulumi.mergeOptions(opts, replaceOnChanges);
+        super(Command.__pulumiType, name, resourceInputs, opts);
+    }
+}
+exports.Command = Command;
+/** @internal */
+Command.__pulumiType = 'command:remote:Command';
+//# sourceMappingURL=command.js.map

package/remote/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../remote/command.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAGzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,MAAa,OAAQ,SAAQ,MAAM,CAAC,cAAc;IAC9C;;;;;;;OAOG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,IAAmC;QAC5F,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,SAAgB,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACpE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC;IACxD,CAAC;IA8DD;;;;;;OAMG;IACH,YAAY,IAAY,EAAE,IAAiB,EAAE,IAAmC;;QAC5E,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACV,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,cAAc,CAAC,wBAAwB,CAAC,GAAG,MAAA,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,CAAC,mCAAI,IAAI,CAAC;YACpG,cAAc,CAAC,YAAY,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/L,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAChD;aAAM;YACH,cAAc,CAAC,wBAAwB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7D,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACjD,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAClD,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9C,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC5C,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC/C,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAChD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC;QAC/D,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,MAAM,gBAAgB,GAAG,EAAE,gBAAgB,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/D,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACnD,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;;AAnIL,0BAoIC;AAvHG,gBAAgB;AACO,oBAAY,GAAG,wBAAwB,CAAC"}

package/remote/copyFile.d.ts

@@ -0,0 +1,70 @@
+import * as pulumi from "@pulumi/pulumi";
+import * as inputs from "../types/input";
+import * as outputs from "../types/output";
+/**
+ * Copy a local file to a remote host.
+ *
+ * @deprecated This resource is deprecated and will be removed in a future release. Please use the `CopyToRemote` resource instead.
+ */
+export declare class CopyFile extends pulumi.CustomResource {
+    /**
+     * Get an existing CopyFile 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 opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CopyFile;
+    /**
+     * Returns true if the given object is an instance of CopyFile.  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 CopyFile;
+    /**
+     * The parameters with which to connect to the remote host.
+     */
+    readonly connection: pulumi.Output<outputs.remote.Connection>;
+    /**
+     * The path of the file to be copied.
+     */
+    readonly localPath: pulumi.Output<string>;
+    /**
+     * The destination path in the remote host.
+     */
+    readonly remotePath: pulumi.Output<string>;
+    /**
+     * Trigger replacements on changes to this input.
+     */
+    readonly triggers: pulumi.Output<any[] | undefined>;
+    /**
+     * Create a CopyFile 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.
+     */
+    /** @deprecated This resource is deprecated and will be removed in a future release. Please use the `CopyToRemote` resource instead. */
+    constructor(name: string, args: CopyFileArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * The set of arguments for constructing a CopyFile resource.
+ */
+export interface CopyFileArgs {
+    /**
+     * The parameters with which to connect to the remote host.
+     */
+    connection: pulumi.Input<inputs.remote.ConnectionArgs>;
+    /**
+     * The path of the file to be copied.
+     */
+    localPath: pulumi.Input<string>;
+    /**
+     * The destination path in the remote host.
+     */
+    remotePath: pulumi.Input<string>;
+    /**
+     * Trigger replacements on changes to this input.
+     */
+    triggers?: pulumi.Input<any[]>;
+}

package/remote/copyFile.js

@@ -0,0 +1,79 @@
+"use strict";
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopyFile = void 0;
+const pulumi = require("@pulumi/pulumi");
+const inputs = require("../types/input");
+const utilities = require("../utilities");
+/**
+ * Copy a local file to a remote host.
+ *
+ * @deprecated This resource is deprecated and will be removed in a future release. Please use the `CopyToRemote` resource instead.
+ */
+class CopyFile extends pulumi.CustomResource {
+    /**
+     * Get an existing CopyFile 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 opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name, id, opts) {
+        pulumi.log.warn("CopyFile is deprecated: This resource is deprecated and will be removed in a future release. Please use the `CopyToRemote` resource instead.");
+        return new CopyFile(name, undefined, Object.assign(Object.assign({}, opts), { id: id }));
+    }
+    /**
+     * Returns true if the given object is an instance of CopyFile.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj) {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === CopyFile.__pulumiType;
+    }
+    /**
+     * Create a CopyFile 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.
+     */
+    /** @deprecated This resource is deprecated and will be removed in a future release. Please use the `CopyToRemote` resource instead. */
+    constructor(name, args, opts) {
+        pulumi.log.warn("CopyFile is deprecated: This resource is deprecated and will be removed in a future release. Please use the `CopyToRemote` resource instead.");
+        let resourceInputs = {};
+        opts = opts || {};
+        if (!opts.id) {
+            if ((!args || args.connection === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'connection'");
+            }
+            if ((!args || args.localPath === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'localPath'");
+            }
+            if ((!args || args.remotePath === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'remotePath'");
+            }
+            resourceInputs["connection"] = (args === null || args === void 0 ? void 0 : args.connection) ? pulumi.secret((args.connection ? pulumi.output(args.connection).apply(inputs.remote.connectionArgsProvideDefaults) : undefined)) : undefined;
+            resourceInputs["localPath"] = args ? args.localPath : undefined;
+            resourceInputs["remotePath"] = args ? args.remotePath : undefined;
+            resourceInputs["triggers"] = args ? args.triggers : undefined;
+        }
+        else {
+            resourceInputs["connection"] = undefined /*out*/;
+            resourceInputs["localPath"] = undefined /*out*/;
+            resourceInputs["remotePath"] = undefined /*out*/;
+            resourceInputs["triggers"] = undefined /*out*/;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        const secretOpts = { additionalSecretOutputs: ["connection"] };
+        opts = pulumi.mergeOptions(opts, secretOpts);
+        super(CopyFile.__pulumiType, name, resourceInputs, opts);
+    }
+}
+exports.CopyFile = CopyFile;
+/** @internal */
+CopyFile.__pulumiType = 'command:remote:CopyFile';
+//# sourceMappingURL=copyFile.js.map

package/remote/copyFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyFile.js","sourceRoot":"","sources":["../../remote/copyFile.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAGzC,0CAA0C;AAE1C;;;;GAIG;AACH,MAAa,QAAS,SAAQ,MAAM,CAAC,cAAc;IAC/C;;;;;;;OAOG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,IAAmC;QAC5F,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,8IAA8I,CAAC,CAAA;QAC/J,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,SAAgB,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACrE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,QAAQ,CAAC,YAAY,CAAC;IACzD,CAAC;IAmBD;;;;;;OAMG;IACH,uIAAuI;IACvI,YAAY,IAAY,EAAE,IAAkB,EAAE,IAAmC;QAC7E,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,8IAA8I,CAAC,CAAA;QAC/J,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACV,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,cAAc,CAAC,YAAY,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/L,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;SACjE;aAAM;YACH,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACjD,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACjD,cAAc,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAClD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC;QAC/D,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;;AAjFL,4BAkFC;AApEG,gBAAgB;AACO,qBAAY,GAAG,yBAAyB,CAAC"}

package/remote/copyToRemote.d.ts

@@ -0,0 +1,125 @@
+import * as pulumi from "@pulumi/pulumi";
+import * as inputs from "../types/input";
+import * as outputs from "../types/output";
+/**
+ * Copy an Asset or Archive to a remote host.
+ *
+ * ## Example usage
+ *
+ * This example copies a local directory to a remote host via SSH. For brevity, the remote server is assumed to exist, but it could also be provisioned in the same Pulumi program.
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import { remote, types } from "@pulumi/command";
+ * import * as fs from "fs";
+ * import * as os from "os";
+ * import * as path from "path";
+ *
+ * export = async () => {
+ *     const config = new pulumi.Config();
+ *
+ *     // Get the private key to connect to the server. If a key is
+ *     // provided, use it, otherwise default to the standard id_rsa SSH key.
+ *     const privateKeyBase64 = config.get("privateKeyBase64");
+ *     const privateKey = privateKeyBase64 ?
+ *         Buffer.from(privateKeyBase64, 'base64').toString('ascii') :
+ *         fs.readFileSync(path.join(os.homedir(), ".ssh", "id_rsa")).toString("utf8");
+ *
+ *     const serverPublicIp = config.require("serverPublicIp");
+ *     const userName = config.require("userName");
+ *
+ *     // The configuration of our SSH connection to the instance.
+ *     const connection: types.input.remote.ConnectionArgs = {
+ *         host: serverPublicIp,
+ *         user: userName,
+ *         privateKey: privateKey,
+ *     };
+ *
+ *     // Set up source and target of the remote copy.
+ *     const from = config.require("payload")!;
+ *     const archive = new pulumi.asset.FileArchive(from);
+ *     const to = config.require("destDir")!;
+ *
+ *     // Copy the files to the remote.
+ *     const copy = new remote.CopyToRemote("copy", {
+ *         connection,
+ *         source: archive,
+ *         remotePath: to,
+ *     });
+ *
+ *     // Verify that the expected files were copied to the remote.
+ *     // We want to run this after each copy, i.e., when something changed,
+ *     // so we use the asset to be copied as a trigger.
+ *     const find = new remote.Command("ls", {
+ *         connection,
+ *         create: `find ${to}/${from} | sort`,
+ *         triggers: [archive],
+ *     }, { dependsOn: copy });
+ *
+ *     return {
+ *         remoteContents: find.stdout
+ *     }
+ * }
+ * ```
+ */
+export declare class CopyToRemote extends pulumi.CustomResource {
+    /**
+     * Get an existing CopyToRemote 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 opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CopyToRemote;
+    /**
+     * Returns true if the given object is an instance of CopyToRemote.  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 CopyToRemote;
+    /**
+     * The parameters with which to connect to the remote host.
+     */
+    readonly connection: pulumi.Output<outputs.remote.Connection>;
+    /**
+     * The destination path on the remote host. The last element of the path will be created if it doesn't exist but it's an error when additional elements don't exist. When the remote path is an existing directory, the source file or directory will be copied into that directory. When the source is a file and the remote path is an existing file, that file will be overwritten. When the source is a directory and the remote path an existing file, the copy will fail.
+     */
+    readonly remotePath: pulumi.Output<string>;
+    /**
+     * An [asset or an archive](https://www.pulumi.com/docs/concepts/assets-archives/) to upload as the source of the copy. It must be path-based, i.e., be a `FileAsset` or a `FileArchive`. The item will be copied as-is; archives like .tgz will not be unpacked. Directories are copied recursively, overwriting existing files.
+     */
+    readonly source: pulumi.Output<pulumi.asset.Asset | pulumi.asset.Archive>;
+    /**
+     * Trigger replacements on changes to this input.
+     */
+    readonly triggers: pulumi.Output<any[] | undefined>;
+    /**
+     * Create a CopyToRemote 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: CopyToRemoteArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * The set of arguments for constructing a CopyToRemote resource.
+ */
+export interface CopyToRemoteArgs {
+    /**
+     * The parameters with which to connect to the remote host.
+     */
+    connection: pulumi.Input<inputs.remote.ConnectionArgs>;
+    /**
+     * The destination path on the remote host. The last element of the path will be created if it doesn't exist but it's an error when additional elements don't exist. When the remote path is an existing directory, the source file or directory will be copied into that directory. When the source is a file and the remote path is an existing file, that file will be overwritten. When the source is a directory and the remote path an existing file, the copy will fail.
+     */
+    remotePath: pulumi.Input<string>;
+    /**
+     * An [asset or an archive](https://www.pulumi.com/docs/concepts/assets-archives/) to upload as the source of the copy. It must be path-based, i.e., be a `FileAsset` or a `FileArchive`. The item will be copied as-is; archives like .tgz will not be unpacked. Directories are copied recursively, overwriting existing files.
+     */
+    source: pulumi.Input<pulumi.asset.Asset | pulumi.asset.Archive>;
+    /**
+     * Trigger replacements on changes to this input.
+     */
+    triggers?: pulumi.Input<any[]>;
+}