Amazon Redshift ne prendra plus en charge la création de nouvelles fonctions Python définies par l’utilisateur à compter du 1er novembre 2025. Si vous souhaitez utiliser des fonctions Python définies par l’utilisateur, créez-les avant cette date. Les fonctions Python définies par l’utilisateur existantes continueront de fonctionner normalement. Pour plus d’informations, consultez le billet de blog .

Options de configuration du connecteur Amazon Redshift Python

Vous trouverez ci-dessous des descriptions des options que vous pouvez spécifier pour le connecteur Amazon Redshift Python. Les options ci-dessous s’appliquent à la dernière version de connecteur disponible, sauf indication contraire.

access_key_id

ID de clé d’accès pour l’utilisateur ou le rôle IAM configuré pour l’authentification de base de données IAM.

Ce paramètre est facultatif.

allow_db_user_override

Ce paramètre est facultatif.

app_name

Nom de l'application fournisseur d'identité (IdP) utilisée pour l'authentification.

Ce paramètre est facultatif.

application_name

Nom de l’application client à transmettre à Amazon Redshift à des fins d’audit. Le nom de l’application que vous fournissez apparaît dans la colonne « application_name » de la table SYS_CONNECTION_LOG. Cela permet de suivre et de dépanner les sources de connexion lors des problèmes de débogage.

Ce paramètre est facultatif.

auth_profile

