Options de configuration du connecteur Amazon Redshift Python - Amazon Redshift
access_key_idallow_db_user_overrideapp_nameauth_profileauto_createclient_idclient_secretcluster_identifiercredentials_providerdatabasedatabase_metadata_current_db_onlydb_groupsdb_userendpoint_urlgroup_federationhôteiamiam_disable_cacheidc_client_display_nameidc_regionidpPortidp_response_timeoutidp_tenantURL_émetteurlisten_portlogin_urlmax_prepared_statementsnumeric_to_floatpartner_sp_idmot de passeportpreferred_roleprincipal_arnprofileprovider_nameregionrole_arnrole_session_namescopesecret_access_key_idsession_tokenserverless_acct_idserverless_work_groupsslssl_insecuresslmodetimeoutjetontype_jetonutilisateurweb_identity_token

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

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.

access_key_id

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

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

Ce paramètre est facultatif.

allow_db_user_override

  • Valeur par défaut – False

  • Types de données – Booléen

True

Spécifie que le connecteur utilise la DbUser valeur de l'assertion Security Assertion Markup Language (SAML).

False

Spécifie que la valeur du paramètre de connexion DbUser est utilisée.

Ce paramètre est facultatif.

app_name

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

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

Ce paramètre est facultatif.

auth_profile

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

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

Ce paramètre est facultatif.

auto_create

  • Valeur par défaut – False

  • Types de données – Booléen

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

Ce paramètre est facultatif.

client_id

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

ID client d'Azure IdP.

Ce paramètre est facultatif.

client_secret

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Secret client d'Azure IdP.

Ce paramètre est facultatif.

cluster_identifier

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Identifiant du cluster Amazon Redshift.

Ce paramètre est facultatif.

credentials_provider

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

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

  • AdfsCredentialsProvider

  • AzureCredentialsProvider

  • BrowserAzureCredentialsProvider

  • BrowserAzureOAuth2CredentialsProvider

  • BrowserIdcAuthPlugin— Un plugin d'autorisation utilisant AWS IAMCentre d'identité.

  • BrowserSamlCredentialsProvider

  • IdpTokenAuthPlugin— Un plugin d'autorisation qui accepte un AWS IAMToken Identity Center ou jetons d'identité JSON basés sur OpenID Connect (OIDC) (JWT) provenant de n'importe quel fournisseur d'identité Web lié au AWS IAMCentre d'identité.

  • PingCredentialsProvider

  • OktaCredentialsProvider

Ce paramètre est facultatif.

database

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

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

Ce paramètre est obligatoire.

database_metadata_current_db_only

  • Valeur par défaut – True

  • Types de données – Booléen

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

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Liste séparée par des virgules des noms de groupes de base de données existants que l'utilisateur a indiqués par des DbUser jointures pour la session en cours.

Ce paramètre est facultatif.

db_user

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

L'ID utilisateur à utiliser avec Amazon Redshift.

Ce paramètre est facultatif.

endpoint_url

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Le point de terminaison Amazon Redshift. URL Cette option est uniquement pour AWS usage interne.

Ce paramètre est facultatif.

group_federation

  • Valeur par défaut – False

  • Types de données – Booléen

Cette option indique s'il faut utiliser les groupes Amazon RedshiftIDP.

Ce paramètre est facultatif.

true

Utilisez les groupes Amazon Redshift Identity Provider (IDP).

false

Utilisez STS API et GetClusterCredentials pour la fédération d'utilisateurs et spécifiez db_groups pour la connexion.

hôte

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Nom d'hôte du cluster Amazon Redshift.

Ce paramètre est facultatif.

iam

  • Valeur par défaut – False

  • Types de données – Booléen

IAMl'authentification est activée.

Ce paramètre est obligatoire.

iam_disable_cache

  • Valeur par défaut – False

  • Types de données – Booléen

Cette option indique si les IAM informations d'identification sont mises en cache. Par défaut, les IAM informations d'identification sont mises en cache. Cela améliore les performances lorsque les demandes adressées à la API passerelle sont limitées.

Ce paramètre est facultatif.

idc_client_display_name

  • Valeur par défaut — Connecteur Amazon Redshift Python

  • Types de données – Chaîne

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

Ce paramètre est facultatif.

idc_region

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Le AWS région où le AWS IAML'instance Identity Center est localisée.

Ce paramètre est requis uniquement lors de l'authentification à l'aide de l'BrowserIdcAuthPluginoption de configuration credentials_provider.

idpPort

  • Valeur par défaut – 7890

  • Type de données – Entier

Le port d'écoute auquel l'IdP envoie l'SAMLassertion.

Ce paramètre est obligatoire.

idp_response_timeout

  • Valeur par défaut – 120

  • Type de données – Entier

Le délai d'expiration pour récupérer l'SAMLassertion depuis l'IdP.

Ce paramètre est obligatoire.

idp_tenant

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Locataire IdP.

