CreateLedger - Amazon Quantum Ledger-Datenbank (AmazonQLDB)
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

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.

CreateLedger

Erstellt ein neues Hauptbuch in Ihrem AWS-Konto in der aktuellen Region.

Anforderungssyntax

POST /ledgers HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

DeletionProtection

Gibt an, ob der Ledger vor dem Löschen durch einen beliebigen Benutzer geschützt ist. Wenn es während der Ledger-Erstellung nicht definiert wird, ist diese Funktion standardmäßig aktiviert (true).

Wenn der Löschschutz aktiviert ist, müssen Sie ihn zuerst deaktivieren, bevor Sie das Ledger löschen können. Sie können ihn deaktivieren, indem Sie mit dem UpdateLedger-Vorgang den Parameter auf false einstellen.

Typ: Boolesch

Erforderlich: Nein

KmsKey

Der Schlüssel in AWS Key Management Service (AWS KMS), der für die Verschlüsselung ruhender Daten im Ledger verwendet werden soll. Weitere Informationen finden Sie unter Verschlüsselung im Ruhezustand im Amazon-QLDB-Entwicklerhandbuch.

Verwenden Sie eine der folgenden Optionen, um diesen Parameter anzugeben:

  • AWS_OWNED_KMS_KEY: Verwenden Sie einen AWS KMS Schlüssel, der in Ihrem Namen gehört und von AWS diesem verwaltet wird.

  • Undefiniert: Verwenden Sie standardmäßig einen AWS eigenen KMS-Schlüssel.

  • Ein gültiger, symmetrischer, vom Kunden verwalteter KMS-Schlüssel: Den angegebenen symmetrischen KMS-Verschlüsselungsschlüssel in Ihrem Konto verwenden, den Sie erstellen, besitzen und verwalten.

    Amazon EBS unterstützt keine asymmetrischen Schlüssel. Weitere Informationen finden Sie unter Verwenden von symmetrischen und asymmetrischen Schlüsseln im AWS Key Management Service Entwicklerhandbuch.

Um einen vom Kunden verwalteten KMS-Schlüssel anzugeben, können Sie seine Schlüssel-ID, den Amazon-Ressourcennamen (ARN), den Aliasnamen oder den Alias-ARN verwenden. Wenn Sie einen Aliasnamen verwenden, stellen Sie ihm "alias/" voran. Um einen Schlüssel in einem anderen anzugeben AWS-Konto, müssen Sie den Schlüssel ARN oder den Alias ARN verwenden.

Beispielsweise:

  • Schlüssel-ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Schüssel-ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias-Name: alias/ExampleAlias

  • Alias-ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

Weitere Informationen finden Sie unter Schlüsselkennungen (KeyId) im AWS Key Management Service Entwicklerhandbuch.

Typ: Zeichenfolge

Längenbeschränkungen: Die maximale Länge beträgt 1600.

Erforderlich: Nein

Name

Der Name des Ledgers, das Sie erstellen möchten. Der Name muss für alle Ledger AWS-Konto in Ihrer aktuellen Region eindeutig sein.

Die Beschränkungen für die Namen von Ledgern sind im Abschnitt Kontingente in Amazon QLDB im Amazon QLDB-Entwicklerhandbuch definiert.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 32 Zeichen.

Pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Erforderlich: Ja

PermissionsMode

