Amazon Redshift Python 連接器的組態選項 - Amazon Redshift
access_key_idallow_db_user_overrideapp_nameapplication_nameauth_profileauto_createclient_idclient_secretcluster_identifiercredentials_providerdatabasedatabase_metadata_current_db_onlydb_groupsdb_userendpoint_urlgroup_federationhostiamiam_disable_cacheidc_client_display_nameidc_regionidp_partitionidpPortidp_response_timeoutidp_tenantissuer_urllisten_portlogin_urlmax_prepared_statementsnumeric_to_floatpartner_sp_id密碼portpreferred_roleprincipal_arnprofileprovider_nameregionrole_arnrole_session_namescopesecret_access_key_idsession_tokenserverless_acct_idserverless_work_groupsslssl_insecuresslmodetcp_keepalivetcp_keepalive_counttcp_keepalive_intervaltcp_keepalive_idletimeouttokentoken_typeuserweb_identity_token

Amazon Redshift 自 2025 年 11 月 1 日起不再支援建立新的 Python UDF。如果您想要使用 Python UDF，請在該日期之前建立 UDF。現有 Python UDF 將繼續正常運作。如需詳細資訊，請參閱部落格文章。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

Amazon Redshift Python 連接器的組態選項

接下來，您可以找到可為 Amazon Redshift Python 連接器指定之選項的描述。除非另有指明，否則以下選項適用於最新推出的連接器版本。

access_key_id

  • 預設值 — 無

  • 資料類型 — 字串

針對 IAM 資料庫身分驗證而設定之 IAM 角色或使用者的存取金鑰。

此為選用參數。

allow_db_user_override

  • 預設值 — False

  • 資料類型 — 布林值

True

指定連接器會使用安全性聲明標記語言 (SAML) 聲明中的 DbUser 值。

False

指定使用 DbUser 連線參數中的值。

此為選用參數。

app_name

  • 預設值 — 無

  • 資料類型 — 字串

用於身分驗證之身分提供者 (IdP) 應用程式的名稱。

此為選用參數。

application_name

  • 預設值 — 無

  • 資料類型 — 字串

要傳遞至 Amazon Redshift 以進行稽核的用戶端應用程式名稱。您提供的應用程式名稱會出現在 SYS_CONNECTION_LOG 資料表的 'application_name' 欄中。此名稱有助於在偵錯問題時，追蹤連線來源並進行故障診斷。

此為選用參數。

auth_profile

  • 預設值 — 無

  • 資料類型 — 字串

具有 JSON 形式連線屬性之 Amazon Redshift 身分驗證設定檔的名稱。如需有關命名連線參數的詳細資訊，請參閱 RedshiftProperty 類別。RedshiftProperty 類別會儲存最終使用者提供的連線參數，以及 (適用的話) 在 IAM 身分驗證程序 (例如臨時 IAM 憑證) 進行期間產生的連線參數。如需詳細資訊，請參閱 RedshiftProperty 類別。

此為選用參數。

auto_create

  • 預設值 — False

  • 資料類型 — 布林值

此值會指出是否要在使用者不存在時建立使用者。

此為選用參數。

client_id

  • 預設值 — 無

  • 資料類型 — 字串

來自 Azure IdP 的用戶端 ID。

此為選用參數。

client_secret

  • 預設值 — 無

  • 資料類型 — 字串

來自 Azure IdP 的用戶端祕密。

此為選用參數。

cluster_identifier

  • 預設值 — 無

  • 資料類型 — 字串

Amazon Redshift 叢集的叢集識別碼。

此為選用參數。

credentials_provider

  • 預設值 — 無

  • 資料類型 — 字串

用於以 Amazon Redshift 進行驗證的 IdP。有效值如下：

  • AdfsCredentialsProvider

  • AzureCredentialsProvider

  • BrowserAzureCredentialsProvider

  • BrowserAzureOAuth2CredentialsProvider

  • BrowserIdcAuthPlugin - 使用 AWS IAM Identity Center 的授權外掛程式。

  • BrowserSamlCredentialsProvider

  • IdpTokenAuthPlugin - 這是一種授權外掛程式，可接受 AWS IAM Identity Center 權杖，或來自任何連結至 AWS IAM Identity Center 的 Web 身分提供者的 OpenID Connect (OIDC) JSON 型身分權仗 (JWT)。

  • PingCredentialsProvider

  • OktaCredentialsProvider

