Amazon Redshift は、パッチ 198 以降、新しい Python UDF の作成をサポートしなくなります。既存の 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/)を参照してください。

# Amazon Redshift Python コネクタの設定オプション
<a name="python-configuration-options"></a>

以下に、Amazon Redshift Python コネクタに指定できるオプションの説明を示します。以下のオプションは、特に指定がない限り、利用可能な最新のコネクタバージョンに適用されます。

## access\$1key\$1id
<a name="python-access-key-id-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## allow\$1db\$1user\$1override
<a name="python-allow-db-user-override-option"></a>
+ **デフォルト値** – false
+ **データ型** – ブール型

正  
コネクタが、`DbUser`Security Assertion Markup Language (SAML) アサーションの値を使用することを指定します。

誤  
`DbUser`接続パラメータの値を使用することを指定します。

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

## app\$1name
<a name="python-app-name-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## application\$1name
<a name="python-application_name-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

監査目的のために Amazon Redshift に渡すクライアントアプリケーションの名前。指定したアプリケーション名は、[SYS\$1CONNECTION\$1LOG](https://docs.aws.amazon.com/redshift/latest/dg/SYS_CONNECTION_LOG.html) テーブルの「application\$1name」列に表示されます。これにより、問題をデバッグするときに接続ソースを追跡およびトラブルシューティングできます。

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

## auth\$1profile
<a name="python-auth-profile-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

JSON としての接続プロパティを持つ Amazon Redshift 認証プロファイルの名前。接続パラメータの名前付けの詳細については、`RedshiftProperty`クラスを参照してください。`RedshiftProperty`クラスは、エンドユーザーから提供された接続パラメータや、必要に応じてIAM 認証プロセスで生成された接続パラメータ (一時的な IAM 認証情報など）を格納します。詳細については、[[RedShiftProperty クラス](https://github.com/aws/amazon-redshift-python-driver/blob/master/redshift_connector/redshift_property.py#L9)]を参照してください。

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

## auto\$1create
<a name="python-auto-create-option"></a>
+ **デフォルト値** – false
+ **データ型** – ブール型

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

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

## client\$1id
<a name="python-client-id-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## client\$1secret
<a name="python-client-secret-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## cluster\$1identifier
<a name="python-cluster-identifier-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## credentials\$1provider
<a name="python-credential-provider-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

Amazon Redshift での認証に使用される IdP。以下の値が有効です。
+ `AdfsCredentialsProvider`
+ `AzureCredentialsProvider`
+ `BrowserAzureCredentialsProvider`
+ `BrowserAzureOAuth2CredentialsProvider`
+ `BrowserIdcAuthPlugin` - AWS IAM アイデンティティセンターを使用する認可プラグイン。
+ `BrowserSamlCredentialsProvider`
+ `IdpTokenAuthPlugin` - AWS IAM アイデンティティセンターのトークン、または AWS IAM アイデンティティセンターにリンクされているウェブ ID プロバイダーからの OpenID Connect (OIDC) JSON ベースの ID トークン (JWT) を受け入れる認可プラグイン。
+ `PingCredentialsProvider`
+ `OktaCredentialsProvider`

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

## データベース
<a name="python-database-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## database\$1metadata\$1current\$1db\$1only
<a name="python-database-metadata-current-db-only-option"></a>
+ **デフォルト値** – true
+ **データ型** – ブール型

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

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

## db\$1groups
<a name="python-db-groups-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## db\$1user
<a name="python-db-user-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## endpoint\$1url
<a name="python-endpoint-url-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## group\$1federation
<a name="python-group-federation-option"></a>
+ **デフォルト値** – false
+ **データ型** – ブール型

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

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

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

**false**  
ユーザーフェデレーションに STS API と GetClusterCredentials を使用して、接続に **db\$1groups** を指定します。

## ホスト
<a name="python-host-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## iam
<a name="python-iam-option"></a>
+ **デフォルト値** – false
+ **データ型** – ブール型

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

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

## iam\$1disable\$1cache
<a name="python-iam-disable-cache-option"></a>
+ **デフォルト値** – false
+ **データ型** – ブール型

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

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

## idc\$1client\$1display\$1name
<a name="python-idc_client_display_name-option"></a>
+ **デフォルト値** — Amazon Redshift Python コネクタ
+ **データ型** - 文字列

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

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

## idc\$1region
<a name="python-idc_region"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## idp\$1partition
<a name="python-idp_partition-option"></a>
+ **デフォルト値** - なし
+ **データ型** – 文字列

ID プロバイダー (IdP) が設定されているクラウドパーティションを指定します。これにより、ドライバーが接続する IdP 認証エンドポイントが決まります。

このパラメータを空白のままにすると、ドライバーはデフォルトで商用パーティションを使用します。可能な値は以下のとおりです。
+  `us-gov`: IdP が Azure Government で設定されている場合は、この値を使用します。例えば、Azure AD Government はエンドポイント `login.microsoftonline.us` を使用します。
+  `cn`: IdP が中国のクラウドパーティションで設定されている場合は、この値を使用します。例えば、Azure AD China はエンドポイント `login.chinacloudapi.cn` を使用します。

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

## idpPort
<a name="python-idp-port-option"></a>
+ **デフォルト値**— 7890
+ **データ型** – 整数

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

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

## idp\$1response\$1timeout
<a name="python-idp-response-timeout-option"></a>
+ **デフォルト値** – 120
+ **データ型** – 整数

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

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

## idp\$1tenant
<a name="python-idp-tenant-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

IdP テナント。

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

## issuer\$1url
<a name="python-issuer_url"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## listen\$1port
<a name="python-listen-port-option"></a>
+ **デフォルト値**— 7890
+ **データ型** – 整数

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

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

## login\$1url
<a name="python-login-url-option"></a>
+ **デフォルト値** - なし
+ **データ型** – 文字列

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

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

## max\$1prepared\$1statements
<a name="python-max-prepared-statements-option"></a>
+ **デフォルト値** – 1000
+ **データ型** – 整数

接続ごとにキャッシュされる準備済みステートメントの最大数です。このパラメータを 0 に設定すると、キャッシュメカニズムが無効になります。このパラメータに負の数を入力すると、デフォルト値に設定されます。

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

## numeric\$1to\$1float
<a name="python-numeric-to-float-option"></a>
+ **デフォルト値** – false
+ **データ型** – ブール型

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

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

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

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

## partner\$1sp\$1id
<a name="python-partner-sp-id-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## password
<a name="python-password-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## ポート
<a name="python-port-option"></a>
+ **デフォルト値** — 5439
+ **データ型** – 整数

Amazon Redshift クラスターのポートナンバー。

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

## preferred\$1role
<a name="python-preferred-role-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

現在の接続に優先される IAM ロール。

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

## principal\$1arn
<a name="python-principal-arn-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

ポリシーを生成する対象のユーザーまたは IAM ロールの Amazon リソースネーム (ARN)。ロールにポリシーをアタッチし、そのロールをユーザーに割り当ててアクセスを許可することをお勧めします。

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

## profile
<a name="python-profile-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

AWS認証情報を含むAWS認証情報ファイル内のプロファイルの名前。

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

## provider\$1name
<a name="python-provider_name-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

Redshift ネイティブ認証プロバイダの名前です。

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

## リージョン
<a name="python-region-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

クラスターが配置されているAWS リージョン。

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

## role\$1arn
<a name="python-role-arn-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

発信者が想定しているロールの Amazon リソースネーム (ARN)です。このパラメーターは、`JwtCredentialsProvider`で示されるプロバイダーが使用します。

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

## role\$1session\$1name
<a name="python-role-session-name-option"></a>
+ **デフォルト値** – jwt\$1redshift\$1session
+ **データ型** - 文字列

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

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

## scope
<a name="python-scope-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## secret\$1access\$1key\$1id
<a name="python-secret-access-key-id-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## session\$1token
<a name="python-session-token-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

IAM データベース認証用に設定された IAM ロールまたはユーザーのアクセスキー。このパラメータは、一時的なAWS認証情報を使用している場合に必要です。

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

## serverless\$1acct\$1id
<a name="python-serverless-acct-id-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

Amazon Redshift Serverless アカウント ID。

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

## serverless\$1work\$1group
<a name="python-serverless-work-group-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

Amazon Redshift Serverless ワークグループ名。

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

## ssl
<a name="python-ssl-option"></a>
+ **デフォルト値** – true
+ **データ型** – ブール型

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

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

## ssl\$1insecure
<a name="python-ssl-insecure-option"></a>
+ **デフォルト値** – false
+ **データ型** – ブール型

IdP ホストのサーバー SSL 証明書の検証を無効にするかどうかを指定する値。このパラメータを True に設定すると、IdP ホストのサーバー SSL 証明書の検証が無効になります。本番環境では、デフォルト値の False のままにしておくことを推奨します。

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

## sslmode
<a name="python-sslmode-option"></a>
+ **デフォルト値** – verify-ca
+ **データ型** - 文字列

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

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

## tcp\$1keepalive
<a name="python-tcp_keepalive-option"></a>
+ **デフォルト値** – true
+ **データ型** – ブール型

TCP キープアライブを使用して接続がタイムアウトしないようにするかどうか。次の値を指定できます。
+ True: ドライバーは、TCP キープアライブを使用して、接続がタイムアウトしないようにします。
+ False: ドライバーは TCP キープアライブを使用しません。

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

## tcp\$1keepalive\$1count
<a name="python-tcp_keepalive_count-option"></a>
+ **デフォルト値** - なし
+ **データ型** – 整数

接続を非アクティブと見なす前に送信する認知されていないプローブ数。例えば、値を 3 に設定すると、ドライバーは接続がアクティブでないと判断する前に、未応答のキープアライブパケットを 3 つ送信します。

このパラメータを指定しない場合、Amazon Redshift はシステムのデフォルト値を使用します。

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

## tcp\$1keepalive\$1interval
<a name="python-tcp_keepalive_interval-option"></a>
+ **デフォルト値** - なし
+ **データ型** – 整数

ドライバーがプローブの確認応答を受信しなかった場合の、後続のキープアライブプローブの秒単位の間隔。このパラメータを指定する場合、正の整数である必要があります。

このパラメータを指定しない場合、Amazon Redshift はシステムのデフォルト値を使用します。

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

## tcp\$1keepalive\$1idle
<a name="python-tcp_keepalive_idle-option"></a>
+ **デフォルト値** - なし
+ **データ型** – 整数

ドライバーが最初のキープアライブプローブを送信した後の非アクティブ時間 (秒単位)。例えば、値を 120 に設定すると、ドライバーは最初のキープアライブパケットを送信する前に 2 分間の非アクティブ状態を維持します。このパラメータを指定する場合、正の整数である必要があります。

このパラメータを指定しない場合、Amazon Redshift はシステムのデフォルト値を使用します。

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

## タイムアウト
<a name="python-timeout-option"></a>
+ **デフォルト値** - なし
+ **データ型** – 整数

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

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

## トークン
<a name="python-token-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## token\$1type
<a name="python-token_type-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

次の値を指定できます。

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

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

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

## ユーザー
<a name="python-user-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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

## web\$1identity\$1token
<a name="python-web-identity-token-option"></a>
+ **デフォルト値** - なし
+ **データ型** - 文字列

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

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