Skip to content

SftpPortWithOptions

Source code in docs_src/capo_transfer/types/sftp_port_with_options.py
class SftpPortWithOptions(TypedDict, closed=True):
    sftp_port: "capo_transfer.types.sftp_port.SftpPort"
    """<p>The port on which the Transfer Family server listens for SFTP connections. Specify any integer from 2000 to 65535, or 22. This value is required for each entry in the <code>SftpPorts</code> list.</p>"""
    communication_mode: NotRequired[
        "capo_transfer.types.communication_mode.CommunicationMode"
    ]
    """<p>Determines whether the server or the client sends data first when a client establishes an SFTP connection on this port. Valid values are <code>SERVER_TALK_FIRST</code> and <code>CLIENT_TALK_FIRST</code>. For a description of each mode, see the <code>SftpPorts</code> property. This value is optional.</p>"""

communication_mode instance-attribute

communication_mode: NotRequired[CommunicationMode]

Determines whether the server or the client sends data first when a client establishes an SFTP connection on this port. Valid values are SERVER_TALK_FIRST and CLIENT_TALK_FIRST. For a description of each mode, see the SftpPorts property. This value is optional.

sftp_port instance-attribute

sftp_port: SftpPort

The port on which the Transfer Family server listens for SFTP connections. Specify any integer from 2000 to 65535, or 22. This value is required for each entry in the SftpPorts list.