此為選用參數。

database

  • 預設值 — 無

  • 資料類型 — 字串

要連線到之資料庫的名稱。

此為必要參數。

database_metadata_current_db_only

  • 預設值 — True

  • 資料類型 — 布林值

此值會指出應用程式是否支援多資料庫資料共用型錄。預設值 True 會指出應用程式不會為了回溯相容性而支援多資料庫資料共用型錄。

此為選用參數。

db_groups

  • 預設值 — 無

  • 資料類型 — 字串

DbUser 所指出的使用者針對目前的工作階段所加入之現有資料庫群組名稱的逗號分隔清單。

此為選用參數。

db_user

  • 預設值 — 無

  • 資料類型 — 字串

要與 Amazon Redshift 搭配使用的使用者 ID。

此為選用參數。

endpoint_url

  • 預設值 — 無

  • 資料類型 — 字串

Amazon Redshift 端點的 URL。此選項僅供 AWS 內部使用。

此為選用參數。

group_federation

  • 預設值 — False

  • 資料類型 — 布林值

此選項會指定是否使用 Amazon Redshift IDP 群組。

此為選用參數。

true

使用 Amazon Redshift 身分提供者 (IdP) 群組。

false

針對使用者聯合使用 STS API 和 GetClusterCredentials，並指定連線的 db_groups。

host

  • 預設值 — 無

  • 資料類型 — 字串

Amazon Redshift 叢集的主機名稱。

此為選用參數。

iam

  • 預設值 — False

  • 資料類型 — 布林值

會啟用 IAM 身分驗證。

此為必要參數。

iam_disable_cache

  • 預設值 — False

  • 資料類型 — 布林值

此選項會指定是否快取 IAM 憑證。預設會快取 IAM 憑證。當對於 API 閘道的請求遭到限流時，這可以提高效能。

此為選用參數。

idc_client_display_name

  • 預設值 - Amazon Redshift Python 連接器

  • 資料類型 — 字串

使用 BrowserIdcAuthPlugin 的用戶端要使用的顯示名稱。

此為選用參數。

idc_region

  • 預設值 — 無

  • 資料類型 — 字串

AWS IAM Identity Center 執行個體所在的 AWS 區域。

只有在 credentials_provider 組態選項中使用 BrowserIdcAuthPlugin 進行身分驗證時，才需要此參數。

idp_partition

  • 預設值 — 無

  • 資料類型 — 字串

設定 Idp (身分提供者) 所在的分割區。分割區是一組 AWS 區域。如需分割區的詳細資訊，請參閱 AWS 詞彙表 中的分割區。

如果此參數保留空白，Amazon Redshift 會預設為 AWS 標準分割區，其中包含所有商業 AWS 區域。可能的值如下：

  • us-gov - IdP 是在 AWS GovCloud (US) Regions 中設定。

  • cn - IdP 是在中國區域中設定。

此為選用參數。

idpPort

  • 預設值 — 7890

  • 資料類型 — 整數

IdP 會將 SAML 聲明傳送到的接聽連接埠。

此為必要參數。

idp_response_timeout

  • 預設值 — 120

  • 資料類型 — 整數

從 IdP 擷取 SAML 聲明的逾時。

此為必要參數。

idp_tenant

  • 預設值 — 無

  • 資料類型 — 字串

IdP 租用戶。

此為選用參數。

issuer_url

  • 預設值 — 無

  • 資料類型 — 字串

指向 AWS IAM Identity Center 伺服器的執行個體端點。

只有在 credentials_provider 組態選項中使用 BrowserIdcAuthPlugin 進行身分驗證時，才需要此參數。

listen_port

  • 預設值 — 7890

  • 資料類型 — 整數

透過瀏覽器外掛程式使用 SAML、Azure AD 或 AWS IAM Identity Center 服務時，驅動器用來接收來自身分提供者的 SAML 回應或授權碼的連接埠。

