Amazon Redshift Python コネクタの設定オプション

以下に、Amazon Redshift Python コネクタに指定できるオプションの説明を示します。

access_key_id

IAM データベース認証用に設定された IAM ロールまたはユーザーのアクセスキー。

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

allow_db_user_override

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

app_name

認証に使用する アイデンティティ プロバイダー (IdP) アプリケーションの名前。

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

auth_profile

JSON としての接続プロパティを持つ Amazon Redshift 認証プロファイルの名前。接続パラメータの名前付けの詳細については、RedshiftPropertyクラスを参照してください。RedshiftPropertyクラスは、エンドユーザーから提供された接続パラメータや、必要に応じてIAM 認証プロセスで生成された接続パラメータ (一時的な IAM 認証情報など）を格納します。詳細については、[RedShiftProperty クラス]を参照してください。

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

auto_create

ユーザーが存在しない場合にユーザーを作成するかどうかを示す値。

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

client_id

Azure IdP からのクライアント ID。

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

client_secret

Azure IdP からのクライアントシークレット。

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

cluster_identifier

Amazon Redshift クラスターのクラスター識別子。

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

credentials_provider

Amazon Redshift での認証に使用される IdP。以下の値が有効です。

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

データベース

接続先のデータベースの名前。

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

database_metadata_current_db_only

アプリケーションがマルチデータベースデータ共有カタログをサポートしているかどうかを示す値。デフォルト値の True は、下位互換性のためにアプリケーションがマルチデータベースデータ共有カタログをサポートしていないことを示します。

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

db_groups

DbUser で示されるユーザーが現在のセッションで参加している既存のデータベースグループ名のコンマ区切りのリスト。

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

db_user

Amazon Redshift で使用するユーザー ID。

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

endpoint_url

Amazon Redshift エンドポイント URL。このオプションは、AWS内部使用の場合にのみ利用できます。

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

group_federation

このオプションは、Amazon Redshift IDP グループを使用するかどうかを指定します。

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

ホスト

Amazon Redshift クラスターのホスト名。

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

iam

IAM 認証が有効になっています。

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

iam_disable_cache

このオプションは、IAM 認証情報をキャッシュするかどうかを指定します。デフォルトでIAM 認証情報はキャッシュされます。これにより、API gateway へのリクエストがスロットルされた場合のパフォーマンスが向上します。

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

idc_client_display_name

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

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

idc_region

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

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

idpPort

IdP が SAML アサーションを送信する先のリッスンポートです。

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

idp_response_timeout

IdP から SAML アサーションを取得する際のタイムアウトです。

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

idp_tenant

IdP テナント。

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

issuer_url

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

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

listen_port

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

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

login_url

IdP のシングルサインオン URL。

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

max_prepared_statements

同時に開くことができる準備されたステートメントの最大数です。

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

numeric_to_float

このオプションは、コネクタが数値データ型の値を decimal.Decimal から float に変換するかどうかを指定します。デフォルトでは、コネクタは数値データ型の値を decimal.Decimal で受け取り、変換しません。

精度が求められるユースケースでは、結果が丸められる場合もあるため、numeric_to_float を有効にすることは推奨されません。

decimal.Decimal および decimal.Decimal と float 間のトレードオフの詳細については、Python ウェブサイトの「decimal — Decimal fixed point and floating point arithmetic」(10 進数 — 固定小数点数と浮動小数点数の演算) を参照してください。

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

partner_sp_id

Ping による認証に使用されるパートナー SP IDです。

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

password

認証に使用されるパスワード。

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

port

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

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

Secure Sockets Layer (SSL) が有効になっています。

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

ssl_insecure

IdP ホストサーバー証明書を検証するかどうかを指定する値。

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

sslmode

Amazon Redshift への接続のセキュリティ。次の値のいずれかを指定できます。

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

timeout

サーバーへの接続がタイムアウトするまで待つ秒数。

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

トークン

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

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

token_type

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

次の値を指定できます。

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

ユーザー

認証に使用するユーザー名。

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

web_identity_token

ID プロバイダによって提供される OAuth 2.0 アクセストークンまたは OpenID Connect ID トークン。アプリケーションを使用しているユーザーをウェブアイデンティティプロバイダーで認証することで、アプリケーションがこのトークンを取得するようにします。JwtCredentialsProviderで示されるプロバイダーはこのパラメータを使用します。

JwtCredentialsProviderプロバイダーの場合、このパラメータは必須です。それ以外の場合、このパラメータはオプションです。