Amazon S3 Simple Storage Connector

Dieser Adapter verwaltet Daten und deren Strukturen in Amazon S3 Blob Storage. Zudem wird die Persistierung von Daten in Cloud-Umgebungen ermöglicht.

Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operation

Mögliche Werte:

CreateBucket: Legt ein Bucket an.
(information) Für die Operation CreateBucket können verschiedene Konfigurationen vorgenommen werden. Ist beispielsweise der Parameter bucketVersion auf ENABLED gesetzt, wird die Bucket-Versionierung aktiviert. Andernfalls ist die Versionierung deaktiviert. Ist der Parameter publicAccess aktiviert, muss über den Parameter publicPermission eine Berechtigung definiert werden.
Erforderliche Parameter: bucket, bucketVersion, publicAccess, publicPermission
ChangeBucketVersion: Ändert die Versionierungs-Konfiguration des Buckets.
(information) Neue Buckets sind standardmäßig im OFF-Status. Sobald die Versionierung aktiviert wird, kann der Status nicht mehr auf OFF zurückgesetzt werden.
Erforderliche Parameter: bucket, bucketVersion
GetAccessControlList: Listet die Rechte und Berechtigungen für ein Bucket oder eine Datei auf.
(information) Sind die Parameter bucket und file angegeben, werden die Rechte und Berechtigungen für die Datei ausgegeben. Ist nur bucket angegeben, werden die Rechte und Berechtigungen für den Bucket ausgegeben.
Erforderliche Parameter: bucket, file
AddGrantsPermission: Fügt einem Bucket oder einer Datei Rechte mit Berechtigungen hinzu .
(information) Ist der Parameter publicAccess aktiviert, wird ein öffentlich zugänglicher Bucket oder eine Datei angelegt mit den Berechtigungen, die im Parameter publicPermission definiert wurden. Andernfalls werden Informationen aus dem Input genommen. Sind die Parameter bucket und file angegeben, werden die Rechte und Berechtigungen zur Datei hinzugefügt. Ist nur bucket angegeben, werden die Rechte und Berechtigungen dem Bucket hinzugefügt.
Erforderliche Parameter: bucket, file
RevokeGrantsPermission: Widerruft alle Berechtigungen.
(information) Sind die Parameter bucket und file angegeben, werden die Rechte und Berechtigungen für die Datei widerrufen. Ist nur bucket angegeben, werden die Rechte und Berechtigungen für den Bucket widerrufen.
Erforderliche Parameter: bucket, file
RevokePublicPermission: Widerruft die Berechtigungen für den öffentlichen Zugang.
(information) Sind die Parameter bucket und file angegeben, werden die Berechtigungen für den öffentlichen Zugang auf eine Datei widerrufen. Ist nur bucket angegeben, werden die Berechtigungen für den öffentlichen Zugang auf den Bucket widerrufen.
Erforderliche Parameter: bucket, file
AddBucketPolicy: Fügt eine Bucket-Richtlinie zu einem angegebenen Bucket hinzu.
(information) Unter folgenden Links finden Sie Zusatzinformationen, wie Beispiele für Bucket-Richtlinien, Berechtigungen in einer Richtlinien und Bedingungen in Richtlinien.
Erforderliche Parameter: bucket
GetBucketPolicy: Ruft die Bucket-Richtlinie auf.
Erforderliche Parameter: bucket
RemoveBucketPolicy: Löscht die Richtlinie für den angegebenen Bucket.
Erforderliche Parameter: bucket
Search: Sucht nach Informationen im AmazonS3 Simple Storage Konto und optional auch noch nach Objekt-Metadaten.
(information) Ist der Parameter includeObjectsMetadata ausgewählt, werden Metadaten-Informationen zu jedem Objekt der Standard-Antwort hinzugefügt.
Erforderliche Parameter: file, includeObjectsMetadata
Upload: Lädt Dateien zum Amazon S3 Simple Storage Konto hoch.
(information) Legen Sie Ordnerstrukturen mit "/" an, z. B. Lib/Document/doc.txt.
Erforderliche Parameter: bucket, file, overwrite, path
Download: Lädt Dateien vom Amazon S3 Simple Storage Konto herunter.
Erforderliche Parameter: bucket, file
Copy: Kopiert Dateien in den Ziel-Bucket.
(information) Um eine Datei zu kopieren, ist eine Berechtigung für das Ziel-Bucket erforderlich.
Erforderliche Parameter: bucket, file, targetBucket, targetFile
Move: Verschiebt Dateien in den Ziel-Bucket .
(information) Um eine Datei zu verschieben, ist eine Berechtigung für das Ziel-Bucket erforderlich.
Erforderliche Parameter: bucket, file, targetBucket, targetFile
Rename: Benennt Dateien in den Ziel-Bucket um.
Delete

: Löscht Dateien oder Buckets.
(information) Sind bucket und file angegeben, wird die angegebene Datei gelöscht. Ist nur bucket angegeben, werden alle Dateien im Bucket und anschließend der Bucket selbst gelöscht. Ist die Bucket-Versionierung eingeschaltet, werden zuerst die Dateiversionen und anschließend der Bucket gelöscht.
DeleteMultiFiles: Löscht mehrere Dateien.
Erforderliche Parameter: bucket, file

Parameter

Adapter

Adapter-Hauptklasse (nicht verändern!)

Mögliche Werte: de.softproject.integration.adapter.amazons3.AmazonS3SimpleStorageAdapter: Hauptklasse (Standard)

keyID

Zugangsschlüssel-ID für Anfragen an AWS (Amazon Web Services)

(information) Die Zugangsdaten werden über Parameter an den Adapter gesendet. Dabei gibt es verschiedene Konfigurationsmöglichkeiten, siehe Zugangsdaten einrichten.

Mögliche Werte: Beliebige Zeichenkette mit der Zugangsschlüssel-ID, z. B. AKIAIOSFODNN7EXAMPLE

secretKey

Geheimer Zugangsschlüssel für Anfragen an AWS

(information) Die Zugangsdaten werden über Parameter an den Adapter gesendet. Dabei gibt es verschiedene Konfigurationsmöglichkeiten, siehe Zugangsdaten einrichten .

Mögliche Werte: Beliebige Zeichenkette mit der geheimen Zugangsschlüssel, z. B. wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

region

Bucket-Region

Mögliche Werte: Beliebige Zeichenkette mit dem Namen der Region, z. B. us-east-2

(information) Buckets, die in einer bestimmten Region erstellt wurden, können nicht von einer anderen Region aus aufgerufen werden, siehe Regionen und Endpoints.

bucket

Bucket-Name

(information) Der Bucket-Name muss innerhalb von Amazon S3 eindeutig sein, siehe Buckets.

Mögliche Werte: Beliebige Zeichenkette mit dem Bucket-Namen

Folgende Regeln gelten für die Benennung von S3-Buckets in allen AWS-Regionen. Bucket-Namen ...

müssen innerhalb von Amazon S3 eindeutig sein
müssen den DNS-Namenskonventionen entsprechen
müssen mindestens 3 und höchstens 63 Zeichen lang sein
dürfen keine Großbuchstaben oder Unterstriche enthalten
müssen mit einem Kleinbuchstaben oder einer Zahl beginnen
müssen eine Reihe aus einem oder mehreren Zeichen sein
Aufeinander folgende Namen werden durch einen einzelnen Punkt (.) getrennt. Bucket-Namen können Kleinbuchstaben, Zahlen und Bindestriche enthalten. Jeder Name muss mit einem Kleinbuchstaben oder einer Zahl beginnen und enden.
dürfen nicht als IP-Adresse formatiert sein, z. B. 192.168.5.4
Beim Verwenden von virtuellen gehosteten Buckets mit SSL (Secure Sockets Layer) trifft das SSL-Wildcard-Zertifikat nur auf Buckets zu, die keine Punkte enthalten. Um dies zu umgehen, verwenden Sie HTTP oder schreiben Sie Ihre eigene Zertifikatsprüfungs-Logik. Bei virtuellen gehosteten Buckets empfehlen wir keine Punkte (.) im Bucket-Namen zu verwenden.

bucketVersion

Bucket-Versionierung, um mehrere Varianten eines Objekts im selben Bucket zu halten

Mögliche Werte:

OFF: Die Versionierung ist deaktiviert (Standard)
(information) Ist die Versionierung für ein Bucket aktiviert, kann sie nicht mehr deaktiviert und auf den Status OFF gesetzt werden. Die Versionierung kann lediglich ausgesetzt und auf den Status SUSPENDED gesetzt werden.
ENABLED: Die Bucket-Versionierung ist aktiviert
SUSPENDED: Die Bucket-Versionierung wird ausgesetzt, wenn die Versionierung vorher aktiviert war

publicAccess

Gibt an, ob Buckets oder Dateien bei der Operation AddGrantsPermission öffentlich zugänglich sind oder nicht

publicPermission

Konfiguration für den öffentlichen Zugang

Mögliche Werte:

Berechtigung	Bei einem Bucket gestattet	Bei einem Objekt gestattet
`READ`	Erlaubt es, die Objekte im Bucket aufzulisten	Erlaubt es, die Objekt-Daten und -Metadaten zu lesen
`WRITE`	Erlaubt es, ein beliebiges Objekt im Bucket zu erstellen, zu überschreiben und zu löschen	Nicht anwendbar
`READ_ACP`	Erlaubt es, die Bucket-ACP zu lesen	Erlaubt es, die Objekt-ACP zu lesen
`WRITE_ACP`	Erlaubt es, die ACP für den jeweiligen Bucket zu schreiben	Erlaubt es, die ACP für das jeweilige Objekt zu schreiben
`FULL_CONTROL`	Erlaubt Zugriff auf die Bucket-Berechtigungen `READ`, `WRITE`, `READ_ACP` und `WRITE_ACP`	Erlaubt Zugriff auf die Objekt-Berechtigungen `READ`, `WRITE`, `READ_ACP` und `WRITE_ACP`

file

Name der zu speichernden Datei, siehe Objekte

Folgende Zeichensätze sind im Allgemeinen in Schlüssel-Namen zulässig:

Alphanumerische Zeichen [0-9a-zA-Z]
Sonderzeichen: !, -, _, ., *, ', (, und )

Mögliche Werte: Beliebige Zeichenkette mit dem Objekt-Schlüssel-Namen, z. B.

4my-organization
my.great_photos-2014/jan/myvacation.jpg
videos/2014/birthday/video1.wmv

path

Pfad der hochzuladenden Datei

Mögliche Werte: Beliebiger gültiger Pfad, z. B.

X4DB-Pfad: x4db://1/.....
XSTORE-Pfad xstore://
Vollständiger Pfad: C:/Documents/....

overwrite

Information, ob die Datei überschrieben werden soll oder nicht

Mögliche Werte:

true: Überschreibt die Datei
false: Überschreibt die Datei nicht

targetBucket

Name des Buckets, in dem die Datei kopiert oder verschoben werden soll

Mögliche Werte: Siehe Parameter bucket

targetFile

Name der Datei, wenn sie unter dem neuen Pfad kopiert oder verschoben wird

Mögliche Werte: Siehe Parameter file

includeObjectsMetadata

Gibt an, ob Objekt-Metadaten als Teil der Antwort einbezogen werden oder nicht

Possible values:

true: Objekt-Metadaten werden als Teil der Antwort einbezogen
false: Objekt-Metadaten werden nicht als Teil der Antwort einbezogen

Statuswerte

`1`	Die Adapter-Operation wurde erfolgreich ausgeführt
`0`	Die Ausführung der Operation wurde noch nicht abgeschlossen oder es wurde kein Ergebnis ausgegeben
`-1`	Bei der Ausführung des Adapters kam es zu einem Fehler

Input

Der Adapter erwartet ein beliebiges Input-Dokument, z. B. ein Binär- oder ein Base-64-Dokument (XML oder Text).

Operation Upload: Ist der Parameter path angegeben, wird kein Input-Dokument vorausgesetzt. In allen anderen Fällen wird ein Input-Dokument erwartet.
Operation Download und Search: Es wird kein Input-Dokument vorausgesetzt.

Operation AddGrantsPermission:

XML

<?xml version='1.0' encoding='UTF-8'?>
<RootElement>
    <Grant id="Canonical User ID">
        <permission> Read </permission>
		<permission> Write </permission>
		<permission> WriteAcp </permission>
		<permission> ReadAcp </permission>
		<permission> FullControl </permission>
    </Grant>
</RootElement>

(information) Um Objekt-Berechtigungen hinzuzufügen, sind die Parameter bucket und file erforderlich. Um Bucket-Berechtigungen hinzuzufügen, ist der Parameter bucket erforderlich und file muss leer sein.

Operation RevokeGrantsPermission:
XML
```
<?xml version='1.0' encoding='UTF-8'?>
<RootElement>
    <Grant id="Canonical User ID">
    </Grant>
</RootElement>
```
(information) Um Objekt-Berechtigungen hinzuzufügen, sind die Parameter bucket und file erforderlich. Um Bucket-Berechtigungen hinzuzufügen, ist der Parameter bucket erforderlich und file muss leer sein.
Für die Operation AddBucketPolicy muss der Input im JSON-Format erfolgen
(information) Unter folgenden Links finden Sie Zusatzinformationen, wie Beispiele für Bucket-Richtlinien, Berechtigungen in einer Richtlinien und Bedingungen in Richtlinien.

Operation DeleteMultiFiles:

XML

<?xml version='1.0' encoding='UTF-8'?>
<RootElement>
    <Object name="File Name"></Object>
	<Object name="File Name"></Object>
	<Object name="File Name"></Object>
	<Object name="File Name"></Object>
</RootElement>

Output

Der Adapter gibt abhängig von der ausgeführten Operation verschiedene Dokumente aus:

Operation Upload:
Wurde der Adapter erfolgreich ausgeführt (Status 1), wird ein XML-Dokument ausgegeben.Kam es zu einem Fehler während der Adapter-Ausführung (Status -1), wird nichts ausgegeben.
Operation Search:Wurde der Adapter erfolgreich ausgeführt (Status 1), wird ein XML-Dokument mit den verwendeten Filtern ausgegeben.Beispiel-Output für die Operation SEARCH <?xml version='1.0' encoding='UTF-8'?> <ListBucket> <Bucket name="test-malaga2" region="eu-west-1"> <Object name="myFile.xml" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/myFile.xml"/> <Object name="myFile2.xml" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/myFile2.xml"/> <Object name="pic2.jpg" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/pic2.jpg"/> <Object name="testing_folders/" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/testing_folders/"/> <Object name="testing_folders/personalData.txt" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/testing_folders/personalData.txt"/> </Bucket> </ListBucket> Wurde der Adapter erfolgreich ausgeführt (Status 1) und der Parameter IncludeObjectsMetada ist ausgewählt , werden zusätzlich die Metadaten für jedes Objekt ausgegeben:Beispiel-Output für die Operation SEARCH inklusive Metadaten <?xml version='1.0' encoding='UTF-8'?> <ListBucket> <Bucket name="test-malaga2" region="eu-west-1"> <Object name="myFile.xml" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/myFile.xml"> <Metadata lastModified="2018-12-10 13:42:38.000 +0100" instanceLength="158" eTag="a933d9ca99b473c7921c496727a32f91" contentType="application/octet-stream" contentLength="158"/> </Object> <Object name="myFile2.xml" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/myFile2.xml"> <Metadata lastModified="2018-12-10 12:02:07.000 +0100" instanceLength="158" eTag="a933d9ca99b473c7921c496727a32f91" contentType="application/octet-stream" contentLength="158" contentLanguage="English"/> </Object> <Object name="pic2.jpg" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/pic2.jpg"> <Metadata lastModified="2018-12-10 11:37:52.000 +0100" instanceLength="59580" eTag="fb913694d969758b431277b366f53d7" contentType="image/jpeg" contentLength="59580" contentLanguage="Spanish"/> </Object> <Object name="testing_folders/" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/testing_folders/"> <Metadata lastModified="2018-12-10 12:24:54.000 +0100" eTag="d41d8cd98f00b204e9800998ecf8427e" contentType="application/x-directory"/> </Object> <Object name="testing_folders/personalData.txt" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/testing_folders/personalData.txt"> <Metadata lastModified="2018-12-10 12:30:35.000 +0100" instanceLength="33" eTag="7960fb01e91834eb9d5ccbacdf45d0e5" contentType="application/octet-stream" contentLength="33" contentLanguage="Spanish"/> </Object> </Bucket> </ListBucket> Kam es zu einem Fehler während der Adapter-Ausführung (Status -1), wird nichts ausgegeben.
Operation Download:Wurde der Adapter erfolgreich ausgeführt (Status 1), wird der heruntergeladene Blob (Text, XML, Binärdokument etc.) ausgegeben.Existieren das Objekt oder der Bucket nicht, wird der Status -1 zurückgegeben.

Operation GetAccessControlList:

XML

<AccessControlList>
    <Object Grant="e0188cd1cbfbb71222450e8e416e138172b036cdf3646ab51fb0ae6334d5ae51" Permission="FULL_CONTROL"/>
    <Object Grant="7779a9de4e188ca2c3fd5ef47f12f2a0fd3b9b30d283e343e0a55746d8df4802" Permission="READ"/>
	<Object Grant="7779a9de4e188ca2c3fd5ef47f12f2a0fd3b9b30d283e343e0a55746d8df4802" Permission="READ_ACP"/>
</AccessControlList>

Operation GetBucketPolicy :

Java

{
"Version":"2012-10-17", "Statement":[
}
"Sid":"AddPerm",
"Effect":"Allow",
"Principal":"*",
"Action":"s3:GetObject",
"Resource":"arn:aws:s3:::softprojectamazons3input/*"
}
]
}