此為選用參數。

login_url

  • 預設值 — 無

  • 資料類型 — 字串

IdP 的單一登入 Url。

此為選用參數。

max_prepared_statements

  • 預設值 — 1000

  • 資料類型 — 整數

每個連線將快取的預備陳述式數量上限。將此參數設為 0 會停用快取機制。針對此參數輸入負數會將其設定為預設值。

此為選用參數。

numeric_to_float

  • 預設值 — False

  • 資料類型 — 布林值

此選項指定連接器是否會將數值資料類型值從 decimal.Decimal 轉換為浮點數。依預設，連接器會接收 decimal.Decimal 形式的數值資料類型值，且不會對值進行轉換。

對於需要精確度的使用案例，不建議您啟用 numeric_to_float，因為得到的結果可能會經過四捨五入。

如需 decimal.Decimal 以及其與浮點數之間權衡的相關資訊，請參閱 Python 網站上的小數 — 固定小數點和浮點數。

此為選用參數。

partner_sp_id

  • 預設值 — 無

  • 資料類型 — 字串

針對以 Ping 進行的身分驗證所使用的合作夥伴 SP ID。

此為選用參數。

密碼

  • 預設值 — 無

  • 資料類型 — 字串

用於身分驗證的密碼。

此為選用參數。

port

  • 預設值 — 5439

  • 資料類型 — 整數

Amazon Redshift 叢集的連接埠號碼。

此為必要參數。

preferred_role

  • 預設值 — 無

  • 資料類型 — 字串

目前連線偏好的 IAM 角色。

此為選用參數。

principal_arn

  • 預設值 — 無

  • 資料類型 — 字串

要為其產生政策之使用者或 IAM 角色的 Amazon Resource Name (ARN)。建議您將政策連接至角色，然後將角色指派給您的使用者以提供存取權。

此為選用參數。

profile

  • 預設值 — 無

  • 資料類型 — 字串

包含 AWS 憑證之 AWS 憑證檔案中所含設定檔的名稱。

此為選用參數。

provider_name

  • 預設值 — 無

  • 資料類型 — 字串

Redshift 原生身分驗證提供者的名稱。

此為選用參數。

region

  • 預設值 — 無

  • 資料類型 — 字串

叢集所在的 AWS 區域。

此為選用參數。

role_arn

  • 預設值 — 無

  • 資料類型 — 字串

呼叫者所擔任角色的 Amazon Resource Name (ARN)。JwtCredentialsProvider 所指出的提供者會使用此參數。

若為 JwtCredentialsProvider 提供者，此為必要參數。否則，此為選擇性參數。

role_session_name

  • 預設值 — jwt_redshift_session

  • 資料類型 — 字串

擔任角色工作階段的識別碼。一般來說，您會傳遞與應用程式使用者相關聯的名稱或識別碼。應用程式使用的臨時安全憑證會與該使用者相關聯。JwtCredentialsProvider 所指出的提供者會使用此參數。

此為選用參數。

scope

  • 預設值 — 無

  • 資料類型 — 字串

使用者可以同意的範圍清單 (以空格分隔)。指定這個參數可讓您的應用程式針對您想要呼叫的 API 取得同意。當您為 credentials_provider 選項指定 BrowserAzureOAuth2CredentialsProvider 時，便可以指定此參數。

BrowserAzureOAuth2CredentialsProvider 外掛程式需要此參數。

secret_access_key_id

  • 預設值 — 無

  • 資料類型 — 字串

針對 IAM 資料庫身分驗證而設定之 IAM 角色或使用者的私密存取金鑰。

此為選用參數。

session_token

  • 預設值 — 無

  • 資料類型 — 字串

針對 IAM 資料庫身分驗證而設定之 IAM 角色或使用者的存取金鑰。如果會使用臨時 AWS 憑證，則需要此參數。

此為選用參數。

serverless_acct_id

  • 預設值 — 無

  • 資料類型 — 字串

Amazon Redshift Serverless 帳戶 ID。

此為選用參數。

serverless_work_group

  • 預設值 — 無

  • 資料類型 — 字串

Amazon Redshift Serverless 工作群組名稱。

此為選用參數。

ssl

  • 預設值 — True

  • 資料類型 — 布林值

會啟用 Secure Sockets Layer (SSL)。

此為必要參數。

ssl_insecure

  • 預設值 — False

  • 資料類型 — 布林值

此值會指定是否要停用驗證 IdP 主機的伺服器 SSL 憑證。將此參數設定為 True 會停用驗證 IdP 主機的伺服器 SSL 憑證。建議您在生產環境中保留預設值 False。

此為選用參數。

sslmode

  • 預設值 — verify-ca

  • 資料類型 — 字串

連線至 Amazon Redshift 的安全。您可以指定下列任一項：

  • verify-ca

  • verify-full

此為必要參數。

tcp_keepalive

  • 預設值 — True

  • 資料類型 — 布林值

是否使用 TCP 保持連線來防止連線逾時。您可以指定下列值：

  • True：驅動器將使用 TCP 保持連線來防止連線逾時。

  • False：驅動器不會使用 TCP 保持連線。

此為選用參數。

tcp_keepalive_count

  • 預設值 — 無

  • 資料類型 — 整數

在判斷連線為非作用中之前，要傳送的未確認探查數目。例如，將值設定為 3，表示驅動器會先傳送 3 個未回應的保持連線封包，才確定連線非作用中。

如果未指定此參數，Amazon Redshift 會使用系統的預設值。

此為選用參數。

tcp_keepalive_interval

  • 預設值 — 無

  • 資料類型 — 整數

後續保持連線探查之間的間隔 (以秒為單位)，如果驅動器未在此間隔之前收到探查的確認。如果您指定此參數，其必須是正整數。

如果未指定此參數，Amazon Redshift 會使用系統的預設值。

此為選用參數。

tcp_keepalive_idle

  • 預設值 — 無

  • 資料類型 — 整數

無活動的持續時間 (以秒為單位)，經過這段時間後，驅動器會傳送第一個保持連線探查。例如，將值設定為 120，表示驅動器會等待 2 分鐘無活動的時間，才傳送第一個保持連線封包。如果您指定此參數，其必須是正整數。

如果未指定此參數，Amazon Redshift 會使用系統的預設值。

此為選用參數。

timeout

  • 預設值 — 無

  • 資料類型 — 整數

對伺服器的連線在逾時前要經過的秒數。

此為選用參數。

token

  • 預設值 — 無

  • 資料類型 — 字串

AWS IAM Identity Center 提供的存取權仗，或是與 AWS IAM Identity Center 連結的 Web 身分提供者提供的 OpenID Connect (OIDC) JSON Web Token (JWT)。您的應用程式必須透過使用 AWS IAM Identity Center 或與 AWS IAM Identity Center 連結的身分提供者來驗證應用程式的使用者身分，來產生此權仗。

此參數適用於 IdpTokenAuthPlugin。

token_type

  • 預設值 — 無

  • 資料類型 — 字串

IdpTokenAuthPlugin 中使用的權仗類型。

您可以指定下列值：

ACCESS_TOKEN

如果您使用 AWS IAM Identity Center 提供的存取權杖，請輸入此項。

EXT_JWT

如果您使用與 AWS IAM Identity Center 整合的 Web 型身分提供者所提供的 OpenID Connect (OIDC) JSON Web Token (JWT)，請輸入此項。

此參數適用於 IdpTokenAuthPlugin。

user

  • 預設值 — 無

  • 資料類型 — 字串

用於身分驗證的使用者名稱。

此為選用參數。

web_identity_token

  • 預設值 — 無

  • 資料類型 — 字串

由身分提供者提供的 OAuth 2.0 存取權杖或 OpenID Connect ID 權杖。請確保您的應用程式會透過以 Web 身分提供者對應用程式的使用者進行驗證來取得此權杖。JwtCredentialsProvider 所指出的提供者會使用此參數。

若為 JwtCredentialsProvider 提供者，此為必要參數。否則，此為選擇性參數。