Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# ModifyDBCluster
Modifie un paramètre pour un cluster Amazon DocumentDB. 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](CommonParameters.md).
** DBClusterIdentifier **
Identifiant du cluster en cours de modification. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Type : Chaîne
Obligatoire : oui
** AllowMajorVersionUpgrade **
Une valeur qui indique que les mises à niveau de version majeures sont autorisées.
Contraintes:
+ Vous devez autoriser les mises à niveau des versions majeures lorsque vous spécifiez une valeur pour le `EngineVersion` paramètre qui est une version majeure différente de la version actuelle du cluster.
+ Certains paramètres étant spécifiques à la version, leur modification nécessite l'exécution d'un nouvel appel d'`ModifyDBCluster`API une fois le MVU en place terminé.
L'exécution d'un MVU a un impact direct sur les paramètres suivants :
+ `MasterUserPassword`
+ `NewDBClusterIdentifier`
+ `VpcSecurityGroupIds`
+ `Port`
Type : booléen
Obligatoire : non
** ApplyImmediately **
Valeur qui indique si les modifications apportées à cette demande et aux modifications en attente sont appliquées de manière asynchrone dès que possible, quel que soit le `PreferredMaintenanceWindow` paramètre du cluster. Si ce paramètre est défini sur`false`, les modifications apportées au cluster sont appliquées lors de la fenêtre de maintenance suivante.
Le `ApplyImmediately` paramètre affecte uniquement les `MasterUserPassword` valeurs `NewDBClusterIdentifier` et. Si vous définissez la valeur de ce paramètre sur`false`, les modifications apportées aux `MasterUserPassword` valeurs `NewDBClusterIdentifier` et sont appliquées lors de la fenêtre de maintenance suivante. Toutes les autres modifications sont appliquées immédiatement, quelle que soit la valeur du paramètre `ApplyImmediately`.
Valeur par défaut : `false`
Type : booléen
Obligatoire : non
** BackupRetentionPeriod **
Nombre de jours de conservation des sauvegardes automatiques. Vous devez spécifier une valeur minimale de 1.
Par défaut : 1
Contraintes:
+ Doit être une valeur comprise entre 1 et 35.
Type : Integer
Obligatoire : non
** CloudwatchLogsExportConfiguration **
Le paramètre de configuration des types de journaux à activer pour l'exportation vers Amazon CloudWatch Logs pour une instance ou un cluster spécifique. Les `DisableLogTypes` tableaux `EnableLogTypes` et déterminent quels journaux sont exportés (ou non exportés) vers CloudWatch Logs.
Type : objet [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md)
Obligatoire : non
** DBClusterParameterGroupName **
Le nom du groupe de paramètres de cluster à utiliser pour le cluster.
Type : chaîne
Obligatoire : non
** DeletionProtection **
Spécifie si ce cluster peut être supprimé. Si cette option `DeletionProtection` est activée, le cluster ne peut pas être supprimé sauf s'il `DeletionProtection` est modifié et désactivé. `DeletionProtection`protège les clusters contre la suppression accidentelle.
Type : booléen
Obligatoire : non
** EngineVersion **
Numéro de version du moteur de base de données vers lequel vous souhaitez effectuer la mise à niveau. La modification de ce paramètre entraîne une interruption. La modification sera appliquée pendant la fenêtre de maintenance suivante, sauf si `ApplyImmediately` est activé.
Pour répertorier toutes les versions de moteur disponibles pour Amazon DocumentDB, utilisez la commande suivante :
`aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"`
Type : chaîne
Obligatoire : non
** ManageMasterUserPassword **
Spécifie s'il faut gérer le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager. Si le cluster ne gère pas le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager, vous pouvez activer cette gestion. Dans ce cas, vous ne pouvez pas le spécifier`MasterUserPassword`. Si le cluster gère déjà le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager et que vous spécifiez que le mot de passe de l'utilisateur principal n'est pas géré avec Amazon Web Services Secrets Manager, vous devez le spécifier`MasterUserPassword`. Dans ce cas, Amazon DocumentDB supprime le secret et utilise le nouveau mot de passe de l'utilisateur principal spécifié par. `MasterUserPassword`
Type : booléen
Obligatoire : non
** MasterUserPassword **
Mot de passe de l'utilisateur principal de la base de données. Ce mot de passe peut contenir tout caractère ASCII imprimable à l'exception de la barre oblique (/), des guillemets doubles (") ou du symbole arobase (@).
Contraintes : doit comporter entre 8 et 100 caractères.
Type : chaîne
Obligatoire : non
** MasterUserSecretKmsKeyId **
L'identifiant de clé KMS d'Amazon Web Services permettant de chiffrer un secret généré et géré automatiquement dans Amazon Web Services Secrets Manager.
Ce paramètre n'est valide que si les deux conditions suivantes sont remplies :
+ Le cluster ne gère pas le mot de passe de l'utilisateur principal dans Amazon Web Services Secrets Manager. Si le cluster gère déjà le mot de passe de l'utilisateur principal dans Amazon Web Services Secrets Manager, vous ne pouvez pas modifier la clé KMS utilisée pour chiffrer le secret.
+ Vous êtes en train `ManageMasterUserPassword` d'activer la gestion du mot de passe de l'utilisateur principal dans Amazon Web Services Secrets Manager. Si vous l'activez `ManageMasterUserPassword` et que vous ne le spécifiez pas`MasterUserSecretKmsKeyId`, la clé `aws/secretsmanager` KMS est utilisée pour chiffrer le secret. Si le secret se trouve dans un autre compte Amazon Web Services, vous ne pouvez pas utiliser la clé `aws/secretsmanager` KMS pour le chiffrer et vous devez utiliser une clé KMS gérée par le client.
L'identifiant de clé KMS d'Amazon Web Services est l'ARN de la clé, l'identifiant de clé, l'alias ARN ou le nom d'alias de la clé KMS. Pour utiliser une clé KMS dans un autre compte Amazon Web Services, spécifiez l'ARN de la clé ou l'alias ARN.
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
** NetworkType **
Type de réseau du cluster.
Le type de réseau est déterminé par le type `DBSubnetGroup` spécifié pour le cluster. A ne `DBSubnetGroup` peut prendre en charge que le IPv4 protocole ou les IPv6 protocoles IPv4 et (`DUAL`).
Pour plus d'informations, consultez la section [Clusters DocumentDB dans un VPC dans le](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) manuel Amazon DocumentDB Developer Guide.
Valeurs valides : `IPV4` \$1 `DUAL`
Type : chaîne
Obligatoire : non
** NewDBClusterIdentifier **
Le nouvel identificateur de cluster pour le cluster lors du changement de nom d'un cluster. 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 tiret ou contenir deux tirets consécutifs.
Exemple : `my-cluster2`
Type : chaîne
Obligatoire : non
** Port **
Numéro de port au niveau duquel le cluster accepte des connexions.
Contraintes : il doit s'agir d'une valeur comprise entre `1150` et`65535`.
Par défaut : le même port que le cluster d'origine.
Type : Integer
Obligatoire : non
** PreferredBackupWindow **
Plage de temps quotidienne au cours de laquelle les sauvegardes automatiques sont créées si cette fonctionnalité est activée via le paramètre `BackupRetentionPeriod`.
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'entre elles. Région AWS
Contraintes:
+ Doit être au format `hh24:mi-hh24:mi`.
+ Doit être exprimée en heure UTC (Universal Coordinated Time).
+ Ne doit pas être en conflit avec la fenêtre de maintenance préférée.
+ Doit être de 30 minutes minimum.
Type : chaîne
Obligatoire : non
** PreferredMaintenanceWindow **
Intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
Format : `ddd:hh24:mi-ddd:hh24:mi`
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'entre elles Région AWS, survenant un jour aléatoire de la semaine.
Jours valides : Mon, Tue, Wed, Thu, Fri, Sat, Sun
Contraintes : fenêtre minimale de 30 minutes.
Type : chaîne
Obligatoire : non
** RotateMasterUserPassword **
Spécifie s'il faut remplacer le secret géré par Amazon Web Services Secrets Manager par le mot de passe de l'utilisateur principal.
Ce paramètre n'est valide que si le mot de passe de l'utilisateur principal est géré par Amazon DocumentDB dans Amazon Web Services Secrets Manager pour le cluster. La valeur secrète contient le mot de passe mis à jour.
Contrainte : vous devez appliquer la modification immédiatement lors de la rotation du mot de passe de l'utilisateur principal.
Type : booléen
Obligatoire : non
** ServerlessV2ScalingConfiguration **
Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.
Type : objet [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)
Obligatoire : non
** StorageType **
Type de stockage à associer au cluster de base de données.
Pour plus d'informations sur les types de stockage pour les clusters Amazon DocumentDB, consultez la section Configurations de stockage des clusters dans le manuel *Amazon DocumentDB Developer Guide*.
Valeurs valides pour le type de stockage - `standard | iopt1`
La valeur par défaut est `standard `
Type : chaîne
Obligatoire : non
**VpcSecurityGroupIds. VpcSecurityGroupId**N.
Liste des groupes de sécurité du cloud privé virtuel (VPC) auxquels le cluster appartiendra.
Type : tableau de chaînes
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBCluster **
Informations détaillées sur un cluster.
Type : objet [DBCluster](API_DBCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Vous avez déjà un cluster avec l'identifiant indiqué.
Code d’état HTTP : 400
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBClusterParameterGroupNotFound **
`DBClusterParameterGroupName`ne fait pas référence à un groupe de paramètres de cluster existant.
Code d’état HTTP :404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
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
** InvalidDBSubnetGroupStateFault **
Le groupe de sous-réseaux ne peut pas être supprimé car il est en cours d'utilisation.
Code d’état HTTP : 400
** InvalidSubnet **
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.
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
** NetworkTypeNotSupported **
Le type de réseau n'est pris en charge ni par `DBSubnetGroup` ni par la version du moteur de base de donné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
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster)