Modification des groupes de paramètres du cluster Amazon DocumentDB

Cette section explique comment modifier un groupe de paramètres Amazon DocumentDB personnalisé. Dans Amazon DocumentDB, vous ne pouvez pas modifier un groupe de paramètres de default cluster créé lorsque vous créez pour la première fois un cluster avec une nouvelle version du moteur dans une nouvelle région. Si votre cluster Amazon DocumentDB utilise le groupe de paramètres de cluster par défaut et que vous souhaitez y modifier une valeur, vous devez d'abord créer un nouveau groupe de paramètres ou copier un groupe de paramètres existant, le modifier, puis appliquer le groupe de paramètres modifié à votre cluster.

Procédez comme suit pour modifier un groupe de paramètres de cluster personnalisé. La propagation des actions de modification peut prendre un certain temps. Attendez que le groupe de paramètres de cluster modifié soit disponible avant de l'associer à votre cluster. Vous pouvez utiliser l'AWS Management Console ou l'opération describe-db-cluster-parameters de l'AWS CLI pour vérifier que votre groupe de paramètres de cluster a été modifié. Pour plus d'informations, consultez Décrire les groupes de paramètres de cluster.

Using the AWS Management Console

Suivez ces étapes pour modifier un groupe de paramètres Amazon DocumentDB personnalisé. Vous ne pouvez pas modifier un groupe de paramètres default. Si vous souhaitez modifier une valeur dans le groupe de paramètres default, vous pouvez copier le groupe de paramètres de cluster par défaut, le modifier, puis l'appliquer à votre cluster. Pour de plus amples informations sur l'application de groupes de paramètres à votre cluster, veuillez consulter Modification d'un cluster Amazon DocumentDB.

Pour modifier un groupe de paramètres de cluster personnalisé

1. Connectez-vous à la AWS Management Console console Amazon DocumentDB et ouvrez-la à l'adresse https://console.aws.amazon.com/docdb.

2. Dans le panneau de navigation sur le côté gauche de la console, choisissez Groupes de paramètres. Dans la liste des groupes de paramètres, sélectionnez le nom du groupe de paramètres que vous souhaitez modifier.

   Astuce

   Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu () dans le coin supérieur gauche de la page.

3. Pour chaque paramètre dans le groupe de paramètres que vous souhaitez modifier, procédez comme suit :

   1. Recherchez le paramètre que vous souhaitez modifier et vérifiez qu'il est modifiable : true doit être indiqué dans la colonne Modifiable .

   2. S'il est modifiable, sélectionnez le paramètre et choisissez Modifier dans l'angle supérieur droit de la page de la console.

   3. Dans la boîte <parameter-name> de dialogue Modifier, apportez les modifications souhaitées. Choisissez ensuite Modify cluster parameter (Modifier le paramètre de cluster), ou Annuler pour annuler les modifications.

Using the AWS CLI

Vous pouvez modifier le ParameterValue ou ApplyMethod de n'importe quel paramètre modifiable dans un groupe de paramètres de cluster Amazon DocumentDB personnalisé à l'aide du. Description AWS CLI Vous ne pouvez pas apporter de modifications directement à un groupe de paramètres de cluster par défaut.

Pour modifier les paramètres d'un groupe de paramètres de cluster personnalisé, utilisez l'opération modify-db-cluster-parameter-group avec les paramètres suivants.

• --db-cluster-parameter-group-name — Obligatoire. Nom du groupe de paramètres de cluster que vous voulez modifier.

• --parameters — Obligatoire. Paramètres que vous modifiez. Pour obtenir la liste des paramètres qui s'appliquent à toutes les instances d'un cluster Amazon DocumentDB, consultez le. Référence des paramètres du cluster Amazon DocumentDB Chaque saisie de paramètre doit inclure ce qui suit :

  • ParameterName— Le nom du paramètre que vous êtes en train de modifier.

  • ParameterValue— La nouvelle valeur de ce paramètre.

  • ApplyMethod— La manière dont vous souhaitez que les modifications soient appliquées à ce paramètre. Les valeurs autorisées sont immediate et pending-reboot.

    Note

    Les paramètres avec le ApplyType de static doivent avoir une ApplyMethod de pending-reboot.

