View a markdown version of this page

Proxy options - Amazon Athena
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Proxy options

Proxy host

If you require users to go through a proxy, use this parameter to set the proxy host. This parameter corresponds to the ClientConfiguration.proxyHost parameter in the Amazon SDK. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

Connection string name Parameter type Default value Connection string example
ProxyHost Optional none ProxyHost=127.0.0.1;

Proxy port

Use this parameter to set the proxy port. This parameter corresponds to the ClientConfiguration.proxyPort parameter in the Amazon SDK. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

Connection string name Parameter type Default value Connection string example
ProxyPort Optional none ProxyPort=8888;

Proxy user name

Use this parameter to set the proxy user name. This parameter corresponds to the ClientConfiguration.proxyUserName parameter in the Amazon SDK. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

Connection string name Parameter type Default value Connection string example
ProxyUID Optional none ProxyUID=username;

Proxy password

Use this parameter to set the proxy password. This parameter corresponds to the ClientConfiguration.proxyPassword parameter in the Amazon SDK. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

Connection string name Parameter type Default value Connection string example
ProxyPWD Optional none ProxyPWD=password;

Non proxy host

Use this optional parameter to specify a host that the driver connects to without using a proxy. This parameter corresponds to the ClientConfiguration.nonProxyHosts parameter in the Amazon SDK. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

The driver passes this value to the Amazon SDK client configuration and applies it to HTTP clients that the SDK creates internally. On Linux and macOS, the SDK forwards the value to the CURLOPT_NOPROXY curl option. For information about the CURLOPT_NOPROXY format, see CURLOPT_NOPROXY in the curl documentation.

Windows behavior

In driver version 2.4.0.0, this parameter has no effect on Windows. The Windows HTTP client does not apply a proxy bypass list, so the driver routes all traffic through the proxy that you specify in ProxyHost.

Connection string name Parameter type Default value Connection string example
NonProxyHost Optional none. See Windows behavior. NonProxyHost=.amazonaws.com,localhost,.example.net,.example.com;

Use proxy

Enables the specified proxy for Amazon SDK service clients and HTTP clients that the Amazon SDK creates internally. In driver version 2.4.0.0, the driver also applies this proxy to both driver-owned and SDK-created identity provider HTTP clients, even when UseProxyForIdP is set to 0.

Process-wide settings for concurrent connections

Proxy and CA settings applied to SDK-created clients are process-wide. If you use different DSNs for multiple connections at the same time, the settings from your most recently initialized connection apply to subsequently created SDK-internal HTTP clients.

Connection string name Parameter type Default value Connection string example
UseProxy Optional none UseProxy=1;