Ce paramètre est facultatif.

URL_émetteur

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Pointe vers le AWS IAMPoint de terminaison de l'instance du serveur Identity Center.

Ce paramètre est requis uniquement lors de l'authentification à l'aide de l'BrowserIdcAuthPluginoption de configuration credentials_provider.

listen_port

  • Valeur par défaut – 7890

  • Type de données – Entier

Le port que le pilote utilise pour recevoir la SAML réponse du fournisseur d'identité ou le code d'autorisation lors de l'utilisation d'SAMLAzure AD, ou AWS IAMServices Identity Center via un plugin de navigateur.

Ce paramètre est facultatif.

login_url

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

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

Ce paramètre est facultatif.

max_prepared_statements

  • Valeur par défaut : 1 000

  • Type de données – Entier

Nombre maximal d'instructions préparées pouvant être ouvertes simultanément.

Ce paramètre est obligatoire.

numeric_to_float

  • Valeur par défaut – False

  • Types de données – Booléen

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

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

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

Ce paramètre est facultatif.

mot de passe

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Mot de passe à utiliser pour l'authentification.

Ce paramètre est facultatif.

port

  • Valeur par défaut : 5439

  • Type de données – Entier

Numéro de port du cluster Amazon Redshift.

Ce paramètre est obligatoire.

preferred_role

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

IAMRôle préféré pour la connexion en cours.

Ce paramètre est facultatif.

principal_arn

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Le nom de ressource Amazon (ARN) de l'utilisateur ou du IAM rôle 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

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Le nom d'un profil dans un AWS fichier d'informations d'identification contenant AWS informations d'identification.

Ce paramètre est facultatif.

provider_name

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Nom du fournisseur d'authentification native Redshift.

Ce paramètre est facultatif.

region

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

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

Ce paramètre est facultatif.

role_arn

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Le nom de ressource Amazon (ARN) du rôle assumé par l'appelant. 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

  • Valeur par défaut – jwt_redshift_session

  • Types de données – Chaîne

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.

scope

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Une liste des portées, séparées par des espaces, auxquels l’utilisateur peut consentir. Vous spécifiez ce paramètre afin que votre application puisse obtenir le consentement pour APIs ce que vous souhaitez appeler. Vous pouvez spécifier ce paramètre lorsque vous spécifiez BrowserAzure OAuth2CredentialsProvider l'option credentials_provider.

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

secret_access_key_id

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

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

Ce paramètre est facultatif.

session_token

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

La clé d'accès pour le IAM rôle ou l'utilisateur configuré pour l'authentification IAM de la base de données. Ce paramètre est obligatoire s'il est temporaire AWS les informations d'identification sont utilisées.

Ce paramètre est facultatif.

serverless_acct_id

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

ID du compte Amazon Redshift Serverless.

Ce paramètre est facultatif.

serverless_work_group

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Nom du groupe de travail Amazon Redshift Serverless.

Ce paramètre est facultatif.

ssl

  • Valeur par défaut – True

  • Types de données – Booléen

Secure Sockets Layer (SSL) est activé.

Ce paramètre est obligatoire.

ssl_insecure

  • Valeur par défaut – True

  • Types de données – Booléen

Valeur qui indique si le certificat de serveur d'hôtes IdP doit être vérifié.

Ce paramètre est facultatif.

sslmode

  • Valeur par défaut – verify-ca

  • Types de données – Chaîne

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

  • verify-ca

  • verify-full

Ce paramètre est obligatoire.

timeout

  • Valeur par défaut – Aucune

  • Type de données – Entier

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

Ce paramètre est facultatif.

jeton

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Un AWS IAMIdentity Center a fourni un jeton d'accès ou un jeton JSON Web OpenID Connect (OIDCJWT) fourni par un fournisseur d'identité Web lié à AWS IAMCentre d'identité. Votre application doit générer ce jeton en authentifiant l'utilisateur de votre application avec AWS IAMIdentity Center ou un fournisseur d'identité lié à AWS IAMCentre d'identité.

Ce paramètre fonctionne avecIdpTokenAuthPlugin.

type_jeton

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Type de jeton utilisé dansIdpTokenAuthPlugin.

Vous pouvez spécifier les valeurs suivantes :

ACCESS_TOKEN

Entrez ce champ si vous utilisez un AWS IAMIdentity Center a fourni un jeton d'accès.

EXT_JWT

Entrez ceci si vous utilisez un jeton JSON Web OpenID OIDC Connect (JWT) fourni par un fournisseur d'identité Web intégré à AWS IAMCentre d'identité.

Ce paramètre fonctionne avecIdpTokenAuthPlugin.

utilisateur

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Nom d'utilisateur à utiliser pour l'authentification.

Ce paramètre est facultatif.

web_identity_token

  • Valeur par défaut – Aucune

  • Types de données – Chaîne

Le jeton d'accès OAuth 2.0 ou le jeton d'identification OpenID Connect 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.