RestoreDBClusterFromSnapshot - Amazon DocumentDB
AnforderungsparameterAntwortelementeFehlerWeitere 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.

RestoreDBClusterFromSnapshot

Erstellt einen neuen Cluster aus einem Snapshot oder Cluster-Snapshot.

Wenn ein Snapshot angegeben ist, wird der Zielcluster aus dem Quell-DB-Snapshot mit einer Standardkonfiguration und einer Standardsicherheitsgruppe erstellt.

Wenn ein Cluster-Snapshot angegeben ist, wird der Zielcluster vom Quell-Cluster-Restorepoint mit derselben Konfiguration wie der ursprüngliche Quell-DB-Cluster erstellt, mit der Ausnahme, dass der neue Cluster mit der Standardsicherheitsgruppe erstellt wird.

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

DBClusterIdentifier

Der Name des Clusters, der aus dem Snapshot oder Cluster-Snapshot erstellt werden soll. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Einschränkungen:

  • Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.

  • Das erste Zeichen muss ein Buchstabe sein.

  • Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.

Beispiel: my-snapshot-id

Typ: Zeichenfolge

Erforderlich: Ja

Engine

Die Datenbank-Engine, die für den neuen Cluster verwendet werden soll.

Standard: Entspricht der Quelle.

Einschränkung: Muss mit der Engine der Quelle kompatibel sein.

Typ: Zeichenfolge

Erforderlich: Ja

SnapshotIdentifier

Die Kennung für den Snapshot oder den Cluster-Snapshot, der zur Wiederherstellung verwendet werden soll.

Sie können entweder den Namen oder den Amazon-Ressourcennamen (ARN) verwenden, um einen Cluster-Snapshot festzulegen. Sie können jedoch auch nur den ARN verwenden, um einen Snapshot festzulegen.

Einschränkungen:

  • Muss mit der Kennung eines vorhandenen Snapshots übereinstimmen.

Typ: Zeichenfolge

Erforderlich: Ja

AvailabilityZones. AvailabilityZoneN

Stellt die Liste der Amazon EC2 Availability Zones bereit, in denen Instances im wiederhergestellten DB-Cluster erstellt werden können.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

DBClusterParameterGroupName

Der Name der DB-Cluster-Parametergruppe, die mit diesem DB-Cluster verknüpft werden soll.

Typ: Zeichenfolge.       Erforderlich: Nein.

Wenn dieses Argument weggelassen wird, wird die standardmäßige DB-Cluster-Parametergruppe verwendet. Falls angegeben, muss sie mit dem Namen einer vorhandenen Standard-DB-Cluster-Parametergruppe übereinstimmen. Die Zeichenfolge muss aus 1 bis 255 Buchstaben, Zahlen oder Bindestrichen bestehen. Das erste Zeichen muss ein Buchstabe sein und darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.

Typ: Zeichenfolge

Erforderlich: Nein

DBSubnetGroupName

Der Name der Subnetzgruppe, die für den neuen Cluster verwendet werden soll.

Einschränkungen: Falls angegeben, muss der Name mit dem Namen einer vorhandenen DBSubnetGroup Datei übereinstimmen.

Beispiel: mySubnetgroup

Typ: Zeichenfolge

Erforderlich: Nein

DeletionProtection

Gibt an, ob dieser Cluster gelöscht werden kann. Wenn DeletionProtection aktiviert, kann der Cluster nur gelöscht werden, wenn er geändert und DeletionProtection deaktiviert wurde. DeletionProtectionschützt Cluster davor, versehentlich gelöscht zu werden.

Typ: Boolesch

Erforderlich: Nein

EnableCloudwatchLogsExports.Mitglied.N

Eine Liste von Protokolltypen, die für den Export nach Amazon CloudWatch Logs aktiviert sein müssen.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

EngineVersion

Die Version der Datenbank-Engine, die für den neuen Cluster verwendet werden soll.

Typ: Zeichenfolge

Erforderlich: Nein

KmsKeyId

Die AWS KMS Schlüssel-ID, die bei der Wiederherstellung eines verschlüsselten Clusters aus einem DB-Snapshot oder Cluster-Snapshot verwendet werden soll.

Die AWS KMS Schlüssel-ID ist der Amazon-Ressourcenname (ARN) für den AWS KMS Verschlüsselungsschlüssel. Wenn Sie einen Cluster mit demselben wiederherstellen AWS-Konto , dem der AWS KMS Verschlüsselungsschlüssel gehört, mit dem der neue Cluster verschlüsselt wurde, können Sie den AWS KMS Schlüsselalias anstelle des ARN für den AWS KMS Verschlüsselungsschlüssel verwenden.

