ModifyDBInstance

Modifie les paramètres d'une instance. Vous pouvez modifier un ou plusieurs paramètres de configuration de base de données en spécifiant ces paramètres et les nouvelles valeurs dans la demande.

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

DBInstanceIdentifier

Identifiant de l’instance. Cette valeur est stockée sous la forme d'une chaîne en minuscules.

Contraintes :

• Doit correspondre à l'identifiant d'un DBInstance existant.

Type : chaîne

Obligatoire : oui

ApplyImmediately

Spécifie si les modifications de cette demande et les modifications en attente sont appliquées de manière asynchrone dès que possible, quel que soit le PreferredMaintenanceWindow paramètre de l'instance.

Si ce paramètre est défini surfalse, les modifications apportées à l'instance sont appliquées lors de la fenêtre de maintenance suivante. Certaines modifications de paramètres peuvent provoquer une panne et sont appliquées lors du prochain redémarrage.

Par défaut : false

Type : booléen

Obligatoire : non

AutoMinorVersionUpgrade

Ce paramètre ne s'applique pas à Amazon DocumentDB. Amazon DocumentDB n'effectue pas de mises à niveau mineures de version, quelle que soit la valeur définie.

Type : booléen

Obligatoire : non

CACertificateIdentifier

Indique le certificat qui doit être associé à l'instance.

Type : chaîne

Obligatoire : non

CertificateRotationRestart

Spécifie si l'instance de base de données est redémarrée lorsque vous faites pivoter votre certificat SSL/TLS.

Par défaut, l'instance de base de données est redémarrée lorsque vous faites pivoter votre certificat SSL/TLS. Le certificat n'est pas mis à jour tant que l'instance de base de données n'est pas redémarrée.

Important

Définissez ce paramètre uniquement si vous n'utilisez pas le protocole SSL/TLS pour vous connecter à l'instance de base de données.

Si vous utilisez le protocole SSL/TLS pour vous connecter à l'instance de base de données, consultez la section Mise à jour de vos certificats Amazon DocumentDB TLS et chiffrement des données en transit dans le manuel Amazon DocumentDB Developer Guide.

Type : booléen

Obligatoire : non

CopyTagsToSnapshot

Une valeur qui indique s'il faut copier toutes les balises de l'instance de base de données vers des instantanés de l'instance de base de données. Par défaut, les balises ne sont pas copiées.

Type : booléen

Obligatoire : non

DBInstanceClass

La nouvelle capacité de calcul et de mémoire de l'instance ; par exemple,db.r5.large. Les classes d'instance ne sont pas toutes disponibles Régions AWS.

Si vous modifiez la classe d'instance, une panne se produit lors de la modification. La modification est appliquée pendant la fenêtre de maintenance suivante, sauf si ApplyImmediately a été spécifié true pour cette demande.

Par défaut : Utilise le paramètre existant.

Type : chaîne

Obligatoire : non

EnablePerformanceInsights

Une valeur qui indique s'il convient d'activer Performance Insights pour l'instance de base de données. Pour plus d'informations, voir Utilisation d'Amazon Performance Insights.

Type : booléen

Obligatoire : non

NewDBInstanceIdentifier

Le nouvel identifiant d'instance pour l'instance lorsque vous renommez une instance. Lorsque vous modifiez l'identifiant de l'instance, un redémarrage de l'instance a lieu immédiatement si vous le définissez Apply Immediately surtrue. Cela se produit lors de la fenêtre de maintenance suivante si vous définissez Apply Immediately surfalse. Cette valeur est stockée sous la forme d'une chaîne en minuscules.

Contraintes :

• Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.

• Le premier caractère doit être une lettre.

• Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs.

Exemple : mydbinstance

Type : chaîne

Obligatoire : non

PerformanceInsightsKMSKeyId

Identifiant AWS KMS clé pour le chiffrement des données Performance Insights.

L'identifiant de AWS KMS clé est l'ARN de la clé, l'ID de clé, l'alias ARN ou le nom d'alias de la clé KMS.

Si vous ne spécifiez aucune valeur pour PerformanceInsights KMSKeyId, Amazon DocumentDB utilise votre clé KMS par défaut. Il existe une clé KMS par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une clé KMS par défaut différente pour chaque région Amazon Web Services.

Type : chaîne

Obligatoire : non

PreferredMaintenanceWindow

Intervalle de temps hebdomadaire (au format UTC) pendant lequel se produit la maintenance du système qui peut entraîner une interruption. La modification de ce paramètre n'entraîne pas de panne, sauf dans le cas suivant, et la modification est appliquée de manière asynchrone dès que possible. Si des actions en attente entraînent un redémarrage et que la fenêtre de maintenance est modifiée pour inclure l'heure actuelle, la modification de ce paramètre entraîne le redémarrage de l'instance. Si vous déplacez cette fenêtre vers l'heure actuelle, il doit s'écouler au moins 30 minutes entre l'heure actuelle et la fin de la fenêtre pour garantir que les modifications en attente sont appliquées.

Par défaut : Utilise le paramètre existant.

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

Jours valides : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Contraintes : Doit durer au moins 30 minutes.

Type : chaîne

Obligatoire : non

PromotionTier

Valeur qui indique l'ordre dans lequel une réplique Amazon DocumentDB est promue vers l'instance principale après une défaillance de l'instance principale existante.

Valeur par défaut : 1

Valeurs valides : 0 à 15

Type : entier

Obligatoire : non

Éléments de réponse

L'élément suivant est renvoyé par le service.

DBInstance

Informations détaillées sur une instance.

Type : objet DBInstance

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AuthorizationNotFound

L'adresse IP CIDR ou le groupe de sécurité Amazon EC2 spécifié n'est pas autorisé pour le groupe de sécurité spécifié.

Amazon DocumentDB peut également ne pas être autorisé à effectuer les actions nécessaires en votre nom à l'aide d'IAM.

Code d’état HTTP : 404

CertificateNotFound

CertificateIdentifierne fait pas référence à un certificat existant.

Code d’état HTTP : 404

DBInstanceAlreadyExists

Vous avez déjà une instance avec l'identifiant indiqué.

Code d’état HTTP : 400

DBInstanceNotFound

DBInstanceIdentifierne fait pas référence à une instance existante.

Code d’état HTTP : 404

DBParameterGroupNotFound

DBParameterGroupNamene fait pas référence à un groupe de paramètres existant.

Code d’état HTTP : 404

DBSecurityGroupNotFound

DBSecurityGroupNamene fait pas référence à un groupe de sécurité existant.

Code d’état HTTP : 404

DBUpgradeDependencyFailure

La mise à niveau a échoué car une ressource dont dépend ne peut pas être modifiée.

Code d’état HTTP : 400

InsufficientDBInstanceCapacity

La classe d'instance spécifiée n'est pas disponible dans la zone de disponibilité spécifiée.

Code d’état HTTP : 400

InvalidDBInstanceState

L'instance spécifiée n'est pas dans l'état disponible.

Code d’état HTTP : 400

InvalidDBSecurityGroupState

L'état du groupe de sécurité n'autorise pas la suppression.

Code d’état HTTP : 400

InvalidVPCNetworkStateFault

Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.

Code d’état HTTP : 400

StorageQuotaExceeded

La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.

Code d’état HTTP : 400

StorageTypeNotSupported

Le stockage du paramètre spécifié ne StorageType peut pas être associé à l'instance de base de données.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :

• Interface de ligne de commande AWS

• AWS SDK pour .NET

• AWS SDK pour C++

• AWS SDK pour Go v2

• AWS SDK pour Java V2

• AWS SDK pour V3 JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• AWS SDK pour Ruby V3