bulk-cdk-core-base/io.airbyte.cdk.ssh

Package-level declarations

Types

MicronautPropertiesFriendlySshTunnelMethodConfigurationSpecification

@ConfigurationProperties(value = "airbyte.connector.config.tunnel_method")

class MicronautPropertiesFriendlySshTunnelMethodConfigurationSpecification

data class SshConnectionOptions(val sessionHeartbeatInterval: Duration, val globalHeartbeatInterval: Duration, val idleTimeout: Duration)

These can be passed in the connector configuration as additional parameters.

SshKeyAuthTunnelMethod

data class SshKeyAuthTunnelMethod(@JsonPropertyDescription(value = "Hostname of the jump server host that allows inbound ssh tunnel.") val host: String, @JsonPropertyDescription(value = "Port on the proxy/jump server that accepts inbound ssh connections.") val port: Int, @JsonPropertyDescription(value = "OS-level username for logging into the jump server host") val user: String, @JsonPropertyDescription(value = "OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )") val key: String) : SshTunnelMethodConfiguration

SshNoTunnelMethod

data object SshNoTunnelMethod : SshTunnelMethodConfiguration

SshPasswordAuthTunnelMethod

data class SshPasswordAuthTunnelMethod(@JsonPropertyDescription(value = "Hostname of the jump server host that allows inbound ssh tunnel.") val host: String, @JsonPropertyDescription(value = "Port on the proxy/jump server that accepts inbound ssh connections.") val port: Int, @JsonPropertyDescription(value = "OS-level username for logging into the jump server host") val user: String, @JsonPropertyDescription(value = "OS-level password for logging into the jump server host") val password: String) : SshTunnelMethodConfiguration

SshTunnelMethodConfiguration

sealed interface SshTunnelMethodConfiguration

Union type for SSH tunnel method configuration in connector configurations.

TunnelSession

class TunnelSession : AutoCloseable

Encapsulates a possible SSH tunnel.

Properties

SSH_TIMEOUT_DISPLAY_MESSAGE

const val SSH_TIMEOUT_DISPLAY_MESSAGE: String

Functions

createTunnelSession

fun createTunnelSession(remote: SshdSocketAddress, sshTunnel: SshTunnelMethodConfiguration?, connectionOptions: SshConnectionOptions): TunnelSession

Creates an open TunnelSession.