JDBC ドライバーバージョン 2.1 の設定オプション - Amazon Redshift
AccessKeyIDAllowDBUserOverrideApp_IDApp_NameApplicationNameAuthProfileAutoCreateClient_IDClient_SecretClusterID圧縮connectTimeoutconnectionTimezonedatabaseMetadataCurrentDbOnlyDbUserDbGroupsDBNAMEdefaultRowFetchSizeDisableIsValidQueryenableFetchRingBufferenableMultiSqlSupportfetchRingBufferSizeForceLowercasegroupFederationHOSTIAMDisableCacheIAMDurationIdc_Client_Display_NameIdc_RegionIdP_HostIdP_PortIdP_TenantIdP_Response_TimeoutIniFileIniSectionisServerlessIssuer_Urllisten_portLogin_URLloginTimeoutloginToRpLogLevelLogPathOverrideSchemaPatternTypePartner_SPIDパスワードPlugin_NamePORTPreferred_RoleプロファイルPWDqueryGroupreadOnlyリージョンreWriteBatchedInsertsreWriteBatchedInsertsSizeroleArnroleSessionNamescopeSecretAccessKeySessionTokenserverlessAcctIdserverlessWorkGroupsocketFactorysocketTimeoutSSLSSL_InsecureSSLCertSSLFactorySSLKeySSLModeSSLPasswordSSLRootCertStsEndpointUrltcpKeepAliveトークンtoken_typeUIDユーザーwebIdentityToken

JDBC ドライバーバージョン 2.1 の設定オプション

以下に、Amazon Redshift JDBC ドライバーのバージョン 2.1 で指定できるオプションの説明を示します。設定オプションでは、大文字と小文字を区別しません。

接続 URL を使用して、構成プロパティを設定できます。詳細については、「接続 URL の構築」を参照してください。

AccessKeyID

  • デフォルト値 – なし

  • データ型 – 文字列

このパラメータを指定して、ユーザーまたはロールの IAM アクセスキーを入力できます。通常、既存の文字列またはユーザープロファイルを確認することで、キーを見つけることができます。このパラメータを指定する場合は、SecretAccessKeyパラメータも指定する必要があります。JDBC URL で渡す場合は、AccessKeyID を URL エンコードする必要があります。

このパラメータはオプションです。

AllowDBUserOverride

  • デフォルト値: 0

  • データ型 – 文字列

このオプションは、ドライバーが SAML アサーションの DbUser 値を使用するか、接続 URL の DbUser 接続プロパティで指定された値を使用するかを指定します。

このパラメータはオプションです。

1

ドライバーは SAML アサーションの DbUser 値を使用します。

SAML アサーションで DBUser の値が指定されていない場合、ドライバーは接続プロパティ DBUser で指定された値を使用します。この接続プロパティでも値が指定されていない場合、ドライバーは接続プロファイルで指定された値を使用します。

0

ドライバーは、DBUser接続プロパティで指定された DBUser 値を使用します。

接続プロパティ DBUser で値が指定されていない場合、ドライバーは接続プロファイルで指定された値を使用します。接続プロファイルでも値が指定されていない場合、ドライバーは SAML アサーションの値を使用します。

App_ID

  • デフォルト値 – なし

  • データ型 – 文字列

Okta が提供する Amazon Redshift アプリケーションに関連付けられた一意の ID。

このパラメータは、Okta サービスを介して認証する場合に必要です。

App_Name

  • デフォルト値 – なし

  • データ型 – 文字列

Amazon Redshift への接続を認証するために使用する Okta アプリケーションの名前。

このパラメータはオプションです。

ApplicationName

  • デフォルト値 – null

  • データ型 – 文字列

監査目的のために Amazon Redshift に渡すアプリケーションの名前。

このパラメータはオプションです。

AuthProfile

  • デフォルト値 – なし

  • データ型 – 文字列

Amazon Redshift への接続に使用する認証プロファイルの名前。

このパラメータはオプションです。

AutoCreate

  • デフォルト値 – false

  • データ型 – ブール型

このオプションは、指定されたユーザーが存在しない場合に、ドライバーが新しいユーザーを作成するかどうかを指定します。

