Konfigurationsoptionen für den Amazon-Redshift-Python-Konnektor

Im Folgenden finden Sie Beschreibungen für die Optionen, die Sie für den Amazon-Redshift-Python-Konnektor angeben können.

access_key_id

• Standardwert – Keine

• Datentyp – Zeichenfolge

Der Zugriffsschlüssel für die IAM Rolle oder den Benutzer, der für IAM die Datenbankauthentifizierung konfiguriert ist.

Dieser Parameter ist optional.

allow_db_user_override

• Standardwert – false

• Datentyp – boolesch

True

Gibt an, dass der Connector den DbUser Wert aus der Security Assertion Markup Language (SAML) -Assertion verwendet.

False

Gibt an, dass der Wert im DbUser-Verbindungsparameter verwendet wird.

Dieser Parameter ist optional.

app_name

• Standardwert – Keiner

• Datentyp – Zeichenfolge

Der Name der Identitätsanbieter-Anwendung (IdP), die für die Authentifizierung verwendet wird.

Dieser Parameter ist optional.

auth_profile

• Standardwert – Keines

• Datentyp – Zeichenfolge

Der Name eines Amazon Redshift Redshift-Authentifizierungsprofils mit Verbindungseigenschaften wieJSON. Weitere Informationen zur Benennung von Verbindungsparametern finden Sie in der RedshiftProperty-Klasse. Die RedshiftProperty Klasse speichert Verbindungsparameter, die vom Endbenutzer bereitgestellt und gegebenenfalls während des IAM Authentifizierungsprozesses generiert wurden (z. B. temporäre IAM Anmeldeinformationen). Weitere Informationen finden Sie in der RedshiftProperty Klasse.

Dieser Parameter ist optional.

auto_create

• Standardwert – false

• Datentyp – boolesch

Ein Wert, der angibt, ob der Benutzer erstellt werden soll, wenn der Benutzer nicht existiert.

Dieser Parameter ist optional.

Client-ID

• Standardwert – Keiner

• Datentyp – Zeichenfolge

Die Client-ID von Azure IdP.

Dieser Parameter ist optional.

client_secret

• Standardwert – Keine

• Datentyp – Zeichenfolge

Das Client-Geheimnis von Azure IdP.

Dieser Parameter ist optional.

cluster_identifier

• Standardwert – Keine

• Datentyp – Zeichenfolge

Die Cluster-Kennung des Amazon-Redshift-Clusters.

Dieser Parameter ist optional.

credentials_provider

• Standardwert – Keine

• Datentyp – Zeichenfolge

Der IdP, der zur Authentifizierung bei Amazon Redshift verwendet wird. Die folgenden Werte sind gültig:

• AdfsCredentialsProvider

• AzureCredentialsProvider

• BrowserAzureCredentialsProvider

• BrowserAzureOAuth2CredentialsProvider

• BrowserIdcAuthPlugin— Ein Autorisierungs-Plugin mit AWS IAMIdentitätszentrum.

• BrowserSamlCredentialsProvider

• IdpTokenAuthPlugin— Ein Autorisierungs-Plugin, das akzeptiert AWS IAMIdentity Center-Token oder OpenID Connect (OIDC) JSON -basierte Identitätstoken (JWT) von einem beliebigen Web-Identitätsanbieter, der mit dem AWS IAMIdentity Center.

• PingCredentialsProvider

• OktaCredentialsProvider

Dieser Parameter ist optional.

Datenbank

• Standardwert – Kein

• Datentyp – Zeichenfolge

Der Name der Datenbank, mit der Sie sich verbinden möchten.

Dieser Parameter muss angegeben werden.

database_metadata_current_db_only

• Standardwert – true

• Datentyp – boolesch

Ein Wert, der angibt, ob eine Anwendung Datashare-Kataloge mit mehreren Datenbanken unterstützt. Der Standardwert True gibt an, dass die Anwendung aus Gründen der Abwärtskompatibilität keine Datashare-Kataloge mit mehreren Datenbanken unterstützt.

Dieser Parameter ist optional.

db_groups

• Standardwert – Keine

• Datentyp – Zeichenfolge

