ModifyDBCluster - Amazon DocumentDB

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.

ModifyDBCluster

Ändert eine Einstellung für einen Amazon DocumentDB-Cluster. Sie können einen oder mehrere Datenbank-Konfigurationsparameter ändern, indem Sie diese Parameter und die neuen Werte in der Anforderung angeben.

Anforderungsparameter

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

DBClusterIdentifier

Die Cluster-ID für den Cluster, der geändert wird. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Einschränkungen:

  • Muss mit der Kennung eines vorhandenen DBCluster übereinstimmen.

Typ: Zeichenfolge

Erforderlich: Ja

AllowMajorVersionUpgrade

Ein Wert, der angibt, ob Major-Versionsupgrades erlaubt sind.

Einschränkungen: Sie müssen größere Versionsupgrades zulassen, wenn Sie einen Wert für den EngineVersion Parameter angeben, der eine andere Hauptversion als die aktuelle Version des DB-Clusters ist.

Typ: Boolesch

Erforderlich: Nein

ApplyImmediately

Ein Wert, der angibt, ob die Änderungen in dieser Anforderung und alle ausstehenden Änderungen unabhängig von der PreferredMaintenanceWindow Einstellung für den Cluster so schnell wie möglich asynchron angewendet werden. Wenn dieser Parameter auf gesetzt istfalse, werden Änderungen am Cluster im nächsten Wartungsfenster übernommen.

Der ApplyImmediately Parameter wirkt sich nur auf die MasterUserPassword Werte NewDBClusterIdentifier und aus. Wenn Sie diesen Parameterwert auf setzenfalse, werden die Änderungen an den MasterUserPassword Werten NewDBClusterIdentifier und im nächsten Wartungsfenster übernommen. Alle anderen Änderungen werden sofort übernommen, unabhängig von dem Wert des Parameters ApplyImmediately.

Standard: false

Typ: Boolesch

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

CloudwatchLogsExportConfiguration

Die Konfigurationseinstellung für die Protokolltypen, die für den Export nach Amazon CloudWatch Logs für eine bestimmte Instance oder einen bestimmten Cluster aktiviert werden sollen. Die DisableLogTypes Arrays EnableLogTypes und bestimmen, welche Protokolle in Logs exportiert (oder nicht exportiert) werden CloudWatch .

Typ: CloudwatchLogsExportConfiguration Objekt

Erforderlich: Nein

DBClusterParameterGroupName

Der Name der Cluster-Parametergruppe, die für den Cluster verwendet werden soll.

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

EngineVersion

Die Versionsnummer der Datenbank-Engine, auf die ein Upgrade durchgeführt werden soll. Das Ändern dieses Parameters führt zu einem Nutzungsausfall. Die Änderung wird im nächsten Wartungsfenster übernommen, es sei denn, ApplyImmediately ist aktiviert.

Verwenden Sie den folgenden Befehl, um alle verfügbaren Engine-Versionen für Amazon DocumentDB aufzulisten:

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

Typ: Zeichenfolge

Erforderlich: Nein

ManageMasterUserPassword

Gibt an, ob das Masterbenutzerpasswort mit Amazon Web Services Secrets Manager verwaltet werden soll. Wenn der Cluster das Masterbenutzerkennwort nicht mit Amazon Web Services Secrets Manager verwaltet, können Sie diese Verwaltung aktivieren. In diesem Fall können Sie nichts angebenMasterUserPassword. Wenn der Cluster das Masterbenutzer-Passwort bereits mit Amazon Web Services Secrets Manager verwaltet und Sie angeben, dass das Master-Benutzerpasswort nicht mit Amazon Web Services Secrets Manager verwaltet wird, müssen Sie angebenMasterUserPassword. In diesem Fall löscht Amazon DocumentDB das Geheimnis und verwendet das neue Passwort für den Masterbenutzer, das von angegeben wurde. MasterUserPassword

Typ: Boolesch

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 die beiden folgenden Bedingungen erfüllt sind:

  • Der Cluster verwaltet das Masterbenutzer-Passwort in Amazon Web Services Secrets Manager nicht. Wenn der Cluster das Masterbenutzer-Passwort bereits in Amazon Web Services Secrets Manager verwaltet, können Sie den KMS Schlüssel, der zur Verschlüsselung des Secrets verwendet wird, nicht ändern.

  • Sie aktivieren ManageMasterUserPassword die Verwaltung des Masterbenutzer-Passworts in Amazon Web Services Secrets Manager. Wenn Sie das Gerät einschalten ManageMasterUserPassword und 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.

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.

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

NewDBClusterIdentifier

Die neue Cluster-ID für den Cluster beim Umbenennen eines Clusters. Dieser Wert 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-cluster2

Typ: Zeichenfolge

Erforderlich: Nein

Port

Die Nummer des Ports, an dem der Cluster Verbindungen akzeptiert.

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

Standard: Derselbe Port wie der ursprüngliche Cluster.

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

RotateMasterUserPassword

Gibt an, ob das von Amazon Web Services Secrets Manager verwaltete Geheimnis für das Masterbenutzerkennwort rotiert werden soll.

Diese Einstellung ist nur gültig, wenn das Masterbenutzerkennwort von Amazon DocumentDB im Amazon Web Services Secrets Manager für den Cluster verwaltet wird. Der geheime Wert enthält das aktualisierte Passwort.

Einschränkung: Sie müssen die Änderung sofort anwenden, wenn Sie das Masterbenutzerkennwort ändern.

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

Typ: Zeichenfolge

Erforderlich: Nein

VpcSecurityGroupIds. VpcSecurityGroupIdN

Eine Liste der Virtual Private Cloud (VPC) -Sicherheitsgruppen, zu denen der 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.

HTTPStatuscode: 400

DBClusterNotFoundFault

DBClusterIdentifierbezieht sich nicht auf einen vorhandenen Cluster.

HTTPStatuscode: 404

DBClusterParameterGroupNotFound

DBClusterParameterGroupNamebezieht sich nicht auf eine bestehende Cluster-Parametergruppe.

HTTPStatuscode: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupNamebezieht sich nicht auf eine bestehende Subnetzgruppe.

HTTPStatuscode: 404

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

InvalidDBSecurityGroupState

Der Status der Sicherheitsgruppe lässt kein Löschen zu.

HTTPStatuscode: 400

InvalidDBSubnetGroupStateFault

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

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

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: