Verbindung API - AWS Glue

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verbindung API

In der Verbindung API werden AWS Glue Verbindungsdatentypen sowie die API zum Erstellen, Löschen, Aktualisieren und Auflisten von Verbindungen beschrieben.

Datentypen

Connection-Struktur

Definiert eine Verbindung zu einer Datenquelle.

Felder
  • Name— UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, entspricht derSingle-line string pattern.

    Der Name der Verbindungsdefinition.

  • Description – Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.

    Beschreibung der Verbindung.

  • ConnectionType— UTF -8 Zeichenfolge (gültige Werte: JDBC | | | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | | CUSTOM SALESFORCE VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

    Typ der Verbindung. SFTP wird derzeit nicht unterstützt.

  • MatchCriteria— Ein Array von UTF -8 Zeichenketten, nicht mehr als 10 Zeichenketten.

    Eine Liste von Kriterien, die bei der Auswahl dieser Verbindung verwendet werden können.

  • ConnectionProperties – Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 100 Paare.

    Jeder Schlüssel ist eine Zeichenfolge von UTF -8 (gültige Werte: HOST | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | SECRET_ID | | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | KAFKA_SASL_MECHANISM | KAFKA_SASL_PLAIN_USERNAME | KAFKA_SASL_PLAIN_PASSWORD | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD KAFKA_SASL_SCRAM_USERNAME KAFKA_SASL_SCRAM_PASSWORD| KAFKA_SASL_SCRAM_SECRETS_ARN | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB | KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | | KAFKA_SASL_GSSAPI_PRINCIPAL | ROLE_ARN | REGION | WORKGROUP_NAME CLUSTER_IDENTIFIER |DATABASE).

    Jeder Wert ist eine Wertzeichenfolge, die nicht mehr als 1024 Bytes lang ist.

    Diese Schlüssel-Wert-Paare definieren Parameter für die Verbindung:

    • HOST- Der HostURI: entweder der vollqualifizierte Domainname (FQDN) oder die IPv4 Adresse des Datenbank-Hosts.

    • PORT – Die Portnummer zwischen 1024 und 65535 des Ports, auf dem der Datenbank-Host auf Datenbankverbindungen wartet.

    • USER_NAME – Der Name, unter dem Sie sich bei der Datenbank anmelden. Die Wert-Zeichenfolge für USER_NAME ist „USERNAME“.

    • PASSWORD – Ein Passwort, falls eines verwendet wird, für den Benutzernamen.

    • ENCRYPTED_PASSWORD – Wenn Sie den Verbindungspasswortschutz aktivieren, indem Sie in den Verschlüsselungseinstellungen des Data Catalog ConnectionPasswordEncryption festlegen, wird das verschlüsselte Passwort in diesem Feld gespeichert.

    • JDBC_DRIVER_JAR_URI- Der Amazon Simple Storage Service (Amazon S3) -Pfad der JAR Datei, die den zu JDBC verwendenden Treiber enthält.

    • JDBC_DRIVER_CLASS_NAME- Der Klassenname des zu verwendenden JDBC Treibers.

    • JDBC_ENGINE- Der Name der zu verwendenden JDBC Engine.

    • JDBC_ENGINE_VERSION- Die Version der JDBC Engine, die verwendet werden soll.

    • CONFIG_FILES - (Zur späteren Verwendung reserviert.)

    • INSTANCE_ID – Die zu verwendende Instance-ID.

    • JDBC_CONNECTION_URL- Die URL für die Verbindung mit einer JDBC Datenquelle.

    • JDBC_ENFORCE_SSL— Eine boolesche Zeichenfolge (true, false), die angibt, ob Secure Sockets Layer (SSL) mit Hostnamenübereinstimmung für die JDBC Verbindung auf dem Client erzwungen wird. Der Standardwert lautet „false“.

    • CUSTOM_JDBC_CERT- Ein Amazon S3 S3-Standort, der das Stammzertifikat des Kunden angibt. AWS Glue verwendet dieses Stammzertifikat, um das Zertifikat des Kunden zu validieren, wenn eine Verbindung zur Kundendatenbank hergestellt wird. AWS Glue verarbeitet nur X.509-Zertifikate. Das bereitgestellte Zertifikat muss DER -codiert und im Base64-Kodierungsformat bereitgestellt werden. PEM

    • SKIP_CUSTOM_JDBC_CERT_VALIDATION- Standardmäßig ist das. false AWS Glue validiert den Signaturalgorithmus und den Subject Public Key Algorithm für das Kundenzertifikat. Die einzig zulässigen Algorithmen für den Signaturalgorithmus sindSHA256withRSA, SHA384withRSA oderSHA512withRSA. Die Schlüssellänge für den Algorithmus für den öffentlichen Schlüssel muss mindestens 2048 betragen. Sie können den Wert dieser Eigenschaft auf true festlegen, um die AWS Glue-Validierung des Kundenzertifikats zu überspringen.

    • CUSTOM_JDBC_CERT_STRING- Eine benutzerdefinierte JDBC Zertifikatszeichenfolge, die für den Domänenabgleich oder den Abgleich definierter Namen verwendet wird, um einen man-in-the-middle Angriff zu verhindern. In der Oracle-Datenbank wird dies als verwendetSSL_SERVER_CERT_DN; in Microsoft SQL Server wird dies als verwendethostNameInCertificate.

    • CONNECTION_URL- Der URL für die Verbindung zu einer allgemeinen (Nicht-JDBC) Datenquelle.

    • SECRET_ID – Die geheime ID, die für den Secrets Manager der Anmeldeinformationen verwendet wird.

    • CONNECTOR_URL- Der Anschluss URL für eine MARKETPLACE CUSTOM Oder-Verbindung.

    • CONNECTOR_TYPE- Der Steckertyp für eine MARKETPLACE CUSTOM Oder-Verbindung.

    • CONNECTOR_CLASS_NAME- Der Name der Konnektorklasse für eine MARKETPLACE CUSTOM OR-Verbindung.

    • KAFKA_BOOTSTRAP_SERVERS - Eine durch Kommata getrennte Liste von Host- und Portpaaren, die die Adressen der Apache Kafka Broker in einem Kafka-Cluster sind, zu dem ein Kafka-Client eine Verbindung herstellt und Bootstrapping durchführt.

    • KAFKA_SSL_ENABLED- Ob eine Apache Kafka-Verbindung aktiviert oder deaktiviert SSL werden soll. Der Standardwert ist „true“.

    • KAFKA_CUSTOM_CERT- Amazon S3 URL für die private CA-Zertifikatsdatei (.pem-Format). Der Standardwert ist eine leere Zeichenfolge.

    • KAFKA_SKIP_CUSTOM_CERT_VALIDATION- Ob die Validierung der CA-Zertifikatsdatei übersprungen werden soll oder nicht. AWS Glue validiert für drei Algorithmen:SHA256withRSA, undSHA384withRSA. SHA512withRSA Der Standardwert ist „false“.

    • KAFKA_CLIENT_KEYSTORE – Der Amazon-S3-Speicherort der Client-Keystore-Datei für die clientseitige Kafka-Authentifizierung (optional).

    • KAFKA_CLIENT_KEYSTORE_PASSWORD – Das Passwort für den Zugriff auf den bereitgestellten Keystore (optional).

    • KAFKA_CLIENT_KEY_PASSWORD – Ein Keystore kann aus mehreren Schlüsseln bestehen, also ist dies das Passwort für den Zugriff auf den Clientschlüssel, der mit dem serverseitigen Kafka-Schlüssel verwendet werden soll (optional).

    • ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD— Die verschlüsselte Version des Keystore-Passworts des Kafka-Clients (falls der Benutzer die Einstellung Passwörter AWS Glue verschlüsseln ausgewählt hat).

    • ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD- Die verschlüsselte Version des Kafka-Client-Schlüsselkennworts (falls der Benutzer die Einstellung Passwörter AWS Glue verschlüsseln ausgewählt hat).

    • KAFKA_SASL_MECHANISM-"SCRAM-SHA-512", "GSSAPI""AWS_MSK_IAM", oder. "PLAIN" Dies sind die unterstützten SASLMechanismen.

    • KAFKA_SASL_PLAIN_USERNAME- Ein Klartext-Benutzername, der zur Authentifizierung mit dem "PLAIN" -Mechanismus verwendet wird.

    • KAFKA_SASL_PLAIN_PASSWORD— Ein Klartext-Passwort, das zur Authentifizierung mit dem "" -Mechanismus verwendet wird. PLAIN

    • ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD— Die verschlüsselte Version des SASL PLAIN Kafka-Passworts (falls der Benutzer die Einstellung „Passwörter AWS Glue verschlüsseln“ ausgewählt hat).

    • KAFKA_SASL_SCRAM_USERNAME- Ein Klartext-Benutzername, der zur Authentifizierung mit dem "SCRAM- -512"-Mechanismus verwendet wird. SHA

    • KAFKA_SASL_SCRAM_PASSWORD- Ein Klartext-Passwort, das zur Authentifizierung mit dem "- -512"-Mechanismus verwendet wird. SCRAM SHA

    • ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD— Die verschlüsselte Version des SASL SCRAM Kafka-Passworts (falls der Benutzer die Einstellung Passwörter AWS Glue verschlüsseln ausgewählt hat).

    • KAFKA_SASL_SCRAM_SECRETS_ARN- Der Amazon-Ressourcenname eines Geheimnisses in AWS Secrets Manager.

    • KAFKA_SASL_GSSAPI_KEYTAB – Der S3-Speicherort einer Kerberos-keytab-Datei. Ein Keytab speichert Langzeitschlüssel für ein oder mehrere Prinzipale. Weitere Informationen finden Sie in der MITKerberos-Dokumentation: Keytab.

    • KAFKA_SASL_GSSAPI_KRB5_CONF – Der S3-Speicherort einer Kerberos-krb5.conf-Datei. Eine Datei krb5.conf speichert Kerberos-Konfigurationsinformationen, wie z. B. den Standort des Servers. KDC Weitere Informationen finden Sie in der Kerberos-Dokumentation: krb5.confMIT.

    • KAFKA_SASL_GSSAPI_SERVICE – Der Name des Kerberos-Services, wie er in Ihrer Kafka-Konfiguration mit sasl.kerberos.service.name festgelegt wurde.

    • KAFKA_SASL_GSSAPI_PRINCIPAL- Der Name des Kerberos-Prinzials, der von verwendet wird. AWS Glue Weitere Informationen finden Sie in der Kafka-Dokumentation: Konfigurieren von Kafka-Brokern.

    • ROLE_ARN- Die Rolle, die für die Ausführung von Abfragen verwendet werden soll.

    • REGION- Die AWS Region, in der Abfragen ausgeführt werden.

    • WORKGROUP_NAME— Der Name einer serverlosen Amazon Redshift Redshift-Arbeitsgruppe oder Amazon Athena Athena-Arbeitsgruppe, in der Abfragen ausgeführt werden.

    • CLUSTER_IDENTIFIER— Die Cluster-ID eines Amazon Redshift Redshift-Clusters, in dem Abfragen ausgeführt werden.

    • DATABASE- Die Amazon Redshift Redshift-Datenbank, mit der Sie eine Verbindung herstellen.

  • PhysicalConnectionRequirements – Ein PhysicalConnectionRequirements-Objekt.

    Die physischen Verbindungsanforderungen, wie z. B. virtuelle private Cloud (VPC) undSecurityGroup, die erforderlich sind, um diese Verbindung erfolgreich herzustellen.

  • CreationTime – Zeitstempel.

    Der Zeitstempel des Zeitpunkts, zu dem diese Verbindungsdefinition erstellt wurde.

  • LastUpdatedTime – Zeitstempel.

    Der Zeitstempel der letzten Aktualisierung der Verbindungsdefinition.

  • LastUpdatedBy— UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, entspricht. Single-line string pattern

    Der Benutzer, die Gruppe oder die Rolle, von dem bzw. der diese Verbindung zuletzt aktualisiert wurde.

  • Status— UTF -8 Zeichenfolge (gültige Werte: READY | IN_PROGRESS |FAILED).

    Der Status der Verbindung. Dabei kann es sich um READY, IN_PROGRESS oder FAILED handeln.

  • StatusReason— UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 16384 Byte lang.

    Der Grund für den Verbindungsstatus.

  • LastConnectionValidationTime – Zeitstempel.

    Ein Zeitstempel der Uhrzeit, zu der diese Verbindung zuletzt validiert wurde.

  • AuthenticationConfiguration – Ein AuthenticationConfiguration-Objekt.

    Die Authentifizierungseigenschaften der Verbindung.

ConnectionInput Struktur

Eine Struktur, die zum Angeben einer Verbindung verwendet wird, die erstellt oder aktualisiert werden soll.

Felder
  • NameErforderlich: UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, entspricht. Single-line string pattern

    Der Name der Verbindung.

  • Description – Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.

    Beschreibung der Verbindung.

  • ConnectionTypeErforderlich: Zeichenfolge UTF -8 (gültige Werte: JDBC | | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | | CUSTOM SALESFORCE VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

    Typ der Verbindung. Derzeit werden folgende Typen unterstützt:

    • JDBC— Bezeichnet eine Verbindung zu einer Datenbank über Java Database Connectivity (). JDBC

      JDBCVerbindungen verwenden Folgendes. ConnectionParameters

      • Erforderlich: Alle von (HOST, PORT, JDBC_ENGINE) oder JDBC_CONNECTION_URL.

      • Erforderlich: Alle (USERNAME, PASSWORD,) oder SECRET_ID.

      • Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. Diese Parameter werden zur Konfiguration SSL mit verwendetJDBC.

    • KAFKA - Bezeichnet eine Verbindung zu einer Apache-Kafka-Streaming-Plattform.

      KAFKAVerbindungen verwenden Folgendes ConnectionParameters.

      • Erforderlich: KAFKA_BOOTSTRAP_SERVERS.

      • Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. Diese Parameter werden zur Konfiguration SSL mit verwendetKAFKA.

      • Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. Diese Parameter werden verwendet, um die TLS Client-Konfiguration mit SSL in zu konfigurierenKAFKA.

      • Optional: KAFKA_SASL_MECHANISM. Kann als SCRAM-SHA-512, GSSAPI oder AWS_MSK_IAM angegeben werden.

      • Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. Diese Parameter werden verwendet, um dieSASL/SCRAM- SHA -512-Authentifizierung mit KAFKA zu konfigurieren.

      • Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. Diese Parameter werden verwendet, um die GSSAPI Authentifizierung mit SASLKAFKA/zu konfigurieren.

    • MONGODB – Gibt eine Verbindung zu einer MongoDB-Dokumentendatenbank an.

      MONGODBVerbindungen verwenden Folgendes ConnectionParameters.

      • Erforderlich: CONNECTION_URL.

      • Erforderlich: Alle von (USERNAME, PASSWORD) oder SECRET_ID.

    • SALESFORCE— Bezeichnet eine Verbindung zu Salesforce mithilfe von OAuth Authentifizierung.

      • Erfordert, dass das AuthenticationConfiguration Mitglied konfiguriert ist.

    • VIEW_VALIDATION_REDSHIFT— Bezeichnet eine Verbindung, die für die Überprüfung von Ansichten durch Amazon Redshift verwendet wird.

    • VIEW_VALIDATION_ATHENA- Bezeichnet eine Verbindung, die für die Überprüfung von Ansichten durch Amazon Athena verwendet wird.

    • NETWORK- Bezeichnet eine Netzwerkverbindung zu einer Datenquelle in einer Amazon Virtual Private Cloud Cloud-Umgebung (AmazonVPC).

      NETWORKVerbindungen sind nicht erforderlich. ConnectionParameters Geben Sie stattdessen eine an PhysicalConnectionRequirements.

    • MARKETPLACE- Verwendet Konfigurationseinstellungen, die in einem Connector enthalten sind AWS Marketplace , um aus Datenspeichern zu lesen und in diese zu schreiben, die nicht nativ von AWS Glue unterstützt werden.

      MARKETPLACEVerbindungen verwenden Folgendes ConnectionParameters.

      • Erforderlich: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.

      • Erforderlich für JDBC CONNECTOR_TYPE-Verbindungen: Alle von (USERNAME, PASSWORD) oder SECRET_ID.

    • CUSTOM – Verwendet die in einem benutzerdefinierten Konnektor enthaltenen Konfigurationseinstellungen, der zum Lesen und Schreiben in nicht nativ von AWS Glue unterstützten Datastores erworben wurde.

    SFTP wird nicht unterstützt.

    Weitere Informationen darüber, wie optionale Funktionen zur Konfiguration verwendet ConnectionProperties werden AWS Glue, finden Sie unter AWS Glue Verbindungseigenschaften.

    Weitere Informationen darüber, wie optionale Funktionen zur Konfiguration von Funktionen in AWS Glue Studio verwendet ConnectionProperties werden, finden Sie unter Verwenden von Konnektoren und Verbindungen.

  • MatchCriteria— Ein Array von UTF -8 Zeichenfolgen, nicht mehr als 10 Zeichenketten.

    Eine Liste von Kriterien, die bei der Auswahl dieser Verbindung verwendet werden können.

  • ConnectionPropertiesErforderlich: Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 100 Paare.

    Jeder Schlüssel ist eine Zeichenfolge von UTF -8 (gültige Werte: HOST | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | SECRET_ID | | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | KAFKA_SASL_MECHANISM | KAFKA_SASL_PLAIN_USERNAME | KAFKA_SASL_PLAIN_PASSWORD | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD KAFKA_SASL_SCRAM_USERNAME KAFKA_SASL_SCRAM_PASSWORD| KAFKA_SASL_SCRAM_SECRETS_ARN | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB | KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | | KAFKA_SASL_GSSAPI_PRINCIPAL | ROLE_ARN | REGION | WORKGROUP_NAME CLUSTER_IDENTIFIER |DATABASE).

    Jeder Wert ist eine Wertzeichenfolge, die nicht mehr als 1024 Bytes lang ist.

    Diese Schlüssel-Wert-Paare definieren Parameter für die Verbindung.

  • PhysicalConnectionRequirements – Ein PhysicalConnectionRequirements-Objekt.

    Die physischen Verbindungsanforderungen, wie z. B. Virtual Private Cloud (VPC) undSecurityGroup, die erforderlich sind, um diese Verbindung erfolgreich herzustellen.

  • AuthenticationConfiguration – Ein AuthenticationConfigurationInput-Objekt.

    Die Authentifizierungseigenschaften der Verbindung. Wird für eine Salesforce-Verbindung verwendet.

  • ValidateCredentials – Boolesch.

    Eine Markierung zur Überprüfung der Anmeldeinformationen beim Erstellen der Verbindung. Wird für eine Salesforce-Verbindung verwendet. Der Standardwert ist „true“.

PhysicalConnectionRequirements Struktur

Die OAuth Client-App als GetConnection Antwort.

Felder
  • SubnetId— UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, entspricht. Single-line string pattern

    Die Subnetz-ID, die von der Verbindung verwendet wird.

  • SecurityGroupIdList— Ein Array von UTF -8 Zeichenketten, nicht mehr als 50 Zeichenketten.

    Die Sicherheitsgruppen-ID-Liste, die von der Verbindung verwendet wird.

  • AvailabilityZone— UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, entspricht der. Single-line string pattern

    Die Availability Zone der Verbindung.

GetConnectionsFilter Struktur

Filtert die Verbindungsdefinitionen, die von der GetConnections API Operation zurückgegeben werden.

Felder
  • MatchCriteria— Ein Array von UTF -8 Zeichenfolgen, nicht mehr als 10 Zeichenketten.

    Eine Kriterienzeichenfolge, die den Kriterien entsprechen muss, die in der Verbindungsdefinition hinterlegt sind, damit diese Verbindungsdefinition zurückgegeben wird.

  • ConnectionType— UTF -8 Zeichenfolge (gültige Werte: JDBC | | | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | | CUSTOM SALESFORCE VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

    Der Typ von Verbindungen, der zurückgegeben werden soll. SFTP wird derzeit nicht unterstützt.

Operationen

CreateConnection Aktion (Python: create_connection)

Erstellt eine Verbindungsdefinition im Data Catalog.

Verbindungen, die zum Erstellen von Verbundressourcen verwendet werden, benötigen die entsprechende Genehmigung. IAM glue:PassConnection

Anforderung
  • CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

    Die ID des Data Catalog, in dem die Verbindung erstellt wird. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • ConnectionInputErforderlich: Ein ConnectionInput-Objekt.

    Ein ConnectionInput-Objekt, das die zu erstellende Verbindung definiert.

  • Tags – Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 50 Paare.

    Jeder Schlüssel besteht aus einer Zeichenfolge von UTF -8, die nicht weniger als 1 oder mehr als 128 Byte lang ist.

    Jeder Wert ist eine Zeichenfolge von UTF -8, die nicht mehr als 256 Byte lang ist.

    Die Tags, die Sie der Verbindung zuweisen.

Antwort
  • CreateConnectionStatus— UTF -8 Zeichenfolge (gültige Werte: READY | IN_PROGRESS |FAILED).

    Der Status der Anfrage zur Verbindungserstellung. Die Anfrage kann bei bestimmten Authentifizierungstypen einige Zeit in Anspruch nehmen, z. B. wenn eine OAuth Verbindung mit Token Exchange Over hergestellt wirdVPC.

Fehler
  • AlreadyExistsException

  • InvalidInputException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • GlueEncryptionException

DeleteConnection Aktion (Python: delete_connection)

Löscht eine Verbindung aus dem Data Catalog.

Anforderung
  • CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

    Die ID des Data Catalog, in dem sich die Verbindung befindet. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • ConnectionNameErforderlich: UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, entspricht. Single-line string pattern

    Der Name der zu löschenden Verbindung.

Antwort
  • Keine Antwortparameter.

Fehler
  • EntityNotFoundException

  • OperationTimeoutException

GetConnection Aktion (Python: get_connection)

Ruft eine Verbindungsdefinition aus dem Data Catalog ab.

Anforderung
  • CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

    Die ID des Data Catalog, in dem sich die Verbindung befindet. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • NameErforderlich: UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, entspricht. Single-line string pattern

    Der Name der Verbindungsdefinition, die abgerufen werden soll.

  • HidePassword – Boolesch.

    Damit können Sie die Verbindungsmetadaten abrufen, ohne das Passwort zurückzugeben. Beispielsweise verwendet die AWS Glue Konsole dieses Flag, um die Verbindung abzurufen, und zeigt das Passwort nicht an. Legen Sie diesen Parameter fest, wenn der Anrufer möglicherweise nicht berechtigt ist, den AWS KMS Schlüssel zum Entschlüsseln des Kennworts zu verwenden, er jedoch berechtigt ist, auf die übrigen Verbindungseigenschaften zuzugreifen.

Antwort
  • Connection – Ein Verbindung-Objekt.

    Die angeforderte Verbindungsdefinition.

Fehler
  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

GetConnections Aktion (Python: get_connections)

Ruft eine Liste von Verbindungsdefinitionen aus dem Data Catalog ab.

Anforderung
  • CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

    Die ID des Data Catalog, in dem sich die Verbindungen befinden. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • Filter – Ein GetConnectionsFilter-Objekt.

    Ein Filter, der steuert, welche Verbindungen zurückgegeben werden.

  • HidePassword – Boolesch.

    Damit können Sie die Verbindungsmetadaten abrufen, ohne das Passwort zurückzugeben. Beispielsweise verwendet die AWS Glue Konsole dieses Flag, um die Verbindung abzurufen, und zeigt das Passwort nicht an. Legen Sie diesen Parameter fest, wenn der Anrufer möglicherweise nicht berechtigt ist, den AWS KMS Schlüssel zum Entschlüsseln des Kennworts zu verwenden, er jedoch berechtigt ist, auf die übrigen Verbindungseigenschaften zuzugreifen.

  • NextToken— UTF -8 Zeichenfolge.

    Ein Fortsetzungs-Token, wenn dies ein Fortsetzungsaufruf ist.

  • MaxResults – Zahl (Ganzzahl), nicht kleiner als 1 oder größer als 1000.

    Die maximale Anzahl von Verbindungen, die in einer Antwort zurückgegeben werden sollen.

Antwort
  • ConnectionList – Ein Array mit Verbindung-Objekten.

    Eine Liste von angeforderten Verbindungsdefinitionen.

  • NextToken— UTF -8 Zeichenfolge.

    Ein Fortsetzungs-Token, wenn die Liste der zurückgegebenen Verbindungen nicht die letzten gefilterten Verbindungen enthält.

Fehler
  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

UpdateConnection Aktion (Python: update_connection)

Aktualisiert eine Verbindungsdefinition im Data Catalog.

Anforderung
  • CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

    Die ID des Data Catalog, in dem sich die Verbindung befindet. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • NameErforderlich: UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, entspricht. Single-line string pattern

    Der Name der Verbindungsdefinition, die aktualisiert werden soll.

  • ConnectionInputErforderlich: Ein ConnectionInput-Objekt.

    Ein ConnectionInput-Objekt, das die jeweilige Verbindung neu definiert.

Antwort
  • Keine Antwortparameter.

Fehler
  • InvalidInputException

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

BatchDeleteConnection Aktion (Python: batch_delete_connection)

Löscht eine Liste von Verbindungsdefinitionen aus dem Data Catalog.

Anforderung
  • CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

    Die ID des Data Catalog, in dem sich die Verbindungen befinden. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • ConnectionNameListErforderlich: Ein Array von UTF -8 Zeichenfolgen, nicht mehr als 25 Zeichenketten.

    Eine Liste der Namen der Verbindungen, die gelöscht werden sollen.

Antwort
  • Succeeded— Ein Array von UTF -8 Zeichenketten.

    Eine Liste der Namen der Verbindungsdefinitionen, die erfolgreich gelöscht wurden.

  • Errors – Ein Map-Array von Schlüssel-Wert-Paaren.

    Jeder Schlüssel ist eine Zeichenfolge von UTF -8, die nicht weniger als 1 oder mehr als 255 Byte lang ist und der entspricht. Single-line string pattern

    Jeder Wert ist ein An ErrorDetail-Objekt.

    Eine Zuweisung der Namen von Verbindungen, die nicht erfolgreich gelöscht wurden, zu Fehlerdetails.

Fehler
  • InternalServiceException

  • OperationTimeoutException

Konfiguration der Authentifizierung

AuthenticationConfiguration Struktur

Eine Struktur, die die Authentifizierungskonfiguration enthält.

Felder
  • AuthenticationType— UTF -8 Zeichenfolge (gültige Werte: BASIC | OAUTH2 |CUSTOM).

    Eine Struktur, die die Authentifizierungskonfiguration enthält.

  • SecretArn— UTF -8 Zeichenfolge, entspricht derCustom string pattern #11.

    Der geheime Manager ARN zum Speichern von Anmeldeinformationen.

  • OAuth2Properties – Ein OAuth2Properties-Objekt.

    Die Eigenschaften für die OAuth2 Authentifizierung.

AuthenticationConfigurationInput Struktur

Eine Struktur, die die Authentifizierungskonfiguration in der CreateConnection Anfrage enthält.

Felder
  • AuthenticationType— UTF -8 Zeichenfolge (gültige Werte: BASIC | OAUTH2 |CUSTOM).

    Eine Struktur, die die Authentifizierungskonfiguration in der CreateConnection Anfrage enthält.

  • SecretArn— UTF -8 Zeichenfolge, entspricht derCustom string pattern #11.

    Der geheime Manager ARN zum Speichern von Anmeldeinformationen in der CreateConnection Anfrage.

  • OAuth2Properties – Ein OAuth2PropertiesInput-Objekt.

    Die Eigenschaften für die OAuth2 Authentifizierung in der CreateConnection Anfrage.

OAuth2PropertiesStruktur

Eine Struktur, die Eigenschaften für die OAuth2 Authentifizierung enthält.

Felder
  • OAuth2GrantType— UTF -8 Zeichenfolge (gültige Werte: AUTHORIZATION_CODE | CLIENT_CREDENTIALS |JWT_BEARER).

    Die Art des OAuth2 Zuschusses. Beispiel: AUTHORIZATION_CODE, JWT_BEARER oder CLIENT_CREDENTIALS.

  • OAuth2ClientApplication – Ein OAuth2ClientApplication-Objekt.

    Der Typ der Client-Anwendung. Zum Beispiel AWS _ MANAGED oder USER _MANAGED.

  • TokenUrl— UTF -8 Zeichenfolge, nicht mehr als 256 Byte lang, entspricht. Custom string pattern #12

    Der URL des Authentifizierungsservers des Anbieters, um einen Autorisierungscode gegen ein Zugriffstoken auszutauschen.

  • TokenUrlParametersMap – Ein Map-Array von Schlüssel-Wert-Paaren.

    Jeder Schlüssel besteht aus einer Zeichenfolge von UTF -8, die nicht weniger als 1 oder mehr als 128 Byte lang ist.

    Jeder Wert ist eine Zeichenfolge von UTF -8, die nicht weniger als 1 oder mehr als 512 Byte lang ist.

    Eine Zuordnung von Parametern, die der GET Token-Anfrage hinzugefügt werden.

OAuth2PropertiesInputStruktur

Eine Struktur, die Eigenschaften für OAuth2 in der CreateConnection Anfrage enthält.

Felder
  • OAuth2GrantType— UTF -8 Zeichenfolge (gültige Werte: AUTHORIZATION_CODE | CLIENT_CREDENTIALS |JWT_BEARER).

    Der OAuth2 Zuschusstyp in der CreateConnection Anfrage. Beispiel: AUTHORIZATION_CODE, JWT_BEARER oder CLIENT_CREDENTIALS.

  • OAuth2ClientApplication – Ein OAuth2ClientApplication-Objekt.

    Der Typ der Client-Anwendung in der CreateConnection Anfrage. Zum Beispiel AWS_MANAGED oder USER_MANAGED.

  • TokenUrl— UTF -8 Zeichenfolge, nicht mehr als 256 Byte lang, entspricht. Custom string pattern #12

    Der URL des Authentifizierungsservers des Anbieters, um einen Autorisierungscode gegen ein Zugriffstoken auszutauschen.

  • TokenUrlParametersMap – Ein Map-Array von Schlüssel-Wert-Paaren.

    Jeder Schlüssel besteht aus einer Zeichenfolge von UTF -8, die nicht weniger als 1 oder mehr als 128 Byte lang ist.

    Jeder Wert ist eine Zeichenfolge von UTF -8, die nicht weniger als 1 oder mehr als 512 Byte lang ist.

    Eine Zuordnung von Parametern, die der GET Token-Anfrage hinzugefügt werden.

  • AuthorizationCodeProperties – Ein AuthorizationCodeProperties-Objekt.

    Der Satz von Eigenschaften, die für den OAuth2 AUTHORIZATION_CODE Zuschusstyp erforderlich sind.

OAuth2ClientApplicationStruktur

Die für die Verbindung verwendete OAuth2 Client-App.

Felder
  • UserManagedClientApplicationClientId— UTF -8 Zeichenfolge, nicht mehr als 2048 Byte lang, entspricht. Custom string pattern #13

    Die ClientID der Client-Anwendung, falls ja. ClientAppType USER_MANAGED

  • AWSManagedClientApplicationReference— UTF -8 Zeichenfolge, nicht mehr als 2048 Byte lang, entspricht. Custom string pattern #13

    Der Verweis auf die SaaS-seitige Client-App, die verwaltet wird AWS .

AuthorizationCodeProperties Struktur

Der Satz von Eigenschaften, die für den Workflow mit der Art des OAuth2 AUTHORIZATION_CODE Zuschusses erforderlich sind.

Felder
  • AuthorizationCode— UTF -8 Zeichenfolge, nicht weniger als 1 oder mehr als 4096 Byte lang, entspricht. Custom string pattern #13

    Ein Autorisierungscode, der in der dritten Phase des AUTHORIZATION_CODE Grant-Workflows verwendet werden soll. Dies ist ein einmalig verwendbarer Code, der ungültig wird, sobald er gegen ein Zugriffstoken eingetauscht wird. Daher ist es akzeptabel, diesen Wert als Anforderungsparameter zu verwenden.

  • RedirectUri— UTF -8 Zeichenfolge, nicht mehr als 512 Byte lang, entspricht. Custom string pattern #14

    Die UmleitungURI, zu der der Benutzer bei der Ausgabe eines Autorisierungscodes vom Autorisierungsserver umgeleitet wird. Der URI wird anschließend verwendet, wenn der Autorisierungscode gegen ein Zugriffstoken ausgetauscht wird.