Package software.amazon.awssdk.services.transfer.model

Interface SftpConnectorConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SftpConnectorConfig.Builder,SftpConnectorConfig>, SdkBuilder<SftpConnectorConfig.Builder,SftpConnectorConfig>, SdkPojo
Enclosing class:
SftpConnectorConfig
public static interface SftpConnectorConfig.Builder extends SdkPojo, CopyableBuilder<SftpConnectorConfig.Builder,SftpConnectorConfig>

  • Method Details

    • userSecretId

      SftpConnectorConfig.Builder userSecretId(String userSecretId)

      The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.

      Parameters:
      userSecretId - The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trustedHostKeys

      SftpConnectorConfig.Builder trustedHostKeys(Collection<String> trustedHostKeys)

      The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

      The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element. Specify only the <key type> and <body base64>: do not enter the <comment> portion of the key.

      For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

      • For RSA keys, the <key type> string is ssh-rsa.

      • For ECDSA keys, the <key type> string is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

      Parameters:
      trustedHostKeys - The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

      The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element. Specify only the <key type> and <body base64>: do not enter the <comment> portion of the key.

      For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

      • For RSA keys, the <key type> string is ssh-rsa.

      • For ECDSA keys, the <key type> string is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trustedHostKeys

      SftpConnectorConfig.Builder trustedHostKeys(String... trustedHostKeys)

      The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

      The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element. Specify only the <key type> and <body base64>: do not enter the <comment> portion of the key.

      For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

      • For RSA keys, the <key type> string is ssh-rsa.

      • For ECDSA keys, the <key type> string is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

      Parameters:
      trustedHostKeys - The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

      The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element. Specify only the <key type> and <body base64>: do not enter the <comment> portion of the key.

      For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

      • For RSA keys, the <key type> string is ssh-rsa.

      • For ECDSA keys, the <key type> string is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

      Returns:
      Returns a reference to this object so that method calls can be chained together.