Amazon Redshift 將不再支援從修補程式 198 開始建立新的 Python UDFs。現有 Python UDF 將繼續正常運作至 2026 年 6 月 30 日。如需詳細資訊，請參閱[部落格文章](https://aws.amazon.com/blogs/big-data/amazon-redshift-python-user-defined-functions-will-reach-end-of-support-after-june-30-2026/)。 本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # JDBC 驅動器 2.x 版組態的選項 您可以在下面找到您可以為 Amazon Redshift JDBC 驅動程式 2.2 版指定的選項的說明。組態選項不區分大小寫。 您可以使用連線 URL 設定組態屬性。如需詳細資訊，請參閱[建置連線 URL](jdbc20-build-connection-url.md)。 **Topics** + [AccessKeyID](#jdbc20-accesskeyid-option) + [AllowDBUserOverride](#jdbc20-allowdbuseroverride-option) + [App\$1ID](#jdbc20-app-id-option) + [App\$1Name](#jdbc20-app-name-option) + [ApplicationName](#jdbc20-applicationname-option) + [AuthProfile](#jdbc20-authprofile-option) + [AutoCreate](#jdbc20-autocreate-option) + [Client\$1ID](#jdbc20-client_id-option) + [Client\$1Secret](#jdbc20-client_secret-option) + [ClusterID (ClusterID)](#jdbc20-clusterid-option) + [壓縮](#jdbc20-compression-option) + [connectTimeout](#jdbc20-connecttimeout-option) + [connectionTimezone](#jdbc20-connecttimezone-option) + [databaseMetadataCurrentDbOnly](#jdbc20-databasemetadatacurrentdbonly-option) + [DbUser](#jdbc20-dbuser-option) + [DbGroups](#jdbc20-dbgroups-option) + [DBNAME](#jdbc20-dbname-option) + [defaultRowFetchSize](#jdbc20-defaultrowfetchsize-option) + [DisableIsValidQuery](#jdbc20-disableisvalidquery-option) + [enableFetchRingBuffer](#jdbc20-enablefetchringbuffer-option) + [enableMultiSqlSupport](#jdbc20-enablemultisqlsupport-option) + [fetchRingBufferSize](#jdbc20-fetchringbuffersize-option) + [ForceLowercase](#jdbc20-forcelowercase-option) + [groupFederation](#jdbc20-groupFederation-option) + [HOST](#jdbc20-host-option) + [IAMDisableCache](#jdbc20-iamdisablecache-option) + [IAMDuration](#jdbc20-iamduration-option) + [Idc\$1Client\$1Display\$1Name](#jdbc20-idc_client_display_name) + [Idc\$1Region](#jdbc20-idc_region) + [IdP\$1Host](#jdbc20-idp_host-option) + [IdP\$1Partition](#jdbc20-idp_partition-option) + [IdP\$1Port](#jdbc20-idp_port-option) + [IdP\$1Tenant](#jdbc20-idp_tenant-option) + [IdP\$1Response\$1Timeout](#jdbc20-idp_response_timeout-option) + [IniFile](#jdbc20-inifile-option) + [IniSection](#jdbc20-inisection-option) + [isServerless](#jdbc20-isserverless-option) + [Issuer\$1Url](#jdbc20-issuer-url) + [Listen\$1Port](#jdbc20-listen-port) + [Login\$1URL](#jdbc20-login_url-option) + [loginTimeout](#jdbc20-logintimeout-option) + [loginToRp](#jdbc20-logintorp-option) + [LogLevel](#jdbc20-loglevel-option) + [LogPath](#jdbc20-logpath-option) + [OverrideSchemaPatternType](#jdbc20-override-schema-pattern-type) + [Partner\$1SPID](#jdbc20-partner_spid-option) + [密碼](#jdbc20-password-option) + [Plugin\$1Name](#jdbc20-plugin_name-option) + [PORT](#jdbc20-port-option) + [Preferred\$1Role](#jdbc20-preferred_role-option) + [設定檔](#jdbc20-profile-option) + [PWD](#jdbc20-pwd-option) + [queryGroup](#jdbc20-querygroup-option) + [readOnly](#jdbc20-readonly-option) + [區域](#jdbc20-region-option) + [reWriteBatchedInserts](#jdbc20-rewritebatchedinserts-option) + [reWriteBatchedInsertsSize](#jdbc20-rewritebatchedinsertssize-option) + [roleArn](#jdbc20-rolearn-option) + [roleSessionName](#jdbc20-roleaessionname-option) + [scope](#jdbc20-scope-option) + [SecretAccessKey](#jdbc20-secretaccesskey-option) + [SessionToken](#jdbc20-sessiontoken-option) + [serverlessAcctId](#jdbc20-serverlessacctid-option) + [serverlessWorkGroup](#jdbc20-serverlessworkgroup-option) + [socketFactory](#jdbc20-socketfactory-option) + [socketTimeout](#jdbc20-sockettimeout-option) + [SSL](#jdbc20-ssl-option) + [SSL\$1Insecure](#jdbc20-ssl_insecure-option) + [SSLCert](#jdbc20-sslcert-option) + [SSLFactory](#jdbc20-sslfactory-option) + [SSLKey](#jdbc20-sslkey-option) + [SSLMode](#jdbc20-sslmode-option) + [SSLPassword](#jdbc20-sslpassword-option) + [SSLRootCert](#jdbc20-sslrootcert-option) + [StsEndpointUrl](#jdbc20-stsendpointurl-option) + [tcpKeepAlive](#jdbc20-tcpkeepalive-option) + [token](#jdbc20-token-option) + [token\$1type](#jdbc20-token-type-option) + [UID](#jdbc20-uid-option) + [使用者](#jdbc20-user-option) + [webIdentityToken](#jdbc20-webidentitytoken-option) ## 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\$1ID + **預設值** — 無 + **資料類型** — 字串 與您的 Amazon Redshift 應用程式相關聯、Okta 所提供的唯一 ID。 如果透過 Okta 服務進行驗證，則需要此參數。 ## App\$1Name + **預設值** — 無 + **資料類型** — 字串 您用來驗證與 Amazon Redshift 之連線的 Okta 應用程式名稱。 此為選用參數。 ## ApplicationName + **預設值** — Null + **資料類型** — 字串 要傳遞給 Amazon Redshift 以進行稽核的應用程式名稱。 此為選用參數。 ## AuthProfile + **預設值** — 無 + **資料類型** — 字串 用於連線至 Amazon Redshift 的身分驗證設定檔名稱。 此為選用參數。 ## AutoCreate + **預設值** — false + **資料類型** — 布林值 此選項會指定當指定的使用者不存在時，驅動程式是否要導致系統建立新的使用者。 此為選用參數。 **true** 如果 `DBUser` 或唯一 ID (UID) 指定的使用者不存在，則系統會建立具有該名稱的新使用者。 **false** 驅動程式不會導致系統建立新的使用者。如果指定的使用者不存在，則身分驗證會失敗。 ## Client\$1ID + **預設值** — 無 + **資料類型** — 字串 使用 Azure AD 服務來驗證連線時要使用的用戶端 ID。 如果透過 Azure AD 服務進行驗證，則需要此參數。 ## Client\$1Secret + **預設值** — 無 + **資料類型** — 字串 使用 Azure AD 服務來驗證連線時要使用的用戶端秘密。 如果透過 Azure AD 服務進行驗證，則需要此參數。 ## ClusterID (ClusterID) + **預設值** — 無 + **資料類型** — 字串 您要連線至的 Amazon Redshift 叢集的名稱。驅動程式會嘗試從給定的主機偵測此參數。如果您使用 Network Load Balancer (NLB) 並透過 IAM 進行連線，則驅動程式無法偵測此參數，因此您可以使用此連線選項設定此參數。 此為選用參數。 ## 壓縮 + **預設值** - off + **資料類型** — 字串 用於 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** 在單一操作中擷取所有資料列。 **正整數** 針對 ResultSet 的每次擷取迭代，要從資料庫擷取的資料列數目。 ## DisableIsValidQuery + **預設值** — False + **資料類型** — 布林值 此選項會指定驅動程式在使用 Connection.isValid() 方法判斷資料庫連線是否處於作用中狀態時，是否要提交新的資料庫查詢。 此為選用參數。 **true** 驅動程式在使用 Connection.isValid() 判斷資料庫連線是否處於作用中狀態時，不會提交查詢。如果資料庫伺服器意外關閉，這可能會造成驅動程式錯誤地將資料庫連線識別為作用中狀態。 **false** 驅動程式在使用 Connection.isValid() 判斷資料庫連線是否處於作用中狀態時，會提交查詢。 ## enableFetchRingBuffer + **預設值** — true + **資料類型** — 布林值 此選項指定驅動程式會在個別執行緒上使用環形緩衝器來擷取資料列。fetchRingBufferSize 參數會指定環形緩衝區的大小。 環形緩衝區會在 JDBC 中實作自動記憶體管理，以防止在資料擷取操作期間out-of-memory(OOM) 錯誤。環形緩衝區會即時監控緩衝資料的實際大小，確保驅動程式的總記憶體用量保持在定義的限制內。達到緩衝容量時，驅動程式會暫停資料擷取操作，防止記憶體溢出，而不需要手動介入。此內建防護功能可自動消除 OOM 錯誤，使用者不需要設定。 如果交易偵測到包含多個以分號分隔的 SQL 命令的陳述式，該交易的擷取環形緩衝區會設為 false。enableFetchRingBuffer 的值不會變更。 此為選用參數。 **注意** 當環形緩衝區停用且擷取大小未正確設定時，可能會發生out-of-memory(OOM) 問題。如需設定擷取大小的詳細資訊，請參閱[此處](https://docs.aws.amazon.com/redshift/latest/dg/set-the-JDBC-fetch-size-parameter.html)。 ## enableMultiSqlSupport + **預設值** — true + **資料類型** — 布林值 此選項會指定是否要在陳述式中處理以分號分隔的多個 SQL 命令。 此為選用參數。 您可以指定下列值： **true** 驅動程式會在陳述式物件中處理以分號分隔的多個 SQL 命令。 **false** 驅動程式會在單一陳述式中傳回多個 SQL 命令的錯誤。 ## fetchRingBufferSize + **預設值** — 1G + **資料類型** — 字串 此選項會指定在擷取結果集時使用的環形緩衝區大小。您可以指定以位元組為單位的大小，例如 1K 表示 1 KB、5000 表示 5,000 個位元組、1M 表示 1 MB、1G 表示 1 GB，依此類推。您也可以指定堆積記憶體的百分比。驅動程式會在達到限制時停止擷取資料列。當應用程式讀取資料列並釋放環形緩衝區中的空間時，擷取操作便會繼續。 此為選用參數。 ## ForceLowercase + **預設值** — false + **資料類型** — 布林值 此選項會指定在使用單一登入身分驗證時，驅動程式是否會將從身分提供者傳送至 Amazon Redshift 的所有資料庫群組 (DbGroups) 轉換為小寫。 此為選用參數。 **true** 驅動程式會將從身分提供者傳送的所有資料庫群組轉換為小寫。 **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\$1Client\$1Display\$1Name + **預設值** - Amazon Redshift JDBC 驅動器 + **資料類型** — 字串 使用 BrowserIdcAuthPlugin 的用戶端要使用的顯示名稱。 此為選用參數。 ## Idc\$1Region + **預設值** — 無 + **資料類型** — 字串 IAM Identity Center 執行個體所在的 AWS 區域。 只有在 plugin\$1name 組態選項中使用 `BrowserIdcAuthPlugin` 進行身分驗證時，才需要此參數。 ## IdP\$1Host + **預設值** — 無 + **資料類型** — 字串 您用來對 Amazon Redshift 進行身分驗證的 IdP (身分提供者) 主機。這可以在連線字串或設定檔中指定。 此為選用參數。 ## IdP\$1Partition + **預設值** — 無 + **資料類型** — 字串 指定設定身分提供者 (IdP) 的雲端分割區。這會決定驅動程式連線到哪個 IdP 身分驗證端點。 如果此參數保留空白，驅動程式會預設為商業分割區。可能值為： + `us-gov`：如果您的 IdP 是在 Azure Government 中設定，請使用此值。例如，Azure AD Government 會使用端點 `login.microsoftonline.us`。 + `cn`：如果您的 IdP 是在中國雲端分割區中設定，請使用此值。例如，Azure AD 中國使用端點 `login.chinacloudapi.cn`。 此為選用參數。 ## IdP\$1Port + **預設值** — 無 + **資料類型** — 字串 IdP (身分提供者) 使用的連接埠。您可以在連線字串或設定檔中指定連接埠。預設連接埠為 5439。根據您在建立、修改或遷移叢集時所選取的連接埠而定，允許存取選取的連接埠。 此為選用參數。 ## IdP\$1Tenant + **預設值** — 無 + **資料類型** — 字串 Amazon Redshift 應用程式的 Azure AD 租用戶 ID。 如果透過 Azure AD 服務進行驗證，則需要此參數。 ## IdP\$1Response\$1Timeout + **預設值** — 120 + **資料類型** — 整數 透過瀏覽器外掛程式使用 SAML 或 Azure AD 服務時，驅動程式等待身分提供者傳回 SAML 回應的時間長度 (以秒為單位)。 此為選用參數。 ## IniFile + **預設值** — 無 + **資料類型** — 字串 .ini 檔案的完整路徑 (包括檔案名稱)。例如： ``` IniFile="C:\tools\rsjdbc.ini" ``` 如需 .ini 檔案的相關資訊，請參閱[建立 JDBC 驅動器 2.x 版的初始化 (.ini) 檔案](jdbc20-ini-file.md)。 此為選用參數。 ## IniSection + **預設值** — 無 + **資料類型** — 字串 .ini 檔案中包含組態選項之區段的名稱。如需 .ini 檔案的相關資訊，請參閱[建立 JDBC 驅動器 2.x 版的初始化 (.ini) 檔案](jdbc20-ini-file.md)。 下列範例會指定 .ini 檔案的 [Prod] 區段： ``` IniSection="Prod" ``` 此為選用參數。 ## isServerless + **預設值** — false + **資料類型** — 布林值 此選項會指定 Amazon Redshift 端點主機是否為無伺服器執行個體。驅動程式會嘗試從給定的主機偵測此參數。如果您使用 Network Load Balancer (NLB)，則驅動程式無法偵測此參數，因此您可以在此設定此參數。 此為選用參數。 **true** Amazon Redshift 端點主機是無伺服器執行個體。 **false** Amazon Redshift 端點主機是已佈建的叢集。 ## Issuer\$1Url + **預設值** — 無 + **資料類型** — 字串 指向 AWS IAM Identity Center 伺服器的執行個體端點。 只有在 plugin\$1name 組態選項中使用 `BrowserIdcAuthPlugin` 進行身分驗證時，才需要此參數。 ## Listen\$1Port + **預設值** — 7890 + **資料類型** — 整數 透過瀏覽器外掛程式使用 SAML、Azure AD 或 AWS Identity Center 服務時，驅動程式用來從身分提供者或授權碼接收 SAML 回應的連接埠。 此為選用參數。 ## Login\$1URL + **預設值** — 無 + **資料類型** — 字串 透過瀏覽器外掛程式使用 SAML 或 Azure AD 服務時，身分提供者網站上資源的 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 應用程式相容，建議您輸入另一個反斜線來逸出檔案路徑中的反斜線 (\$1)。 此為選用參數。 ## OverrideSchemaPatternType + **預設值** — Null + **資料類型** — 整數 此選項會指定是否要覆寫 getTables 呼叫中使用的查詢類型。 **0** 無結構描述通用查詢 **1** 本機結構描述查詢 **2** 外部結構描述查詢 此為選用參數。 ## Partner\$1SPID + **預設值** — 無 + **資料類型** — 字串 使用 PingFederate 服務驗證連線時，要使用的合作夥伴 SPID (服務提供者 ID) 值。 此為選用參數。 ## 密碼 + **預設值** — 無 + **資料類型** — 字串 透過 IDP 使用 IAM 身分驗證進行連線時，這是 IDP\$1Host 伺服器的密碼。使用標準身分驗證時，這可以用於 Amazon Redshift 資料庫密碼，而不是 PWD。 此為選用參數。 ## Plugin\$1Name + **預設值** — 無 + **資料類型** — 字串 用來實作特定憑證提供者外掛程式的完整類別名稱。 此為選用參數。 支援的提供者選項如下： + **`AdfsCredentialsProvider`** - Active Directory Federation Service。 + **`AzureCredentialsProvider`** - Microsoft Azure Active Directory (AD) 服務。 + **`BasicJwtCredentialsProvider`** - JSON Web Tokens (JWT) 服務。 + **`BasicSamlCredentialsProvider`** — 可與許多 SAML 服務提供者搭配使用的安全性聲明標記語言 (SAML) 憑證。 + **`BrowserAzureCredentialsProvider`** - 瀏覽器 Microsoft Azure Active Directory (AD) 服務。 + **`BrowserAzureOAuth2CredentialsProvider`** - 適用於原生身分驗證的瀏覽器 Microsoft Azure Active Directory (AD) 服務。 + **`BrowserIdcAuthPlugin` ** – 使用 IAM Identity Center AWS 的授權外掛程式。 + **`BrowserSamlCredentialsProvider`** - 適用於 SAML 服務的瀏覽器 SAML，例如 Okta、Ping 或 ADFS。 + **`IdpTokenAuthPlugin`** – 從連結至 IAM Identity Center AWS 的任何 Web 身分提供者接受 IAM Identity Center 字符或 OpenID Connect (OIDC) JSON 型身分字符 (JWT) AWS 的授權外掛程式。 + **`OktaCredentialsProvider`** - Okta 服務。 + **`PingCredentialsProvider`** - PingFederate 服務。 ## PORT + **預設值** — Null + **資料類型** — 整數 要連線到之 Amazon Redshift 伺服器的連接埠。您可以使用此選項在 JDBC 連線 URL 中指定連接埠。 此為選用參數。 ## Preferred\$1Role + **預設值** — 無 + **資料類型** — 字串 您要在連線到 Amazon Redshift 期間擔任的 IAM 角色。 此為選用參數。 ## 設定檔 + **預設值** — 無 + **資料類型** — 字串 要用於 IAM 身分驗證之設定檔的名稱。此設定檔包含未在連線字串中指定的任何其他連線屬性。 此為選用參數。 ## PWD + **預設值** — 無 + **資料類型** — 字串 與您使用屬性 UID 提供的 Amazon Redshift 使用者名稱對應的密碼。 此為選用參數。 ## queryGroup + **預設值** — Null + **資料類型** — 字串 此選項會在執行期將查詢指派給適當的查詢群組，以便將查詢指派給佇列。系統會針對工作階段設定查詢群組。在連線上執行的所有查詢都屬於此查詢群組。 此為選用參數。 ## readOnly + **預設值** — false + **資料類型** — 布林值 此屬性會指定驅動程式是否處於唯讀模式。 此為選用參數。 **true** 連線處於唯讀模式，且無法寫入到資料存放區。 **false** 連線不處於唯讀模式，可以寫入到資料存放區。 ## 區域 + **預設值** — Null + **資料類型** — 字串 此選項指定叢集所在的 AWS 區域。如果您指定 StsEndPoint 選項，系統會忽略區域選項。Redshift `GetClusterCredentials` API 操作也會使用區域選項。 此為選用參數。 ## reWriteBatchedInserts + **預設值** — false + **資料類型** — 布林值 此選項可實現最佳化，以重寫相容的 INSERT 陳述式並將這些陳述式合併為批次。 此為選用參數。 ## reWriteBatchedInsertsSize + **預設值** — 128 + **資料類型** — 整數 此選項可實現最佳化，以重寫相容的 INSERT 陳述式並將這些陳述式合併為批次。此值必須以 2 的冪呈指數增加。 此為選用參數。 ## roleArn + **預設值** — 無 + **資料類型** — 字串 角色的 Amazon Resource Name (ARN)。當您指定 Plugin\$1Name 選項的 BasicJwtCredentialsProvider 時，請務必指定此參數。請以下列格式指定 ARN： `arn:partition:service:region:account-id:resource-id` 如果您指定 Plugin\$1Name 選項的 BasicJwtCredentialsProvider，則必須有此參數。 ## roleSessionName + **預設值** — jwt\$1redshift\$1session + **資料類型** — 字串 擔任角色工作階段的識別碼。一般來說，您會傳遞與應用程式使用者相關聯的名稱或識別碼。應用程式使用的臨時安全憑證會與該使用者相關聯。當您指定 Plugin\$1Name 選項的 BasicJwtCredentialsProvider 時，您可以指定此參數。 此為選用參數。 ## scope + **預設值** — 無 + **資料類型** — 字串 使用者可以同意的範圍清單 (以空格分隔)。指定這個參數可讓您的 Microsoft Azure 應用程式針對您想要呼叫的 API 取得同意。當您為 Plugin\$1Name 選項指定 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 + **資料類型** — 字串 此選項會指定用於建立通訊端的通訊端 Factory。 此為選用參數。 ## socketTimeout + **預設值** — 0 + **資料類型** — 整數 在通訊端讀取操作期間，逾時之前等待的秒數。如果操作所花的時間超過此臨界值，連線會關閉。當此屬性設為 0 時，連線不會逾時。 此為選用參數。 ## SSL + **預設值** — TRUE + **資料類型** — 字串 使用此屬性可開啟或關閉連線的 SSL。 此為選用參數。 您可以指定下列值： **TRUE** 驅動程式會透過 SSL 連線到伺服器。 **FALSE** 驅動程式會以不使用 SSL 的方式連線到伺服器。IAM 身分驗證不支援此選項。 或者，您也可以設定 AuthMech 屬性。 ## SSL\$1Insecure + **預設值** — true + **資料類型** — 字串 此屬性會指出是否應驗證 IDP 主機伺服器憑證。 此為選用參數。 您可以指定下列值： **true** 驅動程式不會檢查 IDP 伺服器憑證的真實性。 **false** 驅動程式會檢查 IDP 伺服器憑證的真實性。 ## SSLCert + **預設值** — 無 + **資料類型** — 字串 包含可在使用 SSL 時驗證 Amazon Redshift 伺服器執行個體之其他受信任 CA 憑證的 .pem 或 .crt 檔案的完整路徑。 如果指定 SSLKey，則需要此參數。 ## SSLFactory + **預設值** — 無 + **資料類型** — 字串 在不使用伺服器憑證的情況下，透過 TLS/SSL 連線至伺服器時要使用的 SSL Factory。 ## 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 保持連線。 ## token + **預設值** — 無 + **資料類型** — 字串 IAM Identity Center AWS 提供存取字符或由與 IAM Identity Center 連結的 Web 身分提供者提供的 OpenID Connect (OIDC) JSON Web Token AWS (JWT)。您的應用程式必須透過使用 IAM Identity Center AWS 或與 IAM Identity Center 連結的身分提供者來驗證應用程式的使用者來產生此字符 AWS 。 此參數適用於 `IdpTokenAuthPlugin`。 ## token\$1type + **預設值** — 無 + **資料類型** — 字串 `IdpTokenAuthPlugin` 中使用的權仗類型。 您可以指定下列值： **ACCESS\$1TOKEN** 如果您使用 AWS IAM Identity Center 提供的存取權杖，請輸入此選項。 **EXT\$1JWT** 如果您使用與 AWS IAM Identity Center 整合的 Web 型身分提供者所提供的 OpenID Connect (OIDC) JSON Web Token (JWT)，請輸入此項。 此參數適用於 `IdpTokenAuthPlugin`。 ## UID + **預設值** — 無 + **資料類型** — 字串 您用來存取資料庫的資料庫使用者名稱。 此為必要參數。 ## 使用者 + **預設值** — 無 + **資料類型** — 字串 透過 IDP 使用 IAM 身分驗證進行連線時，這是 idp\$1host 伺服器的使用者名稱。使用標準身分驗證時，這可以用於 Amazon Redshift 資料庫使用者名稱。 此為選用參數。 ## webIdentityToken + **預設值** — 無 + **資料類型** — 字串 由身分提供者提供的 OAuth 2.1 存取權杖或 OpenID Connect ID 權杖。您的應用程式必須透過使用 Web 身分提供者對應用程式的使用者進行身分驗證來獲取此權杖。當您指定 Plugin\$1Name 選項的 BasicJwtCredentialsProvider 時，請務必指定此參數。 如果您指定 Plugin\$1Name 選項的 BasicJwtCredentialsProvider，則必須有此參數。