ModifyDBCluster - Amazon DocumentDB
Paramètres de demandeÉléments de réponseErreursconsultez aussi

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.

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 : String

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 de base de données.

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 surfalse, 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 surfalse, 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.

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 : entier

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

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é. DeletionProtectionprotè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écifierMasterUserPassword. 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écifierMasterUserPassword. 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 n'importe quel ASCII caractère imprimable à l'exception de la barre oblique (/), des guillemets («) ou du symbole « at » (@).

Contraintes : doit comporter entre 8 et 100 caractères.

Type : chaîne

Obligatoire : non

MasterUserSecretKmsKeyId

Identifiant KMS clé 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 KMS clé 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 pasMasterUserSecretKmsKeyId, la aws/secretsmanager KMS clé 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 aws/secretsmanager KMS clé pour le chiffrer et vous devez utiliser une KMS clé gérée par le client.

L'identifiant de KMS clé Amazon Web Services est la cléARN, l'identifiant de clé, l'alias ARN ou le nom d'alias de la KMS clé. Pour utiliser une KMS clé dans un autre compte Amazon Web Services, spécifiez la clé ARN ou l'aliasARN.

Il existe une KMS clé par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une KMS clé par défaut différente pour chaque région Amazon Web Services.

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 trait d'union ni contenir deux traits d'union 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 et65535.

Par défaut : le même port que le cluster d'origine.

Type : entier

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é en temps universel coordonné (UTC).

  • 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

La plage horaire hebdomadaire pendant laquelle la maintenance du système peut avoir lieu, en temps universel coordonné (UTC).

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

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

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

Erreurs

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

DBClusterAlreadyExistsFault

Vous avez déjà un cluster avec l'identifiant indiqué.

HTTPCode de statut : 400

DBClusterNotFoundFault

DBClusterIdentifierne fait pas référence à un cluster existant.

HTTPCode de statut : 404

DBClusterParameterGroupNotFound

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

HTTPCode de statut : 404

DBSubnetGroupNotFoundFault

DBSubnetGroupNamene fait pas référence à un groupe de sous-réseaux existant.

HTTPCode de statut : 404

InvalidDBClusterStateFault

Le cluster n'est pas dans un état valide.

HTTPCode de statut : 400

InvalidDBInstanceState

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

HTTPCode de statut : 400

InvalidDBSecurityGroupState

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

HTTPCode de statut : 400

InvalidDBSubnetGroupStateFault

Le groupe de sous-réseaux ne peut pas être supprimé car il est en cours d'utilisation.

HTTPCode de statut : 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 commun ()VPC.

HTTPCode de statut : 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.

HTTPCode de statut : 400

StorageQuotaExceeded

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

HTTPCode de statut : 400

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :