ModifyDBInstance

Ändert die Einstellungen für eine Instanz. 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.

DBInstanceIdentifier

Die Instance-ID. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.

Einschränkungen:

• Muss mit der Kennung eines vorhandenen DBInstance übereinstimmen.

Typ: Zeichenfolge

Erforderlich: Ja

ApplyImmediately

Gibt an, ob die Änderungen in dieser Anforderung und alle ausstehenden Änderungen unabhängig von der PreferredMaintenanceWindow Einstellung für die Instanz so schnell wie möglich asynchron angewendet werden.

Wenn dieser Parameter auf gesetzt istfalse, werden Änderungen an der Instanz im nächsten Wartungsfenster übernommen. Einige Parameteränderungen können zu einem Ausfall führen und werden beim nächsten Neustart übernommen.

Standard: false

Typ: Boolesch

Erforderlich: Nein

AutoMinorVersionUpgrade

Dieser Parameter gilt nicht für Amazon DocumentDB. Amazon DocumentDB führt unabhängig vom eingestellten Wert keine kleineren Versions-Upgrades durch.

Typ: Boolesch

Erforderlich: Nein

CACertificateIdentifier

Gibt das Zertifikat an, das mit der Instance verknüpft werden muss.

Typ: Zeichenfolge

Erforderlich: Nein

CertificateRotationRestart

Gibt an, ob die DB-Instance neu gestartet wird, wenn Sie Ihr SSL/TLS-Zertifikat rotieren.

Standardmäßig wird die DB-Instance neu gestartet, wenn Sie Ihr SSL/TLS-Zertifikat rotieren. Das Zertifikat wird erst aktualisiert, wenn die DB-Instance neu gestartet wird.

Wichtig

Legen Sie diesen Parameter nur fest, wenn Sie SSL/TLS nicht verwenden, um eine Verbindung zur DB-Instance herzustellen.

Wenn Sie SSL/TLS verwenden, um eine Verbindung zur DB-Instance herzustellen, finden Sie weitere Informationen unter Aktualisieren Ihrer Amazon DocumentDB-TLS-Zertifikate und Verschlüsseln von Daten bei der Übertragung im Amazon DocumentDB-Entwicklerhandbuch.

Typ: Boolesch

Erforderlich: Nein

CopyTagsToSnapshot

Ein Wert, der angibt, ob alle Tags aus der DB-Instance in Snapshots der DB-Instance kopiert werden sollen. Standardmäßig werden Tags nicht kopiert.

Typ: Boolesch

Erforderlich: Nein

DBInstanceClass

Die neue Rechen- und Speicherkapazität der Instance; zum Beispieldb.r5.large. Nicht alle Instanzklassen sind in allen verfügbar AWS-Regionen.

Wenn Sie die Instanzklasse ändern, kommt es während der Änderung zu einem Ausfall. Die Änderung wird während des nächsten Wartungsfensters angewendet, es sei denn, ApplyImmediately wird für diese Anforderung als true angegeben.

Standard: Verwendet die vorhandene Einstellung.

Typ: Zeichenfolge

Erforderlich: Nein

EnablePerformanceInsights

Ein Wert, der angibt, ob Performance Insights für die DB-Instance aktiviert werden sollen. Weitere Informationen finden Sie unter Verwenden von Amazon Performance Insights.

Typ: Boolesch

Erforderlich: Nein

NewDBInstanceIdentifier

Die neue Instanz-ID für die Instanz beim Umbenennen einer Instanz. Wenn Sie die Instanz-ID ändern, erfolgt sofort ein Instanzneustart, wenn Sie dies Apply Immediately auf true einstellen. Er erfolgt während des nächsten Wartungsfensters, wenn Sie Apply Immediately auf eingestellt habenfalse. 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: mydbinstance

Typ: Zeichenfolge

Erforderlich: Nein

PerformanceInsightsKMSKeyId

Die AWS KMS Schlüssel-ID für die Verschlüsselung von Performance Insights Insights-Daten.

Die AWS KMS Schlüssel-ID ist der Schlüssel-ARN, die Schlüssel-ID, der Alias-ARN oder der Aliasname für den KMS-Schlüssel.

Wenn Sie keinen Wert für PerformanceInsights KMS angebenKeyId, verwendet Amazon DocumentDB Ihren Standard-KMS-Schlüssel. Es gibt einen Standard-KMS-Schlü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 Standard-KMS-Schlüssel.

Typ: Zeichenfolge

Erforderlich: Nein

PreferredMaintenanceWindow

Der wöchentliche Zeitraum (in UTC), in dem Systemwartungen durchgeführt werden können, die möglicherweise zu einem Nutzungsausfall führen. Eine Änderung dieses Parameters führt nicht zu einem Ausfall, außer in der folgenden Situation, und die Änderung wird so schnell wie möglich asynchron angewendet. Wenn ausstehende Aktionen vorhanden sind, die einen Neustart verursachen, und das Wartungsfenster so geändert wird, dass es die aktuelle Uhrzeit enthält, führt eine Änderung dieses Parameters zu einem Neustart der Instanz. Wenn Sie dieses Fenster auf die aktuelle Uhrzeit verschieben, müssen zwischen der aktuellen Uhrzeit und dem Ende des Fensters mindestens 30 Minuten liegen, um sicherzustellen, dass ausstehende Änderungen übernommen werden.

Standard: Verwendet die vorhandene Einstellung.

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

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

Einschränkungen: Muss mindestens 30 Minuten dauern.

Typ: Zeichenfolge

Erforderlich: Nein

PromotionTier

Ein Wert, der die Reihenfolge angibt, in der ein Amazon DocumentDB DocumentDB-Replikat nach einem Ausfall der vorhandenen primären Instance zur primären Instance heraufgestuft wird.

Standard: 1

Gültige Werte: 0-15

Typ: Ganzzahl

Erforderlich: Nein

Antwortelemente

Das folgende Element wird vom Dienst zurückgegeben.

DBInstance

Detaillierte Informationen zu einer Instanz.

Typ: DBInstance Objekt

Fehler

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

AuthorizationNotFound

Die angegebene CIDR-IP oder Amazon EC2-Sicherheitsgruppe ist für die angegebene Sicherheitsgruppe nicht autorisiert.

Amazon DocumentDB ist möglicherweise auch nicht autorisiert, die erforderlichen Aktionen in Ihrem Namen mithilfe von IAM durchzuführen.

HTTP Status Code: 404

CertificateNotFound

CertificateIdentifierbezieht sich nicht auf ein vorhandenes Zertifikat.

HTTP Status Code: 404

DBInstanceAlreadyExists

Sie haben bereits eine Instanz mit der angegebenen ID.

HTTP Status Code: 400

DBInstanceNotFound

DBInstanceIdentifierbezieht sich nicht auf eine bestehende Instanz.

HTTP Status Code: 404

DBParameterGroupNotFound

DBParameterGroupNamebezieht sich nicht auf eine bestehende Parametergruppe.

HTTP Status Code: 404

DBSecurityGroupNotFound

DBSecurityGroupNamebezieht sich nicht auf eine bestehende Sicherheitsgruppe.

HTTP Status Code: 404

DBUpgradeDependencyFailure

Das Upgrade ist fehlgeschlagen, weil eine Ressource, von der der abhängt, nicht geändert werden kann.

HTTP Status Code: 400

InsufficientDBInstanceCapacity

Die angegebene Instanzklasse ist in der angegebenen Availability Zone nicht verfügbar.

HTTP Status Code: 400

InvalidDBInstanceState

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

HTTP Status Code: 400

InvalidDBSecurityGroupState

Der Status der Sicherheitsgruppe erlaubt kein Löschen.

HTTP Status Code: 400

InvalidVPCNetworkStateFault

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

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 Instances verfügbar ist.

HTTP Status Code: 400

StorageTypeNotSupported

Der angegebene Speicher StorageType kann der DB-Instance nicht zugeordnet werden.

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:

• AWS -Befehlszeilenschnittstelle

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK für JavaScript V3

• AWS SDK for PHP V3

• AWS SDK für Python

• AWS SDK for Ruby V3