Wenn Sie keinen Wert für den KmsKeyId-Parameter angeben, geschieht folgendes:

  • Wenn der Snapshot oder Cluster-Snapshot verschlüsselt SnapshotIdentifier ist, wird der wiederhergestellte Cluster mit dem AWS KMS Schlüssel verschlüsselt, der zum Verschlüsseln des Snapshots oder Cluster-Snapshots verwendet wurde.

  • Wenn der Snapshot oder der Cluster-Snapshot nicht verschlüsselt SnapshotIdentifier ist, ist der wiederhergestellte DB-Cluster nicht verschlüsselt.

Typ: Zeichenfolge

Erforderlich: Nein

Port

Die Portnummer, auf der der neue Cluster Verbindungen akzeptiert.

Einschränkungen: Muss ein Wert von 1150 bis sein65535.

Standard: Derselbe Port wie der ursprüngliche Cluster.

Typ: Ganzzahl

Erforderlich: Nein

StorageType

Der Speichertyp, der dem DB-Cluster zugeordnet werden soll.

Informationen zu Speichertypen für Amazon DocumentDB-Cluster finden Sie unter Cluster-Speicherkonfigurationen im Amazon DocumentDB Developer Guide.

Gültige Werte für den Speichertyp - standard | iopt1

Der Standardwert ist standard

Typ: Zeichenfolge

Erforderlich: Nein

Tags.Tag.N

Die Tags, die dem wiederhergestellten Cluster zugewiesen werden sollen.

Typ: Array von Tag-Objekten

Erforderlich: Nein

VpcSecurityGroupIds. VpcSecurityGroupIdN

Eine Liste der Virtual Private Cloud (VPC) -Sicherheitsgruppen, zu denen der neue Cluster gehören wird.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

Antwortelemente

Das folgende Element wird vom Dienst zurückgegeben.

DBCluster

Detaillierte Informationen zu einem Cluster.

Typ: DBCluster Objekt

Fehler

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

DBClusterAlreadyExistsFault

Sie haben bereits einen Cluster mit der angegebenen Kennung.

HTTP Status Code: 400

DBClusterQuotaExceededFault

Der Cluster kann nicht erstellt werden, da Sie das maximal zulässige Kontingent an Clustern erreicht haben.

HTTP Status Code: 403

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifierbezieht sich nicht auf einen vorhandenen Cluster-Snapshot.

HTTP Status Code: 404

DBSnapshotNotFound

DBSnapshotIdentifierbezieht sich nicht auf einen vorhandenen Snapshot.

HTTP Status Code: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupNamebezieht sich nicht auf eine bestehende Subnetzgruppe.

HTTP Status Code: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupNamebezieht sich nicht auf eine bestehende Subnetzgruppe.

HTTP Status Code: 404

InsufficientDBClusterCapacityFault

Der Cluster verfügt nicht über genügend Kapazität für den aktuellen Vorgang.

HTTP Status Code: 403

InsufficientStorageClusterCapacity

Für die aktuelle Aktion ist nicht genügend Speicherplatz verfügbar. Möglicherweise können Sie diesen Fehler beheben, indem Sie Ihre Subnetzgruppe so aktualisieren, dass sie verschiedene Availability Zones verwendet, in denen mehr Speicherplatz verfügbar ist.

HTTP Status Code: 400

InvalidDBClusterSnapshotStateFault

Der angegebene Wert ist kein gültiger Cluster-Snapshot-Status.

HTTP Status Code: 400

InvalidDBSnapshotState

Der Status des Snapshots erlaubt kein Löschen.

HTTP Status Code: 400

InvalidRestoreFault

Sie können keine Wiederherstellung von einem Virtual Private Cloud (VPC) -Backup auf eine Nicht-VPC-DB-Instance durchführen.

HTTP Status Code: 400

InvalidSubnet

Das angeforderte Subnetz ist ungültig, oder es wurden mehrere Subnetze angefordert, die sich nicht alle in einer gemeinsamen Virtual Private Cloud (VPC) befinden.

HTTP Status Code: 400

InvalidVPCNetworkStateFault

Die Subnetzgruppe deckt nach ihrer Erstellung nicht alle Availability Zones ab, da Änderungen vorgenommen wurden.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

Beim Zugriff auf einen AWS KMS Schlüssel ist ein Fehler aufgetreten.

HTTP Status Code: 400

StorageQuotaExceeded

Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instanzen verfügbar ist.

HTTP Status Code: 400

StorageQuotaExceeded

Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instanzen verfügbar ist.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

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