Nom d'un profil d'authentification Amazon Redshift ayant des propriétés de connexion JSON. Pour plus d'informations sur l'attribution de noms aux paramètres de connexion, consultez la classe RedshiftProperty. La classe RedshiftProperty stocke les paramètres de connexion fournis par l'utilisateur final et, le cas échéant, générés pendant le processus d'authentification IAM (par exemple, les informations d'identification IAM temporaires). Pour plus d'informations, consultez la classe RedShiftProperty.

Ce paramètre est facultatif.

auto_create

Valeur qui indique si l'utilisateur doit être créé s'il n'existe pas.

Ce paramètre est facultatif.

client_id

ID client d'Azure IdP.

Ce paramètre est facultatif.

client_secret

Secret client d'Azure IdP.

Ce paramètre est facultatif.

cluster_identifier

Identifiant du cluster Amazon Redshift.

Ce paramètre est facultatif.

credentials_provider

IdP utilisé pour s'authentifier auprès d'Amazon Redshift. Voici les valeurs valides :

Ce paramètre est facultatif.

database

Nom de la base de données à laquelle vous souhaitez vous connecter.

Ce paramètre est obligatoire.

database_metadata_current_db_only

Valeur qui indique si une application prend en charge les catalogues d'unités de partage des données de plusieurs bases de données. La valeur par défaut True indique que l'application ne prend pas en charge les catalogues d'unités de partage des données de plusieurs bases de données pour des raisons de compatibilité ascendante.

Ce paramètre est facultatif.

db_groups

Une liste séparée par des virgules des noms de groupes de bases de données existants auxquels l'utilisateur indiqué par DbUser se joint pour la séance en cours.

Ce paramètre est facultatif.

db_user

L'ID utilisateur à utiliser avec Amazon Redshift.

Ce paramètre est facultatif.

endpoint_url

URL du point de terminaison Amazon Redshift. Cette option est réservée à l'utilisation interne d'AWS.

Ce paramètre est facultatif.

group_federation

Cette option spécifie si les groupes d’IDP Amazon Redshift doivent être utilisés.

Ce paramètre est facultatif.

hôte

Nom d'hôte du cluster Amazon Redshift.

Ce paramètre est facultatif.

iam

L'authentification IAM est activée.

Ce paramètre est obligatoire.

iam_disable_cache

Cette option spécifie si les informations d’identification IAM sont mises en cache. Par défaut, les informations d'identification IAM sont mises en cache. Cela améliore les performances lorsque les demandes envoyées à API Gateway sont limitées.

Ce paramètre est facultatif.

idc_client_display_name

Le nom d’affichage à utiliser pour le client qui utilise BrowserIdcAuthPlugin.

Ce paramètre est facultatif.

idc_region

Région AWS dans laquelle se trouve l’instance AWS IAM Identity Center.

Ce paramètre est requis uniquement lors de l’authentification à l’aide de BrowserIdcAuthPlugin dans l’option de configuration credentials_provider.

idp_partition

La partition dans laquelle votre Idp (fournisseur d’identité) est configuré. Une partition est un groupe de Régions AWS. Pour plus d’informations, consultez partition dans le Glossaire AWS.

Si ce paramètre est laissé vide, Amazon Redshift utilise par défaut la partition standard AWS, qui inclut toutes les partitions commerciales Régions AWS. Les valeurs possibles sont les suivantes :

Ce paramètre est facultatif.

idpPort

Port d'écoute auquel IdP envoie l'assertion SAML.

Ce paramètre est obligatoire.

idp_response_timeout

Délai d'expiration de la récupération de l'assertion SAML à partir de l'IdP.

Ce paramètre est obligatoire.

idp_tenant

Locataire IdP.

Ce paramètre est facultatif.

issuer_url

Pointe vers le point de terminaison de l’instance du serveur AWS IAM Identity Center.

Ce paramètre est requis uniquement lors de l’authentification à l’aide de BrowserIdcAuthPlugin dans l’option de configuration credentials_provider.

listen_port

Port utilisé par le pilote pour recevoir la réponse SAML du fournisseur d’identité ou le code d’autorisation lors de l’utilisation des services SAML, Azure AD ou AWS IAM Identity Center via un plug-in de navigateur.

Ce paramètre est facultatif.

login_url

URL d'authentification unique pour le fournisseur d'identité.

Ce paramètre est facultatif.

max_prepared_statements

Nombre maximal d’instructions préparées qui seront mises en cache par connexion. Le réglage de ce paramètre sur 0 désactive le mécanisme de mise en cache. La saisie d’un nombre négatif pour ce paramètre lui donne la valeur par défaut.

Ce paramètre est facultatif.

numeric_to_float

Cette option spécifie si le connecteur convertit les valeurs de type de données numériques du format « décimal.Décimal » au format flottant. Par défaut, le connecteur reçoit les valeurs de type numérique en tant que format « décimal.Décimal » et ne les convertit pas.

Nous ne recommandons pas d'activer l'option numeric_to_float pour les cas d'utilisation qui exigent de la précision, car les résultats peuvent être arrondis.

Pour plus d'informations sur le format « décimal.Décimal » et les compromis entre celui-ci et le format flottant, consultez la section decimal — Decimal fixed point and floating point arithmetic (Arithmétique à virgule fixe de type décimal — Décimal et à virgule flottante) sur le site Web de Python.

Ce paramètre est facultatif.

partner_sp_id

ID SP partenaire utilisé pour l'authentification avec Ping.

Ce paramètre est facultatif.

mot de passe

Mot de passe à utiliser pour l'authentification.

Ce paramètre est facultatif.

port

Numéro de port du cluster Amazon Redshift.

Ce paramètre est obligatoire.

preferred_role

Rôle IAM préféré pour la connexion actuelle.

Ce paramètre est facultatif.

principal_arn

L'Amazon Resource Name (ARN) de l'utilisateur ou du rôle IAM pour lequel vous générez une politique. Il est recommandé d'attacher une politique à un rôle, puis d'attacher le rôle à votre utilisateur, pour y accéder.

Ce paramètre est facultatif.

profile

Nom d'un profil dans un fichier d'informations d'identification AWS contenant des informations d'identification AWS.

Ce paramètre est facultatif.

provider_name

Nom du fournisseur d'authentification native Redshift.

Ce paramètre est facultatif.

region

La Région AWS où se trouve le cluster.

Ce paramètre est facultatif.

role_arn

Amazon Resource Name (ARN) du rôle que l'appelant doit assumer. Ce paramètre est utilisé par le fournisseur indiqué par JwtCredentialsProvider.

Pour le JwtCredentialsProvider, ce paramètre est obligatoire. Sinon, ce paramètre est facultatif.

role_session_name

Un identifiant pour la séance de rôle assumé. En règle générale, vous transmettez le nom ou l'identifiant associé à l'utilisateur qui utilise votre application. Les informations d’identification de sécurité temporaires utilisées par votre application sont associées à cet utilisateur. Ce paramètre est utilisé par le fournisseur indiqué par JwtCredentialsProvider.

Ce paramètre est facultatif.

portée

Liste des portées, séparées par des espaces, auxquelles l'utilisateur peut consentir. Vous spécifiez ce paramètre afin que votre application puisse obtenir le consentement des API que vous souhaitez appeler. Vous pouvez spécifier ce paramètre lorsque vous spécifiez BrowserAzureOAuth2CredentialsProvider pour l’option credentials_provider.

Ce paramètre est obligatoire pour le plug-in BrowserAzureOAuth2CredentialsProvider.

secret_access_key_id

Clé d'accès secrète pour l'utilisateur ou le rôle IAM configuré pour l'authentification de base de données IAM.

Ce paramètre est facultatif.

session_token

ID de clé d'accès pour l'utilisateur ou le rôle IAM configuré pour l'authentification de base de données IAM. Ce paramètre est obligatoire si des informations d'identification AWS temporaires sont utilisées.

Ce paramètre est facultatif.

serverless_acct_id

ID du compte Amazon Redshift Serverless.

Ce paramètre est facultatif.

serverless_work_group

Nom du groupe de travail Amazon Redshift Serverless.

Ce paramètre est facultatif.

ssl

Le protocole SSL est activé.

Ce paramètre est obligatoire.

ssl_insecure

Valeur qui indique si la vérification du certificat de serveur d’hôtes IdP doit être désactivée. La définition de ce paramètre sur True désactivera la vérification du certificat SSL du serveur d’hôtes IdP. Nous vous recommandons de conserver la valeur par défaut de False dans les environnements de production.

Ce paramètre est facultatif.

sslmode

Sécurité de la connexion à Amazon Redshift. Vous pouvez spécifier chacune des valeurs suivantes :

Ce paramètre est obligatoire.

tcp_keepalive

S’il faut utiliser les keepalives TCP pour empêcher les connexions de s’interrompre. Vous pouvez spécifier les valeurs suivantes :

Ce paramètre est facultatif.

tcp_keepalive_count

Le nombre de sondes non reconnues à envoyer avant de considérer la connexion comme inactive. Par exemple, définir la valeur sur 3 signifie que le pilote enverra 3 paquets keepalive sans réponse avant de déterminer que la connexion n’est plus active.

Si ce paramètre n’est pas spécifié, Amazon Redshift utilise la valeur par défaut du système.

Ce paramètre est facultatif.

tcp_keepalive_interval

Intervalle, en secondes, entre les sondes keepalive suivantes si le pilote n’a pas reçu d’accusé de réception pour la sonde précédente. Si vous spécifiez ce paramètre, il doit s’agir d’un nombre entier positif.

Si ce paramètre n’est pas spécifié, Amazon Redshift utilise la valeur par défaut du système.

Ce paramètre est facultatif.

tcp_keepalive_idle

Durée d’inactivité, en secondes, après laquelle le pilote envoie la première sonde keepalive. Par exemple, si vous définissez la valeur sur 120, le pilote attendra 2 minutes d’inactivité avant d’envoyer le premier paquet keepalive. Si vous spécifiez ce paramètre, il doit s’agir d’un nombre entier positif.

Si ce paramètre n’est pas spécifié, Amazon Redshift utilise la valeur par défaut du système.

Ce paramètre est facultatif.

timeout

Le nombre de secondes avant que la connexion au serveur ne soit interrompue.

Ce paramètre est facultatif.

jeton

Un jeton d’accès fourni par AWS IAM Identity Center ou un jeton Web JSON (JWT) OpenID Connect (OIDC) fourni par un fournisseur d’identité Web lié à AWS IAM Identity Center. Votre application doit générer ce jeton en authentifiant l’utilisateur de votre application auprès d’AWS IAM Identity Center ou d’un fournisseur d’identité lié à AWS IAM Identity Center.

Ce paramètre fonctionne avec IdpTokenAuthPlugin.

token_type

Type de jeton utilisé dans IdpTokenAuthPlugin.

Vous pouvez spécifier les valeurs suivantes :

Ce paramètre fonctionne avec IdpTokenAuthPlugin.

utilisateur

Nom d'utilisateur à utiliser pour l'authentification.

Ce paramètre est facultatif.

web_identity_token

Le jeton d'accès OAuth 2.0 ou le jeton d'identification OpenID Connect qui est fourni par le fournisseur d'identité. Assurez-vous que votre application obtient ce jeton en authentifiant l'utilisateur de votre application auprès d'un fournisseur d'identité web. Ce paramètre est utilisé par le fournisseur indiqué par JwtCredentialsProvider.

Pour le JwtCredentialsProvider, ce paramètre est obligatoire. Sinon, ce paramètre est facultatif.