Location Connection for Amazon S3
This section describes the connection parameters required for creating Amazon S3 location in Fivetran HVR. For information about the pre-requisites, access privileges, and other configuration requirements for creating Amazon S3 location, see Amazon S3 Requirements.
If the managed secrets feature is enabled, option USE TOKEN INSTEAD is displayed in the fields designated for entering secrets.
Field | Description | Equivalent Location Property |
---|---|---|
SECURE CONNECTION | Protocol for connecting HVR to the Amazon S3 server. Available options are:
| File_Scheme |
BUCKET | Name or IP address of the Amazon S3 bucket. | S3_Bucket |
Credentials | Authentication mode for connecting HVR to Amazon S3 using IAM User Access Keys (KEY ID and SECRET KEY). For more information about Access Keys, refer to Understanding and Getting Your Security Credentials in AWS documentation. | |
KEY ID | Access key ID of IAM user for connecting HVR to Amazon S3. This field is enabled only if Credentials is selected. | AWS_Access_Key_Id |
SECRET KEY | Secret access key of IAM user for connecting HVR to Amazon S3. This field is enabled only if Credentials is selected. | AWS_Secret_Access_Key |
DIRECTORY | Directory path in the Amazon S3 BUCKET where the files are replicated to or captured from. | File_Path |
Instance Profile | Authentication mode for connecting HVR to Amazon S3 using AWS Identity and Access Management (IAM) Role. This option can be used only if the HVR Agent or the HVR Hub is running inside the AWS network on an EC2 instance and the AWS IAM role specified here should be attached to this EC2 instance. When a role is used, HVR obtains temporary Access Keys Pair from the EC2 machine. For more information about IAM Role, refer to IAM Roles in AWS documentation. | |
IAM ROLE | AWS IAM role name for connecting HVR to Amazon S3. This field is enabled only if Instance Profile is selected. | AWS_IAM_Role |
Proxy | Enable/Disable the configuration for proxy server, which is used for connecting HVR to the Amazon S3 server. | |
Hive External Tables | Enable/Disable Hive ODBC connection configuration for Hive external tables created above Amazon S3. |
Configuration for Proxy Server
This section lists and describes the connection details required for the proxy server, which is used for connecting HVR to the Amazon S3 server.
Field | Description | Equivalent Location Property |
---|---|---|
PROXY PROTOCOL | Protocol for the proxy server host used for connecting HVR to the Amazon S3 server. Available options are:
| File_Proxy_Scheme |
PROXY HOST | Host name of the proxy server used for connecting HVR to the Amazon S3 server. | File_Proxy_Host |
PROXY PORT | Port number for the proxy server host used for connecting HVR to the Amazon S3 server. | File_Proxy_Port |
PROXY USER | Username for the proxy server host used for connecting HVR to the Amazon S3 server. | File_Proxy_User |
PROXY PASSWORD | Password for the PROXY USER. | File_Proxy_Password |
Configuration for Hive External Tables
This section lists and describes the connection parameters required for connecting HVR to the Hive External Tables created above Amazon S3.
HVR allows you to create Hive External Tables above Amazon S3, which are only used for comparing files residing on the Amazon S3 location. You can enable/disable the Hive configuration for Amazon S3 in location creation screen using the field Hive External Tables. HVR uses the Hive ODBC driver for connecting to Hive external tables above Amazon S3.
Field | Description | Equivalent Location Property |
---|---|---|
HIVE SERVER TYPE | Type of the Hive server. Available options are:
| Hive_Server_Type |
HOST(S) | Hostname or IP-address of the server on which the database is running. | Database_Host |
PORT | Port number on which the Hive server is expecting connections. | Database_Port |
DATABASE | Name of the database. | Database_Name |
SERVICE DISCOVERY MODE | Mode for connecting HVR to Hive Server 2. This field is enabled only if HIVE SERVER TYPE is set to 2. Available options are:
| Hive_Service_Discovery_Mode |
ZOOKEEPER NAMESPACE | Namespace on ZooKeeper under which Hive Server 2 nodes are added. This field is enabled only if SERVICE DISCOVERY MODE is set to ZooKeeper. | Hive_Zookeeper_Namespace |
AUTHENTICATION METHOD | Authentication method for connecting HVR to Hive Server 2. This field is enabled only if HIVE SERVER TYPE is set to 2. Available options are:
| Hive_Authentication_Method |
USER | Username for connecting HVR to the database (defined in Database_Name). This field is enabled only when the AUTHENTICATION METHOD is set to User Name or User Name and Password. | Database_User |
PASSWORD | Password for the USER. | Database_Password |
SERVICE | Kerberos service principal name of the Hive server. This is the service name part of Kerberos principal of the Hive server. For example, if the principal is hive/example.host@EXAMPLE.REALM then "hive" should be specified here. This field is enabled only if AUTHENTICATION METHOD is set to Kerberos. | Hive_Kerberos_Service |
HOST | Fully Qualified Domain Name (FQDN) of the Hive server host. This is the host part of Kerberos principal of the Hive server. For example, if the principal is "hive/example.host@EXAMPLE.REALM" then "example.host" should be specified here. The value for this field may be set to _HOST to use the Hive server hostname as the domain name for Kerberos authentication. If SERVICE DISCOVERY MODE is set to None, then the driver uses the value specified in the Host connection attribute. | Hive_Kerberos_Host |
REALM | Realm of the Hive Server 2 host. It is not required to specify any value in this field if the realm of the Hive Server 2 host is defined as the default realm in Kerberos configuration. This field is enabled only if AUTHENTICATION METHOD is set to Kerberos. | Hive_Kerberos_Realm |
THRIFT TRANSPORT | Transport protocol to use in the Thrift layer. This field is enabled only if HIVE SERVER TYPE is set to Hive Server 2. Available options are:
| Hive_Thrift_Transport |
HTTP PATH | The partial URL corresponding to the Hive server. This field is required only if THRIFT TRANSPORT is set to HTTP. | Hive_HTTP_Path |
Enable SSL | Enable/disable (one way) SSL. If enabled, HVR authenticates the Hive server by validating the SSL certificate shared by the Hive server. | |
TRUSTED CA CERTIFICATE | Directory path where the .pem file containing the server's public SSL certificate signed by a trusted CA is located. Defining this property will enable (one way) SSL, which means, HVR will authenticate the Hive server by validating the SSL certificate shared by the Hive server. This property is also required for enabling two way SSL. | Database_Public_Certificate |
Two-way SSL | Enable/disable two way SSL. If enabled, both HVR and Hive server authenticate each other by validating each others SSL certificate. This field is enabled only if Enable SSL is selected. | |
CLIENT PUBLIC CERTIFICATE | Directory path where the .pem file containing the client's SSL public certificate is located. This field is enabled only if Two-way SSL is selected. | Database_Client_Public_Certificate |
CLIENT PRIVATE KEY | Directory path where the .pem file containing the client's SSL private key is located. This field is enabled only if Two-way SSL is selected. | Database_Client_Private_Key |
CLIENT PRIVATE KEY PASSWORD | Password of the client's SSL private key specified in CLIENT PRIVATE KEY. This field is enabled only if Two-way SSL is selected. | Database_Client_Private_Key_Password |
Hive Advanced Settings
Field | Description | Equivalent Location Property |
---|---|---|
LINUX / UNIX ODBC DRIVER MANAGER LIBRARY PATH | Directory path where the ODBC Driver Manager Library is installed. This field is applicable only for Linux/Unix operating system. For a default installation, the ODBC Driver Manager Library is available at /usr/lib64 and does not need to be specified. However, when UnixODBC is installed in for example /opt/unixodbc the value for this field would be /opt/unixodbc/lib. | ODBC_DM_Lib_Path |
LINUX / UNIX ODBCSYSINI | Directory path where the odbc.ini and odbcinst.ini files are located. This field is applicable only for Linux/Unix operating system. For a default installation, these files are available at /etc directory and do not need to be specified using this field. However, when UnixODBC is installed in for example /opt/unixodbc the value for this field would be /opt/unixodbc/etc. | ODBC_Sysini |
ODBC Driver | Name of the user defined (installed) ODBC driver used for connecting HVR to the Hive server. | ODBC_Driver |