Skip to main content


class connector_types.connector_type_scp.ConnectorTypeSCP

Copy a file from a SCP remote host to cloudomation or vice-versa.

This connector type uses SCP to copy a single file from a remote host to cloudomation or to copy a sigle file from cloudomation to a remote host.


You can also use this connector as an SFTP connector with limited functionality (only for file transfer, not listing or manipulating directories), as they both use port 22.

The SFTP protocol should not be confused with FTP. While similar in names, SFTP and FTP use different protocols and offer different ways of transferring files. If you want to use the FTP protocol, refer to ConnectorTypeFTP

For more on the differences between SFTP and FTP refer to Difference between FTP and SFTP


connect_timeoutNumber60How long to wait for the SSH connection to be established
copy_timeoutint60How long to wait for the copy to finish
dstStringThe path of the destination file. Use the format "cloudomation:[path]" to copy a file to cloudomation
hostkeyStringThe OpenSSH host key to validate the hosts identity
hostnameStringThe hostname or IP to use
keyStringNoneThe SSH private key to use to authenticate. Either "password" or "key" must be specified
passwordStringNoneThe password to use to authenticate. Either "password" or "key" must be specified
portNumber22The port number to connect to
srcStringThe path of the source file to copy. Use the format "cloudomation:[path]" to copy a file from cloudomation
usernameStringThe user name to use


execution_idintThe ID of the connection execution
messagestrThe ended message for the connection. If the connection ended with an error, the message will contain information about what went wrong
statusstrThe ended status for the connection. Either "success" or "error".


input_list = ['connect_timeout', 'copy_timeout', 'dst', 'hostkey', 'hostname', 'key', 'password', 'port', 'src', 'username']output_list = []ssl_context_inputs = ['check_hostname', 'client_cert', 'client_key', 'server_ca']version = 1



import flow_api

def handler(system: flow_api.System, this: flow_api.Execution):
hostkey='ssh-rsa AAAAB3NzaC1yc2E...',
key='-----BEGIN RSA PRIVATE KEY-----\nMII...',
name='copy apache error log from host',
error_log_content = system.file('apache-error.log').get_text_content()
auth_failure_count = error_log_content.count('authentication failure')
this.log(f'there are {auth_failure_count} authentication failures')

return this.success('all done')