このパラメータはオプションです。

true

DBUser または固有 ID (UID) のいずれかで指定されたユーザーが存在していない場合は、その名前の新しいユーザーが作成されます。

false

ドライバーが新しいユーザーを作成することはありません。指定したユーザーが存在しない場合、認証は失敗します。

Client_ID

  • デフォルト値 – なし

  • データ型 – 文字列

Azure AD サービスを使用して接続を認証する際に使用するクライアント ID。

このパラメータは、Azure AD サービスを介して認証する場合に必要です。

Client_Secret

  • デフォルト値 – なし

  • データ型 – 文字列

Azure AD サービスを使用して接続を認証するときに使用するクライアントシークレット。

このパラメータは、Azure AD サービスを介して認証する場合に必要です。

ClusterID

  • デフォルト値 – なし

  • データ型 – 文字列

接続する Amazon Redshift クラスターの名前。ドライバーは、指定されたホストからこのパラメータを検出しようとします。Network Load Balancer (NLB) を使用しており IAM を介して接続する場合、ドライバーはそれを検出できないため、この接続オプションを使用して設定することができます。

このパラメータはオプションです。

圧縮

  • デフォルト値 - オフ

  • データ型 – 文字列

Amazon Redshift サーバーとクライアントまたはドライバー間のワイヤプロトコル通信に使用される圧縮方法。

このパラメータはオプションです。

次の値を指定できます。

  • lz4

    Amazon Redshift とのワイヤプロトコル通信に使用される圧縮方法を lz4 に設定します。

  • off

    Amazon Redshift とのワイヤプロトコル通信には圧縮を使用しません。

connectTimeout

  • デフォルト値 – 10

  • データ型 – 整数

ソケット接続操作に使用するタイムアウト値。Amazon Redshift 接続の確立に必要な時間がこの値を超えると、接続は利用不可であると見なされます。タイムアウトは秒単位で指定されます。0 の値は、タイムアウトが指定されていないことを意味します。

このパラメータはオプションです。

connectionTimezone

  • デフォルト値 – LOCAL

  • データ型 – 文字列

セッションレベルのタイムゾーン。

このパラメータはオプションです。

次の値を指定できます。

LOCAL

セッションレベルのタイムゾーンを LOCAL JVM タイムゾーンに設定します。

SERVER

セッションレベルのタイムゾーンを、Amazon Redshift サーバー上のユーザーに設定されたタイムゾーンに設定します。次のコマンドを使用して、ユーザーのセッションレベルのタイムゾーンを設定できます。

ALTER USER
[...]
SET TIMEZONE TO [...];

databaseMetadataCurrentDbOnly

  • デフォルト値 – true

  • データ型 – ブール型

このオプションは、メタデータ API が、アクセス可能なすべてのデータベースからデータを取得するか、接続しているデータベースからのみデータを取得するかを指定します。

このパラメータはオプションです。

次の値を指定できます。

true

アプリケーションは、単一のデータベースからメタデータを取得します。

false

アプリケーションは、アクセス可能なすべてのデータベースからメタデータを取得します。

DbUser

  • デフォルト値 – なし

  • データ型 – 文字列

Amazon Redshift アカウントで使用するユーザー ID。AutoCreate プロパティを有効にしている場合は、現在存在しない ID を使用できます。

このパラメータはオプションです。

DbGroups

  • デフォルト値 – PUBLIC

  • データ型 – 文字列

DBUser が現在のセッションで参加する、既存のデータベースグループ名のコンマ区切りリスト。

このパラメータはオプションです。

DBNAME

  • デフォルト値 – null

  • データ型 – 文字列

接続先のデータベースの名前です。このオプションは、JDBC 接続 URL にデータベース名を指定するために使用できます。

このパラメータは必須です。データベース名は、接続 URL、またはクライアントアプリケーションの接続プロパティで指定する必要があります。

defaultRowFetchSize

  • デフォルト値: 0

  • データ型 – 整数

このオプションは、getFetchSize のデフォルト値を指定します。

このパラメータはオプションです。

次の値を指定できます。

0

1 回のオペレーションですべての行をフェッチします。

正の整数

ResultSet のフェッチを繰り返すごとに、データベースからフェッチする行の数。

DisableIsValidQuery

  • デフォルト値 – False

  • データ型 – ブール型

このオプションは、Connection.isValid() メソッドを使用してデータベース接続がアクティブかどうかを判断するときに、ドライバーが新しいデータベースクエリを送信するかどうかを指定します。

このパラメータはオプションです。

true

Connection.isValid() を使用してデータベース接続がアクティブかどうかを判断する場合、ドライバーはクエリを送信しません。これにより、データベースサーバーが予期せずシャットダウンした場合、ドライバーがデータベース接続をアクティブとして誤って識別することがあります。

false

Connection.isValid () を使用してデータベース接続がアクティブかどうかを判断する場合、ドライバーはクエリを送信します。

enableFetchRingBuffer

  • デフォルト値 – true

  • データ型 – ブール型

このオプションは、ドライバーが別のスレッドのリングバッファを使用して行をフェッチすることを指定します。fetchRingBufferSize パラメータは、リングバッファのサイズを指定します。

トランザクションがセミコロンで区切られた複数の SQL コマンドを含むステートメントを検出した場合、そのトランザクションのフェッチリングバッファは false に設定されます。enableFetchRingBuffer の値は変わりません。

このパラメータはオプションです。

enableMultiSqlSupport

  • デフォルト値 – true

  • データ型 – ブール型

このオプションは、ステートメント内でセミコロンで区切られた複数の SQL コマンドを処理するかどうかを指定します。

このパラメータはオプションです。

次の値を指定できます。

true

ドライバーは、Statement オブジェクト内でセミコロンで区切られた複数の SQL コマンドを処理します。

false

ドライバーは、単一のステートメントで複数の SQL コマンドに対してエラーを返します。

fetchRingBufferSize

  • デフォルト値 – 1G

  • データ型 – 文字列

このオプションは、結果セットの取得時に使用するリングバッファのサイズを指定します。サイズはバイト単位で指定できます。例えば、1 KB の場合は 1K、5,000 バイトの場合は 5000、1 MB の場合は 1M、1 GB の場合は 1G などです。ヒープメモリの割合を指定することもできます。ドライバーは、制限に達すると行のフェッチを停止します。アプリケーションが行を読み込み、リングバッファのスペースを解放すると、フェッチが再開されます。

このパラメータはオプションです。

ForceLowercase

  • デフォルト値 – false

  • データ型 – ブール型

このオプションは、シングルサインオン認証を使用するときに ID プロバイダーから Amazon Redshift に送信されたすべてのデータベースグループ (DbGroups) をドライバーが小文字にするかどうかを指定します。

このパラメータはオプションです。

true

ドライバーは、ID プロバイダーから送信されるすべてのデータベースグループを小文字にします。

false

ドライバーは、データベースグループを変更しません。

groupFederation

  • デフォルト値 – false

  • データ型 – ブール型

このオプションは、Amazon Redshift IDP グループを使用するかどうかを指定します。これは GetClusterCredentialsV2 API でサポートされています。

このパラメータはオプションです。

true

Amazon Redshift アイデンティティプロバイダー (IDP) グループを使用します。

false

ユーザーフェデレーションに STS API と GetClusterCredentials を使用し、接続に DbGroups を明示的に指定します。

HOST

  • デフォルト値 – null

  • データ型 – 文字列

接続先の Amazon Redshift サーバーのホスト名。このオプションは、JDBC 接続 URL にホスト名を指定するために使用できます。

このパラメータは必須です。ホスト名は、接続 URL、またはクライアントアプリケーションの接続プロパティで指定する必要があります。

IAMDisableCache

  • デフォルト値 – false

  • データ型 – ブール型

このオプションは、IAM 認証情報をキャッシュするかどうかを指定します。

このパラメータはオプションです。

true

IAM 認証情報はキャッシュされません。

false

IAM 認証情報はキャッシュされます。これにより、API ゲートウェイへのリクエストが抑制された場合のパフォーマンスが向上します。

IAMDuration

  • デフォルト値 – 900

  • データ型 – 整数

一時的な IAM 認証情報が期限切れになるまでの時間 (秒単位)。

  • 最小値 – 900

  • 最大値 – 3,600

このパラメータはオプションです。

Idc_Client_Display_Name

  • デフォルト値 - Amazon Redshift JDBC ドライバー

  • データ型 – 文字列

BrowserIdcAuthPlugin を使用しているクライアントに使用される表示名。

このパラメータはオプションです。

Idc_Region

  • デフォルト値 – なし

  • データ型 – 文字列

IAM アイデンティティセンターインスタンスが配置されている AWS リージョン。

このパラメータは、plugin_name 設定オプションで BrowserIdcAuthPlugin を使用して認証する場合にのみ必要です。

IdP_Host

  • デフォルト値 – なし

  • データ型 – 文字列

Amazon Redshift への認証に使用する IdP (ID プロバイダー) のホスト。これは、接続文字列またはプロファイルのいずれかで指定できます。

このパラメータはオプションです。

IdP_Port

  • デフォルト値 – なし

  • データ型 – 文字列

IdP (アイデンティティプロバイダー) が使用するポート。ポートは、接続文字列またはプロファイルで指定できます。デフォルトのポート番号は 5439 です。クラスターの作成、変更、または移行時に選択したポートに応じて、選択したポートへのアクセスを許可します。

このパラメータはオプションです。

IdP_Tenant

  • デフォルト値 – なし

  • データ型 – 文字列

Amazon Redshift アプリケーションの Azure AD テナント ID です。

このパラメータは、Azure AD サービスを介して認証する場合に必要です。

IdP_Response_Timeout

  • デフォルト値 – 120

  • データ型 – 整数

ブラウザのプラグインを介して SAML または Azure AD サービスを使用する場合に、ドライバーが ID プロバイダーからの SAML 応答を待機する時間 (秒単位) です。

このパラメータはオプションです。

IniFile

  • デフォルト値 – なし

  • データ型 – 文字列

.ini ファイルのファイル名を含む完全なパス。例:

IniFile="C:\tools\rsjdbc.ini"

.ini ファイルの詳細については、「JDBC ドライバーバージョン 2.1 用の初期化 (.ini) ファイルの作成」を参照してください。

このパラメータはオプションです。

IniSection

  • デフォルト値 – なし

  • データ型 – 文字列

構成オプションを含む.iniファイル内のセクションの名前。.ini ファイルの詳細については、「JDBC ドライバーバージョン 2.1 用の初期化 (.ini) ファイルの作成」を参照してください。

次の例では、.ini ファイル内の [Prod] セクションを指定しています。

IniSection="Prod"

このパラメータはオプションです。

isServerless

  • デフォルト値 – false

  • データ型 – ブール型

このオプションは、Amazon Redshift エンドポイントホストがサーバーレス インスタンスであるかどうか指定します。ドライバーは、指定されたホストからこのパラメータを検出しようとします。Network Load Balancer (NLB) を使用している場合、ドライバーはそれを検出できないため、ここで設定できます。

このパラメータはオプションです。

true

Amazon Redshift エンドポイントホストはサーバーレスインスタンスです。

false

Amazon Redshift エンドポイント ホストはプロビジョニングされたクラスターです。

Issuer_Url

  • デフォルト値 – なし

  • データ型 – 文字列

AWS IAM アイデンティティセンターサーバーのインスタンスエンドポイントを指します。

このパラメータは、plugin_name 設定オプションで BrowserIdcAuthPlugin を使用して認証する場合にのみ必要です。

listen_port

  • デフォルト値 - 7890

  • データ型 – 整数

ブラウザのプラグインを介して SAML、Azure AD または AWS アイデンティティセンターのサービスを使用する場合に、ID プロバイダーから SAML レスポンスを受信するためにドライバーが使用するポートです。

このパラメータはオプションです。

Login_URL

  • デフォルト値 – なし

  • データ型 – 文字列

ブラウザのプラグインを介して SAML または Azure AD サービスを使用する場合に、ID プロバイダーのウェブサイト上のリソース URL です。

このパラメータは、ブラウザプラグインを介して SAML または Azure AD サービスで認証する場合に必要です。

loginTimeout

  • デフォルト値: 0

  • データ型 – 整数

サーバーに接続して認証するときにタイムアウトするまで待つ秒数。接続を確立するときにこのしきい値よりも時間がかかると、接続は中止されます。

このプロパティが 0 に設定されている場合、接続はタイムアウトしません。

このパラメータはオプションです。

loginToRp

  • デフォルト値 – urn:amazon:webservices

  • データ型 – 文字列

AD FS 認証の種類に使用する証明書利用者の信頼。

このパラメータはオプションです。

LogLevel

  • デフォルト値: 0

  • データ型 – 整数

このプロパティを使用して、ログファイルに含まれる詳細情報の量を指定しながら、ドライバーのログ記録を有効または無効にします。

問題をキャプチャするのに十分な時間だけログを有効にします。ログ記録によってパフォーマンスが低下し、ディスク容量が大量に消費される可能性があります。

このパラメータはオプションです。

パラメータを次のいずれかの値に設定します。

0

すべてのログ記録を無効にします。

1

FATAL レベルでログ記録を有効にします。これにより、ドライバーの中止につながる非常に重大なエラーイベントがログに記録されます。

2

ERROR レベルでのログ記録を有効にし、ドライバーの実行を続行できるように許可する可能性があるエラーイベントがログに記録されます。

3

WARNING レベルでのログ記録を有効にします。これにより、アクションを実行しないとエラーが発生する可能性のあるイベントがログに記録されます。

4

INFO レベルでログ記録を有効にし、ドライバーの進行状況を示す全般的な情報をログに記録します。

5

DEBUG レベルでログ記録を有効にします。このレベルでは、ドライバーのデバッグに役立つ詳細な情報がログに記録されます。

6

TRACE レベルでのログ記録を有効にします。これにより、すべてのドライバーのアクティビティがログに記録されます。

ログ記録を有効にすると、ドライバーは LogPath プロパティで指定された場所に次のログファイルを生成します。

  • redshift_jdbc.log – 接続に固有ではないドライバーアクティビティをログするファイル。

  • redshift_jdbc_connection_[Number].log – データベースに対して行われた各接続のファイル。ここで、[Number]は各ログファイルを他のログファイルと区別する番号です。このファイルは、接続に固有のドライバーアクティビティをログに記録します。

LogPath 値が無効な場合、ドライバーはログに記録された情報を標準出力ストリーム System.out に送信します。

LogPath

  • デフォルト値 – 現在の作業ディレクトリです。

  • データ型 – 文字列

DSILogLevel プロパティが有効になっている場合に、ドライバーがログファイルを保存するフォルダへのフルパスです。

接続 URL がすべての JDBC アプリケーションと互換性があることを確認するには、別のバックスラッシュを入力して、ファイルパス内のバックスラッシュ (\) をエスケープすることをお勧めします。

このパラメータはオプションです。

OverrideSchemaPatternType

  • デフォルト値 – null

  • データ型 – 整数

このオプションによって、GetTables コールで使用されるクエリのタイプを無視するかどうかを指定します。

0

スキーマユニバーサルクエリなし

1

ローカルスキーマクエリ

2

外部スキーマクエリ

このパラメータはオプションです。

Partner_SPID

  • デフォルト値 – なし

  • データ型 – 文字列

PingFederate サービスを使用して接続を認証するときに使用するパートナー SPID (サービスプロバイダー ID) の値。

このパラメータはオプションです。

パスワード

  • デフォルト値 – なし

  • データ型 – 文字列

IDP を介して IAM 認証を使用して接続する場合、これは IDP_Host サーバーのパスワードです。標準認証を使用する場合、PWD の代わりに Amazon Redshift データベースのパスワードにこれを使用できます。

このパラメータはオプションです。

Plugin_Name

  • デフォルト値 – なし

  • データ型 – 文字列

特定の認証情報プロバイダーのプログインを実装する完全修飾クラス名。

このパラメータはオプションです。

