CreateDBCluster - 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.

CreateDBCluster

Erstellt einen neuen Amazon DocumentDB-Cluster.

Anforderungsparameter

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

DBClusterIdentifier

Die Cluster-ID. Dieser Parameter wird als Zeichenfolge in Kleinbuchstaben gespeichert.

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-cluster

Typ: Zeichenfolge

Erforderlich: Ja

Engine

Der Name der Datenbank-Engine, die für diesen Cluster verwendet werden soll.

Zulässige Werte: docdb

Typ: Zeichenfolge

Erforderlich: Ja

AvailabilityZones. AvailabilityZoneN

Eine Liste der Amazon EC2 Availability Zones, in denen Instances im Cluster erstellt werden können.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

BackupRetentionPeriod

Die Anzahl von Tagen, über die hinweg automatische Sicherungen aufbewahrt werden. Sie müssen einen Mindestwert von 1 angeben.

Standard: 1

Einschränkungen:

  • Muss ein Wert zwischen 1 und 35 sein.

Typ: Ganzzahl

Erforderlich: Nein

DBClusterParameterGroupName

Der Name der Parameter-Gruppe, die mit diesem Cluster zu verknüpfen ist.

Typ: Zeichenfolge

Erforderlich: Nein

DBSubnetGroupName

Eine DB-Subnetzgruppe, die diesem DB-Cluster zugeordnet werden soll.

Einschränkungen: Der Wert muss mit dem Namen einer vorhandenen DBSubnetGroup übereinstimmen. Der Name darf nicht default sein.

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 werden müssen. Sie können Prüf- oder Profiler-Protokolle aktivieren. Weitere Informationen finden Sie unter Amazon DocumentDB DocumentDB-Ereignisse prüfen und Amazon DocumentDB DocumentDB-Operationen profilieren.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

EngineVersion

Die Versionsnummer der zu verwendenden Datenbank-Engine. Die --engine-version wird standardmäßig auf die neueste Hauptversion des Moduls festgelegt. Bei Produktions-Workloads empfehlen wir, diesen Parameter explizit mit der beabsichtigten Hauptversion zu deklarieren.

Typ: Zeichenfolge

Erforderlich: Nein

GlobalClusterIdentifier

Die Cluster-ID des neuen globalen Clusters.

Typ: Zeichenfolge

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

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Erforderlich: Nein

KmsKeyId

Die AWS KMS Schlüssel-ID für einen verschlüsselten Cluster.

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 Cluster erstellen AWS-Konto , dem der AWS KMS Verschlüsselungsschlüssel gehört, der zur Verschlüsselung des neuen Clusters verwendet wird, können Sie den AWS KMS Schlüsselalias anstelle des ARN für den AWS KMS Verschlüsselungsschlüssel verwenden.

Wenn ein Verschlüsselungsschlüssel in KmsKeyId nicht angegeben ist:

  • Wenn der StorageEncrypted-Parameter true lautet, verwendet Amazon DocumentDB Ihren Standard-Verschlüsselungsschlüssel.

AWS KMS erstellt den Standard-Verschlüsselungsschlüssel für Ihren AWS-Konto. Ihr AWS-Konto hat für jeden einen anderen Standard-Verschlüsselungsschlüssel AWS-Regionen.

Typ: Zeichenfolge

Erforderlich: Nein

ManageMasterUserPassword

Gibt an, ob das Masterbenutzerpasswort mit Amazon Web Services Secrets Manager verwaltet werden soll.

Einschränkung: Sie können das Masterbenutzer-Passwort nicht mit Amazon Web Services Secrets Manager verwalten, wenn MasterUserPassword es angegeben ist.

Typ: Boolesch

Erforderlich: Nein

MasterUsername

Der Name des Masterbenutzers für diesen DB-Cluster.

Einschränkungen:

  • Muss zwischen 1 und 63 Buchstaben oder Zahlen enthalten.

  • Das erste Zeichen muss ein Buchstabe sein.

  • Darf kein Wort sein, das für die ausgewählte Datenbank-Engine reserviert ist.

Typ: Zeichenfolge

Erforderlich: Nein

MasterUserPassword

Das Passwort für den Masterbenutzer der Datenbank. Dieses Passwort kann jedes druckbare ASCII Zeichen außer dem Schrägstrich (/), doppelten Anführungszeichen („) oder dem „at“ -Symbol (@) enthalten.

Einschränkungen: Muss 8 bis 100 Zeichen enthalten.

Typ: Zeichenfolge

Erforderlich: Nein

MasterUserSecretKmsKeyId

Die Amazon Web KMS Services-Schlüssel-ID zur Verschlüsselung eines Geheimnisses, das automatisch im Amazon Web Services Secrets Manager generiert und verwaltet wird. Diese Einstellung ist nur gültig, wenn das Masterbenutzerkennwort von Amazon DocumentDB im Amazon Web Services Secrets Manager für den DB-Cluster verwaltet wird.

Die Amazon Web Services KMS Services-Schlüssel-ID ist der SchlüsselARN, die Schlüssel-ID, der Alias ARN oder der Aliasname für den KMS Schlüssel. Um einen KMS Schlüssel in einem anderen Amazon Web Services Services-Konto zu verwenden, geben Sie den Schlüssel ARN oder Alias anARN.