Eine durch Kommas getrennte Liste vorhandener Datenbankgruppennamen, die der Benutzer für die aktuelle Sitzung durch DbUser Joins angegeben hat.

Dieser Parameter ist optional.

db_user

• Standardwert – Keine

• Datentyp – Zeichenfolge

Die Benutzer-ID, die mit Amazon Redshift verwendet werden soll.

Dieser Parameter ist optional.

endpoint_url

• Standardwert – Keine

• Datentyp – Zeichenfolge

Der Amazon Redshift Redshift-EndpunktURL. Diese Option ist nur für AWS interner Gebrauch.

Dieser Parameter ist optional.

group_federation

• Standardwert – false

• Datentyp – boolesch

Diese Option gibt an, ob Amazon Redshift IDP Redshift-Gruppen verwendet werden sollen.

Dieser Parameter ist optional.

true

Verwenden Sie Amazon Redshift Identity Provider (IDP) -Gruppen.

false

Verwenden Sie STS API und GetClusterCredentials für den Benutzerverbund und geben Sie db_groups für die Verbindung an.

Host

• Standardwert – Kein

• Datentyp – Zeichenfolge

Der Hostname des Amazon-Redshift-Clusters.

Dieser Parameter ist optional.

iam

• Standardwert – false

• Datentyp – boolesch

IAMAuthentifizierung ist aktiviert.

Dieser Parameter muss angegeben werden.

iam_disable_cache

• Standardwert – false

• Datentyp – boolesch

Diese Option gibt an, ob die IAM Anmeldeinformationen zwischengespeichert werden. Standardmäßig werden die IAM Anmeldeinformationen zwischengespeichert. Dies verbessert die Leistung, wenn Anfragen an das API Gateway gedrosselt werden.

Dieser Parameter ist optional.

idc_client_display_name

• Standardwert — Amazon Redshift Python-Konnektor

• Datentyp – Zeichenfolge

Der Anzeigename, der für den Client verwendet werden soll, der verwendet BrowserIdcAuthPlugin.

Dieser Parameter ist optional.

idc_region

• Standardwert – Kein

• Datentyp – Zeichenfolge

Das Tool AWS Region, in der AWS IAMDie Identity Center-Instanz befindet sich.

Dieser Parameter ist nur erforderlich, wenn Sie sich mit der Konfigurationsoption BrowserIdcAuthPlugin credentials als_provider authentifizieren.

idpPort

• Standardwert – 7890

• Datentyp – Ganzzahl

Der Listen-Port, an den IdP die SAML Assertion sendet.

Dieser Parameter muss angegeben werden.

idp_response_timeout

• Standardwert – 120

• Datentyp – Ganzzahl

Das Timeout für das Abrufen der SAML Assertion von IdP.

Dieser Parameter muss angegeben werden.

idp_tenant

• Standardwert – Keine

• Datentyp – Zeichenfolge

Der IdP-Tenant.

Dieser Parameter ist optional.

issuer_url

• Standardwert – Kein

• Datentyp – Zeichenfolge

Zeigt auf die AWS IAMDer Instanzendpunkt des Identity Center-Servers.

Dieser Parameter ist nur erforderlich, wenn Sie sich mit der Konfigurationsoption BrowserIdcAuthPlugin credentials als_provider authentifizieren.

listen_port

• Standardwert – 7890

• Datentyp – Ganzzahl

Der Port, den der Treiber verwendet, um die SAML Antwort vom Identitätsanbieter oder den Autorisierungscode zu empfangen, wenn Azure AD verwendet wirdSAML, oder AWS IAMIdentity Center-Dienste über ein Browser-Plugin.

Dieser Parameter ist optional.

login_url

• Standardwert – Keine

• Datentyp – Zeichenfolge

Die Single-Sign-On-URL für den IdP.

Dieser Parameter ist optional.

max_prepared_statements

• Standardwert – 1000

• Datentyp – Ganzzahl

Die maximale Anzahl von vorbereiteten Anweisungen, die gleichzeitig geöffnet sein können.

Dieser Parameter muss angegeben werden.

numeric_to_float

• Standardwert – false

• Datentyp – boolesch