以下のプロバイダーオプションがサポートされています。

  • AdfsCredentialsProvider – Active Directory フェデレーションサービス。

  • AzureCredentialsProvider – Microsoft Azure Active Directory (AD) サービス。

  • BasicJwtCredentialsProvider – JSON ウェブトークン (JWT) サービス。

  • BasicSamlCredentialsProvider – Security Assertion Markup Language (SAML) 認証情報。多数の SAML サービスプロバイダーで使用できます。

  • BrowserAzureCredentialsProvider – Microsoft Azure Active Directory (AD) サービスのブラウザ。

  • BrowserAzureOAuth2CredentialsProvider – ネイティブ認証用の Microsoft Azure Active Directory (AD) サービスのブラウザ。

  • BrowserIdcAuthPlugin – AWS IAM アイデンティティセンターを使用する認可プラグイン。

  • BrowserSamlCredentialsProvider – Okta、Ping、ADFS などの SAML サービス用のブラウザ SAML。

  • IdpTokenAuthPlugin — AWS IAM アイデンティティセンターのトークン、または AWS IAM アイデンティティセンターにリンクされているウェブ ID プロバイダーからの OpenID Connect (OIDC) JSON ベースの ID トークン (JWT) を受け入れる認可プラグイン。

  • OktaCredentialsProvider – Okta サービス。

  • PingCredentialsProvider – PingFederate サービス。

PORT

  • デフォルト値 – null

  • データ型 – 整数

接続先の Amazon Redshift サーバーのポート。このオプションは、JDBC 接続 URL にポート名を指定するために使用できます。

このパラメータはオプションです。

Preferred_Role

  • デフォルト値 – なし

  • データ型 – 文字列

Amazon Redshift への接続中に引き受ける IAM ロール。

このパラメータはオプションです。

プロファイル

  • デフォルト値 – なし

  • データ型 – 文字列

IAM 認証に使用するプロファイルの名前。このプロファイルには、接続文字列で指定されていない追加の接続プロパティが含まれます。

このパラメータはオプションです。

PWD

  • デフォルト値 – なし

  • データ型 – 文字列

プロパティ UID を使用して指定した Amazon Redshift ユーザー名に対応するパスワード。

このパラメータはオプションです。

queryGroup

  • デフォルト値 – null

  • データ型 – 文字列

このオプションは、適切なクエリグループにクエリを割り当てることで、実行時にクエリをキューに割り当てます。セッションに対してクエリグループが設定されます。接続で実行されるすべてのクエリは、このクエリグループに属します。

このパラメータはオプションです。

readOnly

  • デフォルト値 – false

  • データ型 – ブール型

このプロパティは、ドライバーが読み込み専用モードであるかどうかを指定します。

このパラメータはオプションです。

true

接続は読み込み専用モードであり、データストアに書き込むことはできません。

false

接続は読み込み専用モードではなく、データストアに書き込むことができます。

リージョン

  • デフォルト値 – null

  • データ型 – 文字列

このオプションは、クラスターが配置されている AWS リージョンを指定します。StsEndPoint オプションを指定すると、[Region (リージョン)] オプションは無視されます。Redshift GetClusterCredentials API オペレーションは、リージョンオプションも使用します。

このパラメータはオプションです。

reWriteBatchedInserts

  • デフォルト値 – false

  • データ型 – ブール型

このオプションは、互換性のある INSERT ステートメントを書き換えてバッチに統合する最適化を有効にします。

このパラメータはオプションです。

reWriteBatchedInsertsSize

  • デフォルト値 – 128

  • データ型 – 整数

このオプションは、互換性のある INSERT ステートメントを書き換えてバッチに統合する最適化を有効にします。この値は、2 の累乗だけ指数関数的に増加する必要があります。

このパラメータはオプションです。

roleArn

  • デフォルト値 – なし

  • データ型 – 文字列

ロールの Amazon リソースネーム (ARN)。Plugin_Name オプションに BasicJwtCredentialsProvider を指定する場合、必ずこのパラメータを指定してください。ARN は次の形式で指定します。

arn:partition:service:region:account-id:resource-id

Plugin_Name オプションに BasicJwtCredentialsProvider を指定する場合、このパラメータは必須です。