Exemple - Modification de la valeur d'un paramètre

Dans cet exemple, vous répertoriez les valeurs du paramètre du sample-parameter-group et modifiez le paramètre tls. Ensuite, après 5 minutes, vous répertoriez à nouveau les valeurs du sample-parameter-group pour voir les valeurs du paramètre modifiées.

1. Répertoriez les paramètres et leurs valeurs de sample-parameter-group.

   Pour Linux, macOS ou Unix :

   aws docdb describe-db-cluster-parameters \
          --db-cluster-parameter-group-name sample-parameter-group

   Pour Windows :

   aws docdb describe-db-cluster-parameters ^
          --db-cluster-parameter-group-name sample-parameter-group

   La sortie de cette opération ressemble à ceci (format JSON).

   {
          "Parameters": [
              {
                  "Source": "system",
                  "ApplyType": "static",
                  "AllowedValues": "disabled,enabled",
                  "ParameterValue": "enabled",
                  "ApplyMethod": "pending-reboot",
                  "DataType": "string",
                  "ParameterName": "tls",
                  "IsModifiable": true,
                  "Description": "Config to enable/disable TLS"
              },
              {
                  "Source": "user",
                  "ApplyType": "dynamic",
                  "AllowedValues": "disabled,enabled",
                  "ParameterValue": "enabled",
                  "ApplyMethod": "pending-reboot",
                  "DataType": "string",
                  "ParameterName": "ttl_monitor",
                  "IsModifiable": true,
                  "Description": "Enables TTL Monitoring"
              }
          ]
   }

2. Modifiez le paramètre tls afin que sa valeur soit disabled.

   Vous ne pouvez pas modifier la ApplyMethod car le ApplyType est static.

   Pour Linux, macOS ou Unix :

   aws docdb modify-db-cluster-parameter-group \
          --db-cluster-parameter-group-name sample-parameter-group \
          --parameters "ParameterName"=tls,"ParameterValue"=disabled,"ApplyMethod"=pending-reboot

   Pour Windows :

   aws docdb modify-db-cluster-parameter-group ^
          --db-cluster-parameter-group-name sample-parameter-group ^
          --parameters "ParameterName"=tls,"ParameterValue"=disabled,"ApplyMethod"=pending-reboot

   La sortie de cette opération ressemble à ceci (format JSON).

   {
          "DBClusterParameterGroupName": "sample-parameter-group"
      }

3. Patientez au moins 5 minutes.

4. Répertoriez les valeurs des paramètres de sample-parameter-group pour vérifier que le paramètre tls a été modifié.

   Pour Linux, macOS ou Unix :

   aws docdb describe-db-cluster-parameters \
          --db-cluster-parameter-group-name sample-parameter-group

   Pour Windows :

   aws docdb describe-db-cluster-parameters ^
          --db-cluster-parameter-group-name sample-parameter-group

   La sortie de cette opération ressemble à ceci (format JSON).

   {
          "Parameters": [
              {
                  "ParameterValue": "false",
                  "ParameterName": "enable_audit_logs",
                  "ApplyType": "dynamic",
                  "DataType": "string",
                  "Description": "Enables auditing on cluster.",
                  "AllowedValues": "true,false",
                  "Source": "system",
                  "IsModifiable": true,
                  "ApplyMethod": "pending-reboot"
              },
              {
                  "ParameterValue": "disabled",
                  "ParameterName": "tls",
                  "ApplyType": "static",
                  "DataType": "string",
                  "Description": "Config to enable/disable TLS",
                  "AllowedValues": "disabled,enabled",
                  "Source": "system",
                  "IsModifiable": true,
                  "ApplyMethod": "pending-reboot"
              }
          ]
   }