Diese Option gibt an, ob der Konnektor numerische Datentypwerte von decimal.Decimal in Float konvertiert. Standardmäßig erhält der Konnektor numerische Datentypwerte als decimal.Decimal und konvertiert sie nicht.

Wir empfehlen nicht, numeric_to_float für Anwendungsfälle zu aktivieren, die Genauigkeit erfordern, da die Ergebnisse ggf. gerundet werden.

Weitere Informationen zu decimal.Decimal und den Kompromissen im Hinblick auf decimal.Decimal und Float finden Sie unter decimal – Dezimale Festpunkt- und Gleitkomma-Arithmetik auf der Python-Website.

Dieser Parameter ist optional.

partner_sp_id

• Standardwert – Keine

• Datentyp – Zeichenfolge

Die Partner-SP-ID, die für die Authentifizierung mit Ping verwendet wird.

Dieser Parameter ist optional.

password

• Standardwert – Kein

• Datentyp – Zeichenfolge

Das Passwort, das für die Authentifizierung verwendet werden soll.

Dieser Parameter ist optional.

port

• Standardwert – 5 439

• Datentyp – Ganzzahl

Die Portnummer für den Amazon-Redshift-Cluster.

Dieser Parameter muss angegeben werden.

preferred_role

• Standardwert – Kein

• Datentyp – Zeichenfolge

Die für die aktuelle Verbindung bevorzugte IAM Rolle.

Dieser Parameter ist optional.

principal_arn

• Standardwert – Keine

• Datentyp – Zeichenfolge

Der Amazon-Ressourcenname (ARN) des Benutzers oder der IAM Rolle, für die Sie eine Richtlinie generieren. Es wird empfohlen, eine Richtlinie an eine Rolle anzufügen und die Rolle Ihrem Benutzer für den Zugriff zuzuweisen.

Dieser Parameter ist optional.

profile

• Standardwert – Kein

• Datentyp – Zeichenfolge

Der Name eines Profils in einem AWS Anmeldeinformationsdatei, die enthält AWS Anmeldeinformationen.

Dieser Parameter ist optional.

provider_name

• Standardwert – Kein

• Datentyp – Zeichenfolge

Der Name des Anbieters für die systemeigene Authentifizierung von Redshift.

Dieser Parameter ist optional.

region

• Standardwert – Kein

• Datentyp – Zeichenfolge

Das Tool AWS-Region wo sich der Cluster befindet.

Dieser Parameter ist optional.

role_arn

• Standardwert – Keine

• Datentyp – Zeichenfolge

Der Amazon-Ressourcenname (ARN) der Rolle, die der Aufrufer annimmt. Dieser Parameter wird von dem Anbieter verwendet, der mit JwtCredentialsProvider angegeben ist.

Für den JwtCredentialsProvider-Anbieter ist dieser Parameter obligatorisch. Andernfalls ist dieser Parameter optional.

role_session_name

• Standardwert – jwt_redshift_session

• Datentyp – Zeichenfolge

Ein Bezeichner für die Sitzung der angenommenen Rolle. Normalerweise übergeben Sie den Namen oder den Bezeichner, der dem Benutzer Ihrer Anwendung zugeordnet ist. Die temporären Sicherheitsanmeldeinformationen, die Ihre Anwendung verwendet, sind diesem Benutzer zugeordnet. Dieser Parameter wird von dem Anbieter verwendet, der mit JwtCredentialsProvider angegeben ist.

Dieser Parameter ist optional.

scope

• Standardwert – Kein

• Datentyp – Zeichenfolge

Eine durch Leerzeichen getrennte Liste von Bereichen, denen der Benutzer zustimmen kann. Sie geben diesen Parameter an, damit Ihre Anwendung die Zustimmung zu dem, was Sie aufrufen möchtenAPIs, einholen kann. Sie können diesen Parameter angeben, wenn Sie ihn BrowserAzure OAuth2CredentialsProvider für die Option credentials als_provider angeben.

Dieser Parameter ist für das Plug-in erforderlich. BrowserAzure OAuth2CredentialsProvider

secret_access_key_id

• Standardwert – Kein