Der Berechtigungsmodus, der dem Ledger zugewiesen werden soll, das Sie erstellen möchten. Folgende Parameterwerte sind möglich:

  • ALLOW_ALL: Ein Legacy-Berechtigungsmodus, der die Zugriffskontrolle mit Granularität auf API-Ebene für Ledgers ermöglicht.

    Dieser Modus ermöglicht Benutzern, die SendCommand-API-Berechtigung für dieses Ledger zum Ausführen aller PartiQL-Befehle (daher ALLOW_ALL) auf beliebigen Tabellen im angegebenen Ledger auszuführen. Dieser Modus ignoriert alle IAM-Berechtigungs-Richtlinien auf Tabellen- oder Befehls-Ebene, die Sie für das Ledger erstellen.

  • STANDARD: (Empfohlen) Ein Berechtigungsmodus, der Zugriffskontrolle mit feinerer Granularität für Ledger, Tabellen und PartiQL-Befehle ermöglicht.

    Standardmäßig verweigert dieser Modus alle Benutzer-Anforderungen zur Ausführung von PartiQL-Befehlen für Tabellen in diesem Ledger. Damit PartiQL-Befehle ausgeführt werden können, müssen Sie IAM-Berechtigungs-Richtlinien für bestimmte Tabellen-Ressourcen und PartiQL-Aktionen erstellen, zusätzlich zu den SendCommand API-Berechtigung für den Ledger. Weitere Informationen finden Sie unter Erste Schritte mit dem Standard-Berechtigungsmodus im Amazon-QLDB-Entwicklerhandbuch.

Anmerkung

Wir empfehlen dringend, den STANDARD Berechtigungsmodus, um die Sicherheit Ihrer Ledger-Daten zu maximieren.

Typ: Zeichenfolge

Zulässige Werte: ALLOW_ALL | STANDARD

Erforderlich: Ja

Tags

Die Schlüssel-Wert-Paare, die dem Ledger, das Sie erstellen möchten, als Tags hinzugefügt werden sollen. Bei Tag-Schlüsseln wird zwischen Groß- und Kleinschreibung unterschieden. Bei Tag-Werten wird zwischen Groß- und Kleinschreibung unterschieden und sie können Null sein.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Karteneinträge: Mindestanzahl von 0 Elementen. Die maximale Anzahl beträgt 200 Elemente.

Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.

Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "KmsKeyArn": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "State": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

Arn

Der Amazon-Ressourcenname (ARN) für das Ledger.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.

CreationDateTime

Das Datum und die Uhrzeit der Erstellung des Ledgers im Epochenzeitformat. (Das Epochenzeitformat ist die Anzahl der Sekunden, die seit dem 1. Januar 1970 um 00:00:00 Uhr UTC vergangen sind.)

Typ: Zeitstempel

DeletionProtection

Gibt an, ob der Ledger vor dem Löschen durch einen beliebigen Benutzer geschützt ist. Wenn es während der Ledger-Erstellung nicht definiert wird, ist diese Funktion standardmäßig aktiviert (true).

Wenn der Löschschutz aktiviert ist, müssen Sie ihn zuerst deaktivieren, bevor Sie das Ledger löschen können. Sie können ihn deaktivieren, indem Sie mit dem UpdateLedger-Vorgang den Parameter auf false einstellen.

Typ: Boolesch

KmsKeyArn

Der ARN des vom Kunden verwalteten KMS-Schlüssels, den das Ledger für die Verschlüsselung im Ruhezustand verwendet. Wenn dieser Parameter nicht definiert ist, verwendet das Ledger einen AWS eigenen KMS-Schlüssel für die Verschlüsselung.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.

Name

Der Name des Ledgers.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 32 Zeichen.

Pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

PermissionsMode

Der Berechtigungsmodus des Ledgers, das Sie erstellt haben.

Typ: Zeichenfolge

Zulässige Werte: ALLOW_ALL | STANDARD

State

Der aktuelle Status des Ledgers.

Typ: Zeichenfolge

Zulässige Werte: CREATING | ACTIVE | DELETING | DELETED

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InvalidParameterException

Ein oder mehrere Parameter in der Anfrage sind nicht gültig.

HTTP Status Code: 400

LimitExceededException

Sie haben das Limit für die maximal zulässige Anzahl von Ressourcen erreicht.

HTTP Status Code: 400

ResourceAlreadyExistsException

Die angegebene Ressource ist bereits vorhanden.

HTTP-Statuscode: 409

ResourceInUseException

Die angegebene Ressource kann derzeit nicht geändert werden.

HTTP-Statuscode: 409

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: