# 詳細接続パラメータ
<a name="jdbc-v3-driver-advanced-connection-parameters"></a>

次のセクションでは、JDBC 3.x ドライバーの詳細接続パラメータについて説明します。

**Topics**
+ [結果の暗号化パラメータ](#jdbc-v3-driver-result-encryption-parameters)
+ [結果フェッチパラメータ](#jdbc-v3-driver-result-fetching-parameters)
+ [結果設定パラメータ](#jdbc-v3-driver-result-config)
+ [クエリ結果の再利用パラメータ](#jdbc-v3-driver-query-result-reuse-parameters)
+ [クエリ実行ポーリングパラメータ](#jdbc-v3-driver-query-execution-polling-parameters)
+ [エンドポイントオーバーライドパラメータ](#jdbc-v3-driver-endpoint-override-parameters)
+ [プロキシ設定パラメータ](#jdbc-v3-driver-proxy-configuration-parameters)
+ [ログパラメータ](#jdbc-v3-driver-logging-parameters)
+ [アプリケーション名](#jdbc-v3-driver-application-name)
+ [接続テスト](#jdbc-v3-driver-connection-test)
+ [再試行回数](#jdbc-v3-driver-number-of-retries)
+ [ネットワークタイムアウト](#jdbc-v3-driver-networktimeoutmillis)

## 結果の暗号化パラメータ
<a name="jdbc-v3-driver-result-encryption-parameters"></a>

以下の点に注意してください。
+ AWS KMS キーは、`EncryptionOption` が `SSE_KMS` または `CSE_KMS` の場合に指定する必要があります。
+ AWS KMS キーは、`EncryptionOption` が指定されていないか、`EncryptionOption` が `SSE_S3` の場合に指定できません。

### 暗号化オプション
<a name="jdbc-v3-driver-encryption-option"></a>

Amazon S3 に保存されている前提でクエリ結果に使用される暗号化のタイプ。クエリ結果の暗号化の詳細については、「Amazon Athena API リファレンス」の「[EncryptionConfiguration](https://docs.aws.amazon.com/athena/latest/APIReference/API_EncryptionConfiguration.html)」を参照してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 使用できる値 | 
| --- | --- | --- | --- | --- | 
| EncryptionOption | S3OutputEncOption (廃止) | オプションです。 | なし | SSE\$1S3、SSE\$1KMS、CSE\$1KMS | 

### KMS キー
<a name="jdbc-v3-driver-kms-key"></a>

KMS キーの ARN または ID (`SSE_KMS` または `CSE_KMS` が暗号化オプションとして選択されている場合)。暗号化オプションの詳細については、「Amazon Athena API リファレンス」の「[EncryptionConfiguration](https://docs.aws.amazon.com/athena/latest/APIReference/API_EncryptionConfiguration.html)」を参照してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| KmsKey | S3OutputEncKMSKey (廃止) | オプションです。 | なし | 

## 結果フェッチパラメータ
<a name="jdbc-v3-driver-result-fetching-parameters"></a>

### 結果フェッチャー
<a name="jdbc-v3-driver-result-fetcher"></a>

クエリ結果のダウンロードに使用されるフェッチャー。

デフォルトの結果フェッチャーの `auto` は、Athena API を使用せずに Amazon S3 から直接クエリ結果をダウンロードします。S3 の直接ダウンロードを行うことができない場合 (クエリ結果が `CSE_KMS` オプションで暗号化されている場合など)、自動的にフォールバックして `GetQueryResultsStream` API が使用されます。

ほとんどの場合、`auto` フェッチャーを使用することをお勧めします。IAM ポリシーまたは S3 バケットポリシーが [s3:CalledVia](security-iam-athena-calledvia.md) 条件を使用して Athena からの S3 オブジェクトリクエストへのアクセスを制限する場合、`auto` フェッチャーは最初に S3 からの結果のダウンロードを試行し、その後にフォールバックして `GetQueryResultsStream` API を使用します。この場合、追加の API コールを回避するために ResultFetcher を `GetQueryResultsStream` に設定できます。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 使用できる値 | 
| --- | --- | --- | --- | --- | 
| ResultFetcher | なし | オプションです。 | 自動 | auto、S3、GetQueryResults、GetQueryResultsStream | 

### フェッチサイズ
<a name="jdbc-v3-driver-fetch-size"></a>

このパラメータの値は、内部バッファの最小値として使用され、結果をフェッチする際のターゲットページサイズとして使用されます。0 (ゼロ) の値は、ドライバーは以下で説明するデフォルト値を使用する必要があることを意味します。最大値は 1,000,000 です。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| FetchSize | RowsToFetchPerBlock (廃止) | オプションです。 | 0 | 
+ `GetQueryResults` フェッチャーは API 呼び出しでサポートされる最大値である 1,000 のページサイズを常に使用します。フェッチサイズが 1,000 を超えると、最小サイズを超えるバッファを埋めるために連続して複数の API 呼び出しが行われます。
+ `GetQueryResultsStream` フェッチャーは、設定されたフェッチサイズをページサイズとして使用するか、デフォルトの 10,000 を使用します。
+ `S3` フェッチャーは、設定されたフェッチサイズをページサイズとして使用するか、デフォルトの 10,000 を使用します。

## 結果設定パラメータ
<a name="jdbc-v3-driver-result-config"></a>

### 予想されるバケット所有者
<a name="jdbc-v3-driver-exp-bucket-owner"></a>

想定される S3 バケット所有者のアカウント ID。指定したアカウント ID がバケットの実際の所有者と一致しない場合、このリクエストは失敗します。s3 バケット所有者の検証の詳細については、「[バケットの所有権の検証](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-owner-condition.html#bucket-owner-condition-use)」を参照してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| ExpectedBucketOwner | なし | オプションです。 | なし | 

### Acl オプション
<a name="jdbc-v3-driver-acl"></a>

Amazon S3 の既定 ACL を設定して、保存されたクエリ結果の所有権を制御する必要があることを示します。`AclOption` に関する詳細については、「[AclConfiguration](https://docs.aws.amazon.com/athena/latest/APIReference/API_AclConfiguration.html)」を参照してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 使用できる値 | 
| --- | --- | --- | --- | --- | 
| AclOption | なし | オプションです。 | なし | BUCKET\$1OWNER\$1FULL\$1CONTROL | 

## クエリ結果の再利用パラメータ
<a name="jdbc-v3-driver-query-result-reuse-parameters"></a>

### 結果の再利用を有効にする
<a name="jdbc-v3-driver-enable-result-reuse"></a>

クエリ実行時に同じクエリによる以前の結果を再利用できるかどうかを指定します。クエリ結果の再利用の詳細については、「[ResultReuseByAgeConfiguration](https://docs.aws.amazon.com/athena/latest/APIReference/API_ResultReuseByAgeConfiguration.html)」を参照してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| EnableResultReuseByAge | なし | オプションです。 | FALSE | 

### 結果再利用の最大有効期間
<a name="jdbc-v3-driver-result-reuse-max-age"></a>

Athena が再利用を考慮するべき以前のクエリ結果の最大有効期間 (分単位)。結果再利用の最大有効期間の詳細については、「[ResultReuseByAgeConfiguration](https://docs.aws.amazon.com/athena/latest/APIReference/API_ResultReuseByAgeConfiguration.html)」を参照してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| MaxResultReuseAgeInMinutes | なし | オプションです。 | 60 | 

## クエリ実行ポーリングパラメータ
<a name="jdbc-v3-driver-query-execution-polling-parameters"></a>

### クエリ実行の最小ポーリング間隔
<a name="jdbc-v3-driver-minimum-query-execution-polling-interval"></a>

Athena にクエリ実行ステータスをポーリングする前に待機する最小時間 (ミリ秒単位)。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| MinQueryExecutionPollingIntervalMillis | MinQueryExecutionPollingInterval (廃止) | オプションです。 | 100 | 

### クエリ実行の最大ポーリング間隔
<a name="jdbc-v3-driver-maximum-query-execution-polling-interval"></a>

Athena にクエリ実行ステータスをポーリングする前に待機する最大時間 (ミリ秒単位)。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| MaxQueryExecutionPollingIntervalMillis | MaxQueryExecutionPollingInterval (廃止) | オプションです。 | 5000 | 

### クエリ実行ポーリング間隔の乗数
<a name="jdbc-v3-driver-query-execution-polling-interval-multiplier"></a>

ポーリング期間を延長する要素。デフォルトでは、ポーリングは `MinQueryExecutionPollingIntervalMillis` の値から始まり、`MaxQueryExecutionPollingIntervalMillis` の値に達するまでポーリングごとに倍増します。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| QueryExecutionPollingIntervalMultiplier | なし | オプションです。 | 2 | 

## エンドポイントオーバーライドパラメータ
<a name="jdbc-v3-driver-endpoint-override-parameters"></a>

### Athena エンドポイントオーバーライド
<a name="jdbc-v3-driver-athena-endpoint-override"></a>

ドライバーが Athena に API 呼び出しを行うために使用するエンドポイント。

以下の点に注意してください。
+ 提示された URL に `https://` または `http://` プロトコルが指定されていない場合、ドライバーは `https://` プレフィックスを挿入します。
+ このパラメータが指定されていない場合、ドライバーはデフォルトエンドポイントを使用します。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| AthenaEndpoint | EndpointOverride (廃止) | オプションです。 | なし | 

### Athena ストリーミングサービスエンドポイントのオーバーライド
<a name="jdbc-v3-driver-athena-streaming-service-endpoint-override"></a>

ドライバーが Athena ストリーミングサービスを使用するとき、クエリ結果をダウンロードするために使用するエンドポイント。Athena ストリーミングサービスはポート 444 で利用できます。

以下の点に注意してください。
+ 提示された URL に `https://` または `http://` プロトコルが指定されていない場合、ドライバーは `https://` プレフィックスを挿入します。
+ 提示された URL にポートが指定されていない場合、ドライバーはストリーミングサービスのポート 444 を挿入します。
+ `AthenaStreamingEndpoint` パラメータが指定されていない場合、ドライバーは `AthenaEndpoint` オーバーライドを使用します。`AthenaStreamingEndpoint` オーバーライドも、`AthenaEndpoint` オーバーライドも指定されていない場合、ドライバーはデフォルトのストリーミングエンドポイントを使用します。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| AthenaStreamingEndpoint | StreamingEndpointOverride (廃止) | オプションです。 | なし | 

### LakeFormation エンドポイントオーバーライド
<a name="jdbc-v3-driver-athena-lake-formation-endpoint-override"></a>

AWS Lake Formation [AssumeDecoratedRoleWithSAML](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_AssumeDecoratedRoleWithSAML.html) API を使用して一時的な認証情報を取得するとき、ドライバーが Lake Formation サービスに使用するエンドポイント。このパラメータが指定されていない場合、ドライバーはデフォルトの Lake Formation エンドポイントを使用します。

以下の点に注意してください。
+ 提示された URL に `https://` または `http://` プロトコルが指定されていない場合、ドライバーは `https://` プレフィックスを挿入します。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| LakeFormationEndpoint |  LfEndpointOverride (廃止)  | オプションです。 | なし | 

### S3 エンドポイントオーバーライド
<a name="jdbc-v3-driver-athena-s3-endpoint-override"></a>

ドライバーが Amazon S3 フェッチャーを使用するとき、クエリ結果をダウンロードするために使用するエンドポイント。このパラメータが指定されていない場合、ドライバーはデフォルトの Amazon S3 エンドポイントを使用します。

以下の点に注意してください。
+ 提示された URL に `https://` または `http://` プロトコルが指定されていない場合、ドライバーは `https://` プレフィックスを挿入します。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| S3Endpoint | なし | オプションです。 | なし | 

### STS エンドポイントオーバーライド
<a name="jdbc-v3-driver-athena-sts-endpoint-override"></a>

AWS STS[AssumeRoleWithSAML](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithSAML.html) API を使用して一時的な認証情報を取得するとき、ドライバーが AWS STS サービスに使用するエンドポイント。このパラメータが指定されていない場合、ドライバーはデフォルトの AWS STS エンドポイントを使用します。

以下の点に注意してください。
+ 提示された URL に `https://` または `http://` プロトコルが指定されていない場合、ドライバーは `https://` プレフィックスを挿入します。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| StsEndpoint | StsEndpointOverride (廃止) | オプションです。 | なし | 

### SSO OIDC エンドポイントのオーバーライド
<a name="jdbc-v3-driver-athena-sso-oidc-endpoint-override"></a>

ドライバーが `ClientConfiguration.endpointOverride` を使用して SSO OIDC クライアントのデフォルトの HTTP エンドポイントをオーバーライドするときに使用するエンドポイント。詳細については、「[ClientConfiguration](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/client-config.html)」を参照してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| SSOOIDCEndpointOverride |  | オプションです。 | なし | 

### SSO Admin エンドポイントのオーバーライド
<a name="jdbc-v3-driver-athena-sso-admin-endpoint-override"></a>

ドライバーが `ClientConfiguration.endpointOverride` を使用して SSO Admin クライアントのデフォルトの HTTP エンドポイントをオーバーライドするときに使用するエンドポイント。詳細については、「[ClientConfiguration](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/client-config.html)」を参照してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| SSOAdminEndpointOverride |  | オプションです。 | なし | 

## プロキシ設定パラメータ
<a name="jdbc-v3-driver-proxy-configuration-parameters"></a>

### プロキシのホスト
<a name="jdbc-v3-driver-proxy-host"></a>

プロキシホストの URL。Athena がプロキシ経由でリクエストする必要がある場合、このパラメータを使用してください。

**注記**  
 `ProxyHost` の URL の先頭には必ずプロトコル `https://` または `http://` を含めてください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| ProxyHost | なし | オプションです。 | なし | 

### プロキシのポート
<a name="jdbc-v3-driver-proxy-port"></a>

プロキシホストで使用するポート。Athena がプロキシ経由でリクエストする必要がある場合、このパラメータを使用してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| ProxyPort | なし | オプションです。 | なし | 

### プロキシユーザー名
<a name="jdbc-v3-driver-proxy-username"></a>

プロキシサーバーで認証するユーザー名。Athena がプロキシ経由でリクエストする必要がある場合、このパラメータを使用してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| ProxyUsername | ProxyUID (廃止) | オプションです。 | なし | 

### プロキシのパスワード
<a name="jdbc-v3-driver-proxy-password"></a>

プロキシサーバーで認証するパスワード。Athena がプロキシ経由でリクエストする必要がある場合、このパラメータを使用してください。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| ProxyPassword | ProxyPWD (廃止) | オプションです。 | なし | 

### プロキシ免除ホスト
<a name="jdbc-v3-driver-proxy-exempt-hosts"></a>

プロキシが有効になっているとき (すなわち、`ProxyHost` および `ProxyPort` 接続パラメータが設定されているとき)、ドライバがプロキシを使わずに接続する一連のホスト名。ホストはパイプ (`|`) 文字で区切る必要があります (例えば、`host1.com|host2.com`)。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| ProxyExemptHosts | NonProxyHosts | オプションです。 | なし | 

### ID プロバイダー用に有効になっているプロキシ
<a name="jdbc-v3-driver-proxy-enabled-for-identity-providers"></a>

ドライバーが ID プロバイダーに接続するとき、プロキシを使用するかどうかを指定します。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| ProxyEnabledForIdP | UseProxyForIdP | オプションです。 | FALSE | 

## ログパラメータ
<a name="jdbc-v3-driver-logging-parameters"></a>

このセクションでは、ログに関連するパラメータについて説明します。

### ログレベル
<a name="jdbc-v3-driver-logging-parameters-log-level"></a>

ドライバーログのレベルを指定します。`LogPath` パラメータも設定しない限り、何もログされません。

**注記**  
特別な要件がない限り、`LogPath` パラメータのみを設定することをお勧めします。`LogPath` パラメータのみを設定すると、ロギングが有効になってデフォルトの `TRACE` ログレベルが使用されます。`TRACE` ログレベルは最も詳細なログを提供します。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 使用できる値 | 
| --- | --- | --- | --- | --- | 
| LogLevel | なし | オプションです。 | TRACE | OFF、ERROR、WARN、INFO、DEBUG、TRACE | 

### ログパス
<a name="jdbc-v3-driver-logging-parameters-log-path"></a>

ドライバーログが保存されるドライバーを実行するコンピューター上のディレクトリへのパス。一意の名前のログファイルが指定したディレクトリ内に作成されます。設定すると、ドライバーログが有効になります。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| LogPath | なし | オプションです。 | なし | 

## アプリケーション名
<a name="jdbc-v3-driver-application-name"></a>

ドライバーを使用するアプリケーションの名前。このパラメータの値を指定すると、その値はドライバーが Athena に対して行う API 呼び出しのユーザーエージェント文字列に含まれます。

**注記**  
`DataSource` オブジェクトの `setApplicationName` を呼び出すことにより、アプリケーション名を設定することもできます。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| ApplicationName | なし | オプションです。 | なし | 

## 接続テスト
<a name="jdbc-v3-driver-connection-test"></a>

`TRUE` に設定すると、JDBC 接続でクエリが実行されなくても、ドライバは JDBC 接続が作成されるたびに接続テストを実行します。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| ConnectionTest | なし | オプションです。 | TRUE | 

**注記**  
接続テストでは `SELECT 1` クエリを Athena に送信し、接続が正しく設定されていることを確認します。すなわち、2 つのファイルが Amazon S3 (結果セットおよびメタデータ) に保存され、「[Amazon Athena 料金表](https://aws.amazon.com/athena/pricing)」ポリシーに従って追加料金が適用される場合があります。

## 再試行回数
<a name="jdbc-v3-driver-number-of-retries"></a>

ドライバーが再実行可能なリクエストを Athena に再送信するべき最大回数。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
| NumRetries | MaxErrorRetry (廃止) | オプションです。 | なし | 

## ネットワークタイムアウト
<a name="jdbc-v3-driver-networktimeoutmillis"></a>

ネットワークタイムアウトは、ドライバーがネットワーク接続が確立されるまで待機する時間を制御します。これには、API リクエストの送信にかかる時間が含まれます。まれに、ネットワークタイムアウトを変更すると利便性が向上することがあります。例えば、ガベージコレクションの一時停止の際のタイムアウトを増やすことができます。この接続パラメータの設定は、 `Connection` オブジェクトでの `setNetworkTimeout` メソッドの使用と同等です。


****  

| パラメータ名 | エイリアス | パラメータタイプ | デフォルトの値 | 
| --- | --- | --- | --- | 
|  NetworkTimeoutMillis  | なし | オプションです。 | なし |