Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Command
  3. API Docs
  4. remote
  5. CopyFile
Command v1.0.2 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-command

command.remote.CopyFile

Explore with Pulumi AI

Command v1.0.2 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-command
Deprecated: This resource is deprecated and will be removed in a future release. Please use the CopyToRemote resource instead.

Copy a local file to a remote host.

Create CopyFile Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CopyFile(name: string, args: CopyFileArgs, opts?: CustomResourceOptions);
@overload
def CopyFile(resource_name: str,
             args: CopyFileArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def CopyFile(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             connection: Optional[ConnectionArgs] = None,
             local_path: Optional[str] = None,
             remote_path: Optional[str] = None,
             triggers: Optional[Sequence[Any]] = None)
func NewCopyFile(ctx *Context, name string, args CopyFileArgs, opts ...ResourceOption) (*CopyFile, error)
public CopyFile(string name, CopyFileArgs args, CustomResourceOptions? opts = null)
public CopyFile(String name, CopyFileArgs args)
public CopyFile(String name, CopyFileArgs args, CustomResourceOptions options)

type: command:remote:CopyFile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CopyFileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CopyFileArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CopyFileArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CopyFileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CopyFileArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CopyFile Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CopyFile resource accepts the following input properties:

Connection This property is required. Connection
The parameters with which to connect to the remote host.
LocalPath This property is required. string
The path of the file to be copied.
RemotePath This property is required. string
The destination path in the remote host.
Triggers List<object>
Trigger replacements on changes to this input.
Connection This property is required. ConnectionArgs
The parameters with which to connect to the remote host.
LocalPath This property is required. string
The path of the file to be copied.
RemotePath This property is required. string
The destination path in the remote host.
Triggers []interface{}
Trigger replacements on changes to this input.
connection This property is required. Connection
The parameters with which to connect to the remote host.
localPath This property is required. String
The path of the file to be copied.
remotePath This property is required. String
The destination path in the remote host.
triggers List<Object>
Trigger replacements on changes to this input.
connection This property is required. Connection
The parameters with which to connect to the remote host.
localPath This property is required. string
The path of the file to be copied.
remotePath This property is required. string
The destination path in the remote host.
triggers any[]
Trigger replacements on changes to this input.
connection This property is required. ConnectionArgs
The parameters with which to connect to the remote host.
local_path This property is required. str
The path of the file to be copied.
remote_path This property is required. str
The destination path in the remote host.
triggers Sequence[Any]
Trigger replacements on changes to this input.
connection This property is required. Property Map
The parameters with which to connect to the remote host.
localPath This property is required. String
The path of the file to be copied.
remotePath This property is required. String
The destination path in the remote host.
triggers List<Any>
Trigger replacements on changes to this input.

Outputs

All input properties are implicitly available as output properties. Additionally, the CopyFile resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

Connection
, ConnectionArgs

Host This property is required. string
The address of the resource to connect to.
AgentSocketPath string
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
DialErrorLimit int
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
Password string
The password we should use for the connection.
PerDialTimeout int
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
Port double
The port to connect to. Defaults to 22.
PrivateKey string
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
PrivateKeyPassword string
The password to use in case the private key is encrypted.
Proxy ProxyConnection
The connection settings for the bastion/proxy host.
User string
The user that we should use for the connection.
Host This property is required. string
The address of the resource to connect to.
AgentSocketPath string
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
DialErrorLimit int
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
Password string
The password we should use for the connection.
PerDialTimeout int
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
Port float64
The port to connect to. Defaults to 22.
PrivateKey string
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
PrivateKeyPassword string
The password to use in case the private key is encrypted.
Proxy ProxyConnection
The connection settings for the bastion/proxy host.
User string
The user that we should use for the connection.
host This property is required. String
The address of the resource to connect to.
agentSocketPath String
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
dialErrorLimit Integer
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
password String
The password we should use for the connection.
perDialTimeout Integer
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
port Double
The port to connect to. Defaults to 22.
privateKey String
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
privateKeyPassword String
The password to use in case the private key is encrypted.
proxy ProxyConnection
The connection settings for the bastion/proxy host.
user String
The user that we should use for the connection.
host This property is required. string
The address of the resource to connect to.
agentSocketPath string
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
dialErrorLimit number
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
password string
The password we should use for the connection.
perDialTimeout number
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
port number
The port to connect to. Defaults to 22.
privateKey string
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
privateKeyPassword string
The password to use in case the private key is encrypted.
proxy ProxyConnection
The connection settings for the bastion/proxy host.
user string
The user that we should use for the connection.
host This property is required. str
The address of the resource to connect to.
agent_socket_path str
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
dial_error_limit int
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
password str
The password we should use for the connection.
per_dial_timeout int
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
port float
The port to connect to. Defaults to 22.
private_key str
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
private_key_password str
The password to use in case the private key is encrypted.
proxy ProxyConnection
The connection settings for the bastion/proxy host.
user str
The user that we should use for the connection.
host This property is required. String
The address of the resource to connect to.
agentSocketPath String
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
dialErrorLimit Number
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
password String
The password we should use for the connection.
perDialTimeout Number
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
port Number
The port to connect to. Defaults to 22.
privateKey String
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
privateKeyPassword String
The password to use in case the private key is encrypted.
proxy Property Map
The connection settings for the bastion/proxy host.
user String
The user that we should use for the connection.

ProxyConnection
, ProxyConnectionArgs

Host This property is required. string
The address of the bastion host to connect to.
AgentSocketPath string
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
DialErrorLimit int
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
Password string
The password we should use for the connection to the bastion host.
PerDialTimeout int
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
Port double
The port of the bastion host to connect to.
PrivateKey string
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
PrivateKeyPassword string
The password to use in case the private key is encrypted.
User string
The user that we should use for the connection to the bastion host.
Host This property is required. string
The address of the bastion host to connect to.
AgentSocketPath string
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
DialErrorLimit int
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
Password string
The password we should use for the connection to the bastion host.
PerDialTimeout int
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
Port float64
The port of the bastion host to connect to.
PrivateKey string
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
PrivateKeyPassword string
The password to use in case the private key is encrypted.
User string
The user that we should use for the connection to the bastion host.
host This property is required. String
The address of the bastion host to connect to.
agentSocketPath String
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
dialErrorLimit Integer
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
password String
The password we should use for the connection to the bastion host.
perDialTimeout Integer
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
port Double
The port of the bastion host to connect to.
privateKey String
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
privateKeyPassword String
The password to use in case the private key is encrypted.
user String
The user that we should use for the connection to the bastion host.
host This property is required. string
The address of the bastion host to connect to.
agentSocketPath string
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
dialErrorLimit number
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
password string
The password we should use for the connection to the bastion host.
perDialTimeout number
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
port number
The port of the bastion host to connect to.
privateKey string
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
privateKeyPassword string
The password to use in case the private key is encrypted.
user string
The user that we should use for the connection to the bastion host.
host This property is required. str
The address of the bastion host to connect to.
agent_socket_path str
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
dial_error_limit int
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
password str
The password we should use for the connection to the bastion host.
per_dial_timeout int
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
port float
The port of the bastion host to connect to.
private_key str
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
private_key_password str
The password to use in case the private key is encrypted.
user str
The user that we should use for the connection to the bastion host.
host This property is required. String
The address of the bastion host to connect to.
agentSocketPath String
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
dialErrorLimit Number
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
password String
The password we should use for the connection to the bastion host.
perDialTimeout Number
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
port Number
The port of the bastion host to connect to.
privateKey String
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
privateKeyPassword String
The password to use in case the private key is encrypted.
user String
The user that we should use for the connection to the bastion host.

Package Details

Repository
command pulumi/pulumi-command
License
Apache-2.0
Command v1.0.2 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-command