Wenn Sie nichts angebenMasterUserSecretKmsKeyId, wird der aws/secretsmanager KMS Schlüssel zur Verschlüsselung des Geheimnisses verwendet. Wenn sich das Geheimnis in einem anderen Amazon Web Services Services-Konto befindet, können Sie den aws/secretsmanager KMS Schlüssel nicht verwenden, um das Geheimnis zu verschlüsseln, und Sie müssen einen vom Kunden verwalteten KMS Schlüssel verwenden.

Es gibt einen KMS Standardschlüssel für Ihr Amazon Web Services Services-Konto. Ihr Amazon Web Services Services-Konto hat für jede Amazon Web Services Services-Region einen anderen KMS Standardschlüssel.

Typ: Zeichenfolge

Erforderlich: Nein

Port

Die Portnummer, auf der die Instances im Cluster Verbindungen akzeptieren.

Typ: Ganzzahl

Erforderlich: Nein

PreferredBackupWindow

Der tägliche Zeitraum, in dem automatische Sicherungen erstellt werden, wenn diese mit dem Parameter BackupRetentionPeriod aktiviert sind.

Die Standardeinstellung ist ein 30-minütiges Fenster, das nach dem Zufallsprinzip aus einem Zeitblock von jeweils AWS-Region 8 Stunden ausgewählt wird.

Einschränkungen:

  • Muss im Format hh24:mi-hh24:mi angegeben werden.

  • Muss in der koordinierten Weltzeit (UTC) angegeben werden.

  • Darf nicht mit dem bevorzugten Wartungsfenster in Konflikt treten.

  • Muss mindestens 30 Minuten betragen.

Typ: Zeichenfolge

Erforderlich: Nein

PreferredMaintenanceWindow

Der wöchentliche Zeitraum, in dem Systemwartungen durchgeführt werden können, in koordinierter Weltzeit (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Die Standardeinstellung ist ein 30-minütiges Fenster, das nach dem Zufallsprinzip aus einem Zeitblock von jeweils AWS-Region 8 Stunden ausgewählt wird und an einem zufälligen Wochentag stattfindet.

Gültige Tage: Mo, Di, Mi, Do, Fr, Sa, So

Einschränkungen: mindestens 30-Minuten-Zeitfenster.

Typ: Zeichenfolge

Erforderlich: Nein

PreSignedUrl

Wird derzeit nicht unterstützt.

Typ: Zeichenfolge

Erforderlich: Nein

StorageEncrypted

Gibt an, ob der Cluster verschlüsselt ist.

Typ: Boolesch

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

Anmerkung

Wenn Sie einen DocumentDB-DB-Cluster mit dem Speichertyp auf erstelleniopt1, wird der Speichertyp in der Antwort zurückgegeben. Der Speichertyp wird nicht zurückgegeben, wenn Sie ihn auf standard setzen.

Typ: Zeichenfolge

Erforderlich: Nein

Stichworte.Tag.N

Die Tags, die dem Cluster zugewiesen werden sollen.

Typ: Array von Tag-Objekten

Erforderlich: Nein

VpcSecurityGroupIds. VpcSecurityGroupIdN

Eine Liste von EC2 VPC Sicherheitsgruppen, die diesem Cluster zugeordnet werden sollen.

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.

HTTPStatuscode: 400

DBClusterNotFoundFault

DBClusterIdentifierbezieht sich nicht auf einen vorhandenen Cluster.

HTTPStatuscode: 404

DBClusterParameterGroupNotFound

DBClusterParameterGroupNamebezieht sich nicht auf eine bestehende Cluster-Parametergruppe.

HTTPStatuscode: 404

DBClusterQuotaExceededFault

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

HTTPStatuscode: 403

DBInstanceNotFound

DBInstanceIdentifierbezieht sich nicht auf eine bestehende Instanz.

HTTPStatuscode: 404

DBSubnetGroupDoesNotCoverEnoughAZs

Subnetze in der Subnetzgruppe sollten mindestens zwei Availability Zones abdecken, es sei denn, es gibt nur eine Availability Zone.

HTTPStatuscode: 400

DBSubnetGroupNotFoundFault

DBSubnetGroupNamebezieht sich nicht auf eine bestehende Subnetzgruppe.

HTTPStatuscode: 404

GlobalClusterNotFoundFault

Das bezieht sich GlobalClusterIdentifier nicht auf einen vorhandenen globalen Cluster.

HTTPStatuscode: 404

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.

HTTPStatuscode: 400

InvalidDBClusterStateFault

Der Cluster befindet sich nicht in einem gültigen Zustand.

HTTPStatuscode: 400

InvalidDBInstanceState

Die angegebene Instanz befindet sich nicht im Status „Verfügbar“.

HTTPStatuscode: 400

InvalidDBSubnetGroupStateFault

Die Subnetzgruppe kann nicht gelöscht werden, da sie verwendet wird.

HTTPStatuscode: 400

InvalidGlobalClusterStateFault

Der angeforderte Vorgang kann nicht ausgeführt werden, solange sich der Cluster in diesem Zustand befindet.

HTTPStatuscode: 400

InvalidSubnet

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

HTTPStatuscode: 400

InvalidVPCNetworkStateFault

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

HTTPStatuscode: 400

KMSKeyNotAccessibleFault

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

HTTPStatuscode: 400

StorageQuotaExceeded

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

HTTPStatuscode: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: