Amazon Redshift Python 連接器的組態選項

接下來，您可以找到可為 Amazon Redshift Python 連接器指定之選項的描述。

access_key_id

• 預設值 — 無

• 資料類型 — 字串

為IAM資料庫驗證設定之IAM角色或使用者的存取金鑰。

此為選用參數。

allow_db_user_override

• 預設值 — False

• 資料類型 — 布林值

True

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

False

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

此為選用參數。

app_name

• 預設值 — 無

• 資料類型 — 字串

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

此為選用參數。

auth_profile

• 預設值 — 無

• 資料類型 — 字串

具有連線屬性為的 Amazon Redshift 身份驗證設定檔的名稱JSON。如需有關命名連線參數的詳細資訊，請參閱 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身分識別中心。

• BrowserSamlCredentialsProvider

• IdpTokenAuthPlugin-一個授權插件，接受 AWS IAM身份中心令牌或JSON基於 OpenID Connect（OIDCJWT）的身份令牌（）來自鏈接到 AWS IAM身分識別中心。

• 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

GetClusterCredentials 針對使用STSAPI者聯合使用和，並指定連線的 db_group。

託管

• 預設值 — 無

• 資料類型 — 字串

Amazon Redshift 叢集的主機名稱。

此為選用參數。

iam

• 預設值 — False

• 資料類型 — 布林值

IAM驗證已啟用。

此為必要參數。

iam_disable_cache

• 預設值 — False

• 資料類型 — 布林值

此選項指定是否快取IAM認證。依預設，會快取IAM認證。如此可在限制API閘道的要求時提升效能。

此為選用參數。

ID 用戶端顯示名稱

• 預設值 — Amazon Redshift Python 連接器

• 資料類型 — 字串

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

此為選用參數。

IDC 區域

• 預設值 — 無

• 資料類型 — 字串

所以此 AWS 地區，其中 AWS IAM身分識別中心執行個體所在。

只有在使用憑證 _ 提供者組態選項BrowserIdcAuthPlugin中進行驗證時，才需要此參數。

idpPort

• 預設值 — 7890

• 資料類型 — 整數

IdP 傳送SAML宣告的監聽連接埠。

此為必要參數。

idp_response_timeout

• 預設值 — 120

• 資料類型 — 整數

從 IdP 擷取SAML宣告的逾時。

此為必要參數。

idp_tenant

• 預設值 — 無

• 資料類型 — 字串

IdP 租用戶。

此為選用參數。

發行者網址

• 預設值 — 無

• 資料類型 — 字串

指向 AWS IAM識別中心伺服器的執行個體端點。

只有在使用憑證 _ 提供者組態選項BrowserIdcAuthPlugin中進行驗證時，才需要此參數。

listen_port

• 預設值 — 7890

• 資料類型 — 整數

驅動程式在使SAML用 Azure AD 或時用來接收來自身分識別提供者或授權碼SAML回應的連接埠 AWS IAM身分識別中心服務透過瀏覽器外掛程式

此為選用參數。

login_url

• 預設值 — 無

• 資料類型 — 字串

IdP 的單一登入 Url。

此為選用參數。

max_prepared_statements

• 預設值 — 1000

• 資料類型 — 整數

可同時開啟的預備陳述式數量上限。

此為必要參數。

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 資源名稱 (ARN)。建議您將政策連接至角色，然後將角色指派給您的使用者以提供存取權。

此為選用參數。

profile

• 預設值 — 無

• 資料類型 — 字串

設定檔的名稱 AWS 認證檔案，其中包含 AWS 認證。

此為選用參數。

provider_name

• 預設值 — 無

• 資料類型 — 字串

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

此為選用參數。

region

• 預設值 — 無

• 資料類型 — 字串

所以此 AWS 區域 叢集所在的位置。

此為選用參數。

role_arn

• 預設值 — 無

• 資料類型 — 字串

呼叫者假設的角色的 Amazon 資源名稱 (ARN)。JwtCredentialsProvider 所指出的提供者會使用此參數。

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

role_session_name

• 預設值 — jwt_redshift_session

• 資料類型 — 字串

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

此為選用參數。

scope

• 預設值 — 無

• 資料類型 — 字串

使用者可以同意的範圍清單 (以空格分隔)。您可以指定此參數，讓您的應用程式可以取APIs得您要呼叫的同意。當您指定認證 _ BrowserAzure OAuth2CredentialsProvider 提供者選項時，您可以指定此參數。

此參數是 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

• 資料類型 — 布林值

安全通訊端層 (SSL) 已啟用。

此為必要參數。

ssl_insecure

• 預設值 — True

• 資料類型 — 布林值

此值會指定是否要驗證 IdP 主機伺服器憑證。

此為選用參數。

sslmode

• 預設值 — verify-ca

• 資料類型 — 字串

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

• verify-ca

• verify-full

此為必要參數。

timeout

• 預設值 — 無

• 資料類型 — 整數

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

此為選用參數。

token

• 預設值 — 無

• 資料類型 — 字串

同時 AWS IAM身份中心提供的訪問令牌或 OpenID Connect（OIDC）JSON網絡令牌（JWT）由與鏈接的網絡身份提供商提供 AWS IAM身分識別中心。您的應用程序必須通過對應用程序的用戶進行身份驗證來生成此令牌 AWS IAM身分識別中心或身分識別提供者 AWS IAM身分識別中心。

此參數可搭配使用IdpTokenAuthPlugin。

令牌類型

• 預設值 — 無

• 資料類型 — 字串

正在中使用的權杖類型IdpTokenAuthPlugin。

您可以指定下列值：

ACCESS_TOKEN

如果您使用 AWS IAM身分識別中心提供存取權杖。

EXT_JWT

如果您使用 OpenID Connect (OIDC) JSON 網頁權杖 (JWT) 由網頁型身分提供者所提供且已整合，請輸入此選項 AWS IAM身分識別中心。

此參數可搭配使用IdpTokenAuthPlugin。

使用者

• 預設值 — 無

• 資料類型 — 字串

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

此為選用參數。

web_identity_token

• 預設值 — 無

• 資料類型 — 字串

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

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