roleSessionName

  • デフォルト値 – jwt_redshift_session

  • データ型 – 文字列

引き受けたロールセッションの識別子。通常は、アプリケーションのユーザーに関連付けられている名前または識別子を渡します。アプリケーションが使用する一時的なセキュリティ認証情報は、そのユーザーに関連付けられます。Plugin_Name オプションに BasicJwtCredentialsProvider を指定する場合、このパラメータを指定できます。

このパラメータはオプションです。

scope

  • デフォルト値 – なし

  • データ型 – 文字列

ユーザーが同意可能なスコープをスペースで区切ったリストです。このパラメータを指定すると、Microsoft Azure アプリケーションが呼び出す API の同意を得られるようになります。Plugin_Name オプションに BrowserAzureOAuth2CredentialsProvider を指定する場合、このパラメータを指定できます。

このパラメータは、BrowserAzureOAuth2CredentialsProvider プラグインでは必須です。

SecretAccessKey

  • デフォルト値 – なし

  • データ型 – 文字列

ユーザーまたはロールの IAM アクセスキー。これを指定する場合は、AccessKeyID も指定する必要があります。JDBC URL で渡す場合は、SecretAccessKey を URL エンコードする必要があります。

このパラメータはオプションです。

SessionToken

  • デフォルト値 – なし

  • データ型 – 文字列

認証に使用している IAM ロールに関連付けられた一時的な IAM セッショントークン。JDBC URL で渡される場合、一時的な IAM セッショントークンは URL エンコードされている必要があります。

このパラメータはオプションです。

serverlessAcctId

  • デフォルト値 – null

  • データ型 – 文字列

Amazon Redshift Serverless アカウント ID。ドライバーは、指定されたホストからこのパラメータを検出しようとします。Network Load Balancer (NLB) を使用している場合、ドライバーはそれを検出できないため、ここで設定できます。

このパラメータはオプションです。

serverlessWorkGroup

  • デフォルト値 – null

  • データ型 – 文字列

Amazon Redshift Serverless ワークグループ名。ドライバーは、指定されたホストからこのパラメータを検出しようとします。Network Load Balancer (NLB) を使用している場合、ドライバーはそれを検出できないため、ここで設定できます。

このパラメータはオプションです。

socketFactory

  • デフォルト値 – null

  • データ型 – 文字列

このオプションは、ソケット作成用のソケットファクトリを指定します。

このパラメータはオプションです。

socketTimeout

  • デフォルト値: 0

  • データ型 – 整数

タイムアウトする前にソケット読み込みオペレーションを待つ秒数。このオペレーションにこのしきい値よりも時間がかかると、接続は閉じます。このプロパティが 0 に設定されていると、接続はタイムアウトしません。

このパラメータはオプションです。

SSL

  • デフォルト値 – TRUE

  • データ型 – 文字列

このプロパティを使用して、SSL による接続を有効または無効にします。

このパラメータはオプションです。

次の値を指定できます。

TRUE

ドライバーは SSL 経由でサーバーに接続します。

FALSE

ドライバーは SSL を使用せずにサーバーに接続します。このオプションは IAM 認証ではサポートされていません。

または、AuthMech プロパティを構成することもできます。

SSL_Insecure

  • デフォルト値 – true

  • データ型 – 文字列

このプロパティは、IDP ホストサーバー証明書を検証する必要があるかどうかを示します。

このパラメータはオプションです。

次の値を指定できます。

true

ドライバーは IDP サーバー証明書の信頼性を確認しません。

false

ドライバーは、IDP サーバー証明書の信頼性をチェックします。

SSLCert

  • デフォルト値 – なし

  • データ型 – 文字列

SSL を使用するときに Amazon Redshift サーバーインスタンスを確認するための信頼できる追加 CA 証明書を含む .pem または .crt ファイルのフルパス。

このパラメータは、SSLKey を指定した場合に必要です。

SSLFactory

  • デフォルト値 – なし

  • データ型 – 文字列

サーバー証明書を使用せずに TLS/SSL 経由でサーバーに接続するときに使用する SSL ファクトリ。

