command.remote.CopyFile
Copy a local file to a remote host.
Create CopyFile Resource
new CopyFile(name: string, args: CopyFileArgs, opts?: CustomResourceOptions);
@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)
@overload
def CopyFile(resource_name: str,
args: CopyFileArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args CopyFileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args CopyFileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CopyFileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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
The CopyFile resource accepts the following input properties:
- Connection
Connection
Args The parameters with which to connect to the remote host.
- Local
Path string The path of the file to be copied.
- Remote
Path string The destination path in the remote host.
- Triggers List<object>
Trigger replacements on changes to this input.
- Connection
Connection
Args The parameters with which to connect to the remote host.
- Local
Path string The path of the file to be copied.
- Remote
Path string The destination path in the remote host.
- Triggers []interface{}
Trigger replacements on changes to this input.
- connection
Connection
Args The parameters with which to connect to the remote host.
- local
Path String The path of the file to be copied.
- remote
Path String The destination path in the remote host.
- triggers List<Object>
Trigger replacements on changes to this input.
- connection
Connection
Args The parameters with which to connect to the remote host.
- local
Path string The path of the file to be copied.
- remote
Path string The destination path in the remote host.
- triggers any[]
Trigger replacements on changes to this input.
- connection
Connection
Args The parameters with which to connect to the remote host.
- local_
path str The path of the file to be copied.
- remote_
path str The destination path in the remote host.
- triggers Sequence[Any]
Trigger replacements on changes to this input.
- connection Property Map
The parameters with which to connect to the remote host.
- local
Path String The path of the file to be copied.
- remote
Path 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
- Host string
The address of the resource to connect to.
- Agent
Socket stringPath SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
- Password string
The password we should use for the connection.
- Port double
The port to connect to.
- Private
Key string The contents of an SSH key to use for the connection. This takes preference over the password if provided.
- Private
Key stringPassword The password to use in case the private key is encrypted.
- User string
The user that we should use for the connection.
- Host string
The address of the resource to connect to.
- Agent
Socket stringPath SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
- Password string
The password we should use for the connection.
- Port float64
The port to connect to.
- Private
Key string The contents of an SSH key to use for the connection. This takes preference over the password if provided.
- Private
Key stringPassword The password to use in case the private key is encrypted.
- User string
The user that we should use for the connection.
- host String
The address of the resource to connect to.
- agent
Socket StringPath SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
- password String
The password we should use for the connection.
- port Double
The port to connect to.
- private
Key String The contents of an SSH key to use for the connection. This takes preference over the password if provided.
- private
Key StringPassword The password to use in case the private key is encrypted.
- user String
The user that we should use for the connection.
- host string
The address of the resource to connect to.
- agent
Socket stringPath SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
- password string
The password we should use for the connection.
- port number
The port to connect to.
- private
Key string The contents of an SSH key to use for the connection. This takes preference over the password if provided.
- private
Key stringPassword The password to use in case the private key is encrypted.
- user string
The user that we should use for the connection.
- host str
The address of the resource to connect to.
- agent_
socket_ strpath SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
- password str
The password we should use for the connection.
- port float
The port 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_ strpassword The password to use in case the private key is encrypted.
- user str
The user that we should use for the connection.
- host String
The address of the resource to connect to.
- agent
Socket StringPath SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
- password String
The password we should use for the connection.
- port Number
The port to connect to.
- private
Key String The contents of an SSH key to use for the connection. This takes preference over the password if provided.
- private
Key StringPassword The password to use in case the private key is encrypted.
- user String
The user that we should use for the connection.
Package Details
- Repository
- command pulumi/pulumi-command
- License
- Apache-2.0