Class Sftp

Stedi SFTP provides a fully managed, serverless SFTP infrastructure. You can use the SFTP API to manage SFTP users.

For accessing files programmatically, you should use the Stedi Buckets SDK.

Index

Constructors

constructor

Properties

config

Methods

createUser deleteUser destroy listUsers readUser updateUser

Constructors

constructor

new Sftp(configuration: SftpClientConfig): Sftp
Parameters
- configuration: SftpClientConfig
Returns Sftp
- Defined in SftpClient.ts:247

Properties

`Readonly` config

config: SftpClientResolvedConfig

The resolved configuration of SftpClient class. This is resolved and normalized from the constructor configuration interface.

Methods

createUser

createUser(args: CreateUserCommandInput, options?: HttpHandlerOptions): Promise<CreateUserCommandOutput>
See
CreateUserCommand
Parameters
- args: CreateUserCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateUserCommandOutput>
- Defined in Sftp.ts:24
createUser(args: CreateUserCommandInput, cb: ((err: any, data?: CreateUserCommandOutput) => void)): void
Parameters
- args: CreateUserCommandInput
- cb: ((err: any, data?: CreateUserCommandOutput) => void)
  - - (err: any, data?: CreateUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateUserCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:25
createUser(args: CreateUserCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateUserCommandOutput) => void)): void
Parameters
- args: CreateUserCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateUserCommandOutput) => void)
  - - (err: any, data?: CreateUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateUserCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:26

deleteUser

deleteUser(args: DeleteUserCommandInput, options?: HttpHandlerOptions): Promise<DeleteUserCommandOutput>
See
DeleteUserCommand
Parameters
- args: DeleteUserCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteUserCommandOutput>
- Defined in Sftp.ts:35
deleteUser(args: DeleteUserCommandInput, cb: ((err: any, data?: DeleteUserCommandOutput) => void)): void
Parameters
- args: DeleteUserCommandInput
- cb: ((err: any, data?: DeleteUserCommandOutput) => void)
  - - (err: any, data?: DeleteUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteUserCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:36
deleteUser(args: DeleteUserCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteUserCommandOutput) => void)): void
Parameters
- args: DeleteUserCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteUserCommandOutput) => void)
  - - (err: any, data?: DeleteUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteUserCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:37

destroy

destroy(): void
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void
- Defined in SftpClient.ts:271

listUsers

listUsers(args: ListUsersCommandInput, options?: HttpHandlerOptions): Promise<ListUsersCommandOutput>
See
ListUsersCommand
Parameters
- args: ListUsersCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListUsersCommandOutput>
- Defined in Sftp.ts:46
listUsers(args: ListUsersCommandInput, cb: ((err: any, data?: ListUsersCommandOutput) => void)): void
Parameters
- args: ListUsersCommandInput
- cb: ((err: any, data?: ListUsersCommandOutput) => void)
  - - (err: any, data?: ListUsersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListUsersCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:47
listUsers(args: ListUsersCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListUsersCommandOutput) => void)): void
Parameters
- args: ListUsersCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListUsersCommandOutput) => void)
  - - (err: any, data?: ListUsersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListUsersCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:48

readUser

readUser(args: ReadUserCommandInput, options?: HttpHandlerOptions): Promise<ReadUserCommandOutput>
See
ReadUserCommand
Parameters
- args: ReadUserCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ReadUserCommandOutput>
- Defined in Sftp.ts:57
readUser(args: ReadUserCommandInput, cb: ((err: any, data?: ReadUserCommandOutput) => void)): void
Parameters
- args: ReadUserCommandInput
- cb: ((err: any, data?: ReadUserCommandOutput) => void)
  - - (err: any, data?: ReadUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ReadUserCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:58
readUser(args: ReadUserCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ReadUserCommandOutput) => void)): void
Parameters
- args: ReadUserCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ReadUserCommandOutput) => void)
  - - (err: any, data?: ReadUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ReadUserCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:59

updateUser

updateUser(args: UpdateUserCommandInput, options?: HttpHandlerOptions): Promise<UpdateUserCommandOutput>
See
UpdateUserCommand
Parameters
- args: UpdateUserCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateUserCommandOutput>
- Defined in Sftp.ts:68
updateUser(args: UpdateUserCommandInput, cb: ((err: any, data?: UpdateUserCommandOutput) => void)): void
Parameters
- args: UpdateUserCommandInput
- cb: ((err: any, data?: UpdateUserCommandOutput) => void)
  - - (err: any, data?: UpdateUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateUserCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:69
updateUser(args: UpdateUserCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateUserCommandOutput) => void)): void
Parameters
- args: UpdateUserCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateUserCommandOutput) => void)
  - - (err: any, data?: UpdateUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateUserCommandOutput
      
      Returns void
Returns void
- Defined in Sftp.ts:70

Class Sftp

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: SftpClientConfig

Returns Sftp

Properties

Readonly config

Methods

createUser

See

Parameters

args: CreateUserCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateUserCommandOutput>

Parameters

args: CreateUserCommandInput

cb: ((err: any, data?: CreateUserCommandOutput) => void)

Parameters

err: any

Optional data: CreateUserCommandOutput

Returns void

Returns void

Parameters

args: CreateUserCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CreateUserCommandOutput) => void)

Parameters

err: any

Optional data: CreateUserCommandOutput

Returns void

Returns void

deleteUser

See

Parameters

args: DeleteUserCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DeleteUserCommandOutput>

Parameters

args: DeleteUserCommandInput

cb: ((err: any, data?: DeleteUserCommandOutput) => void)

Parameters

err: any

Optional data: DeleteUserCommandOutput

Returns void

Returns void

Parameters

args: DeleteUserCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: DeleteUserCommandOutput) => void)

Parameters

err: any

Optional data: DeleteUserCommandOutput

Returns void

Returns void

destroy

Returns void

listUsers

See

Parameters

args: ListUsersCommandInput

Optional options: HttpHandlerOptions

Returns Promise<ListUsersCommandOutput>

Parameters

args: ListUsersCommandInput

cb: ((err: any, data?: ListUsersCommandOutput) => void)

Parameters

err: any

Optional data: ListUsersCommandOutput

Returns void

Returns void

Parameters

args: ListUsersCommandInput

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CreateUserCommandOutput

`Optional` data: CreateUserCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteUserCommandOutput

`Optional` data: DeleteUserCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: ListUsersCommandOutput

`Optional` data: ListUsersCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: ReadUserCommandOutput

`Optional` data: ReadUserCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: UpdateUserCommandOutput

`Optional` data: UpdateUserCommandOutput