SSLKey

  • デフォルト値 – なし

  • データ型 – 文字列

SSLCert で指定された証明書を検証するための PKCS8 キーファイルを含む .der ファイルのフルパス。

このパラメータは、SSLCert を指定した場合に必要です。

SSLMode

  • デフォルト値 – verify-ca

  • データ型 – 文字列

このプロパティを使用して、TLS/SSL が有効になっている場合にドライバーが証明書を検証する方法を指定します。

このパラメータはオプションです。

次の値を指定できます。

verify-ca

ドライバーは、証明書が信頼できる認定権限 (CA) から送信されていることを確認します。

verify-full

ドライバは、証明書が信頼できる CA から取得されていること、および証明書のホスト名が接続 URL で指定されたホスト名と一致することを確認します。

SSLPassword

  • デフォルト値: 0

  • データ型 – 文字列

SSLKey で指定された暗号化キーファイルのパスワード。

SSLKey が指定され、キーファイルが暗号化されている場合、このパラメータは必須です。

SSLRootCert

  • デフォルト値 – なし

  • データ型 – 文字列

SSL を使用するときに Amazon Redshift サーバーインスタンスを確認するためのルート CA 証明書を含む .pem または .crt ファイルのフルパス。

StsEndpointUrl

  • デフォルト値 – null

  • データ型 – 文字列

AWS Security Token Service(AWS STS) エンドポイントを指定することができます。このオプションを指定すると、リージョンオプションは無視されます。このエンドポイントにはセキュアプロトコル (HTTPS) のみを指定できます。

tcpKeepAlive

  • デフォルト値 – TRUE

  • データ型 – 文字列

このプロパティを使用して、TCP キープアライブを有効または無効にします。

このパラメータはオプションです。

次の値を指定できます。

TRUE

接続のタイムアウトを防ぐために TCP キープアライブを使用するようにドライバーを設定します。

FALSE

ドライバーは TCP キープアライブを使用しません。

トークン

  • デフォルト値 – なし

  • データ型 – 文字列

AWS IAM アイデンティティセンターが提供するアクセストークン、または AWS IAM アイデンティティセンターにリンクされているウェブ ID プロバイダーが提供する OpenID Connect (OIDC) JSON ウェブトークン (JWT)。アプリケーションは、このトークンを生成するために、AWS IAM アイデンティティセンターまたは AWS IAM アイデンティティセンターにリンクされている ID プロバイダーにより、アプリケーションのユーザーを認証する必要があります。

このパラメータは IdpTokenAuthPlugin で機能します。

token_type

  • デフォルト値 – なし

  • データ型 – 文字列

IdpTokenAuthPlugin で使用しているトークンのタイプ。

次の値を指定できます。

ACCESS_TOKEN

AWS IAM アイデンティティセンターが提供するアクセストークンを使用する場合は、これを入力します。

EXT_JWT

AWS IAM アイデンティティセンターと統合されているウェブベースの ID プロバイダーが提供する OpenID Connect (OIDC) JSON ウェブトークン (JWT) を使用する場合は、これを入力します。

このパラメータは IdpTokenAuthPlugin で機能します。

UID

  • デフォルト値 – なし

  • データ型 – 文字列

データベースへのアクセスに使用するデータベースユーザー名。

このパラメータは必須です。

ユーザー

  • デフォルト値 – なし

  • データ型 – 文字列

IDP を介して IAM 認証を使用して接続する場合、これは idp_host サーバーのユーザー名です。標準認証を使用する場合、これを Amazon Redshift データベースユーザー名として使用できます。

このパラメータはオプションです。

webIdentityToken

  • デフォルト値 – なし

  • データ型 – 文字列

ID プロバイダによって提供される OAuth 2.1 アクセストークンまたは OpenID Connect ID トークン。アプリケーションは、ウェブアイデンティティのプロバイダーを使用してアプリケーションのユーザーを認証することによって、このトークンを取得する必要があります。Plugin_Name オプションに BasicJwtCredentialsProvider を指定する場合、必ずこのパラメータを指定してください。

Plugin_Name オプションに BasicJwtCredentialsProvider を指定する場合、このパラメータは必須です。