@pulumi/command
Version:
[](https://github.com/pulumi/pulumi-command/actions) [](https://slack.pulumi.com) [ • 2.69 kB
TypeScript
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[]>;
}