• Datentyp – Zeichenfolge

Der geheime Zugriffsschlüssel für die IAM Rolle oder den Benutzer, der für die IAM Datenbankauthentifizierung konfiguriert ist.

Dieser Parameter ist optional.

session_token

• Standardwert – Keine

• Datentyp – Zeichenfolge

Der Zugriffsschlüssel für die IAM Rolle oder den Benutzer, der für die IAM Datenbankauthentifizierung konfiguriert ist. Dieser Parameter ist erforderlich, wenn er temporär ist AWS Anmeldeinformationen werden verwendet.

Dieser Parameter ist optional.

serverless_acct_id

• Standardwert – Kein

• Datentyp – Zeichenfolge

Die Konto-ID von Amazon Redshift Serverless.

Dieser Parameter ist optional.

serverless_work_group

• Standardwert – Kein

• Datentyp – Zeichenfolge

Der Name der Amazon-Redshift-Serverless-Arbeitsgruppe.

Dieser Parameter ist optional.

ssl

• Standardwert – true

• Datentyp – boolesch

Secure Sockets Layer (SSL) ist aktiviert.

Dieser Parameter muss angegeben werden.

ssl_insecure

• Standardwert – true

• Datentyp – boolesch

Ein Wert, der angibt, ob das IdP-Host-Serverzertifikat überprüft werden soll.

Dieser Parameter ist optional.

sslmode

• Standardwert – verify-ca

• Datentyp – Zeichenfolge

Die Sicherheit der Verbindung zu Amazon Redshift. Sie können einen der folgenden Werte angeben:

• verify-ca

• verify-full

Dieser Parameter muss angegeben werden.

timeout

• Standardwert – Kein

• Datentyp – Ganzzahl

Die Anzahl der Sekunden, die gewartet werden soll, bevor eine Zeitüberschreitung für einen Verbindungsversuch mit dem Server eintritt.

Dieser Parameter ist optional.

Token

• Standardwert – Kein

• Datentyp – Zeichenfolge

Importieren in &S3; AWS IAMVon Identity Center bereitgestelltes Zugriffstoken oder ein OpenID Connect (OIDC) JSON Web-Token (JWT), bereitgestellt von einem Web-Identitätsanbieter, der verknüpft ist mit AWS IAMIdentity Center. Ihre Anwendung muss dieses Token generieren, indem sie den Benutzer Ihrer Anwendung mit authentifiziert AWS IAMIdentity Center oder ein Identitätsanbieter, der mit verknüpft ist AWS IAMIdentity Center.

Dieser Parameter funktioniert mitIdpTokenAuthPlugin.

token_type

• Standardwert – Kein

• Datentyp – Zeichenfolge

Der Tokentyp, der in verwendet wird. IdpTokenAuthPlugin

Sie können die folgenden Werte angeben:

ACCESS_TOKEN

Geben Sie dies ein, wenn Sie eine verwenden AWS IAMDas von Identity Center bereitgestellte Zugriffstoken.

EXT_JWT

Geben Sie dies ein, wenn Sie ein OpenID Connect (OIDC) JSON -Webtoken (JWT) verwenden, das von einem webbasierten Identitätsanbieter bereitgestellt wird, der integriert ist mit AWS IAMIdentitätscenter.

Dieser Parameter funktioniert mitIdpTokenAuthPlugin.

user

• Standardwert – Kein

• Datentyp – Zeichenfolge

Der Benutzername für die Autorisierung.

Dieser Parameter ist optional.

web_identity_token

• Standardwert – Kein

• Datentyp – Zeichenfolge

Das OAuth 2.0-Zugriffstoken oder das OpenID Connect-ID-Token, das vom Identitätsanbieter bereitgestellt wird. Stellen Sie sicher, dass Ihre Anwendung dieses Token abruft, indem Sie den Benutzer Ihrer Anwendung bei einem Web-Identitätsanbieter authentifizieren. Dieser Parameter wird von dem Anbieter verwendet, der mit JwtCredentialsProvider angegeben ist.

Für den JwtCredentialsProvider-Anbieter ist dieser Parameter obligatorisch. Andernfalls ist dieser Parameter optional.