Modification des paramètres du cluster Amazon DocumentDB

Dans Amazon DocumentDB, les groupes de paramètres de cluster sont des paramètres qui s'appliquent à toutes les instances que vous créez dans le cluster. Pour les groupes de paramètres de cluster personnalisés, vous pouvez modifier une valeur de paramètre à tout moment ou réinitialiser toutes les valeurs de paramètre à leurs valeurs par défaut pour les groupes de paramètres que vous créez. Cette section explique comment afficher les paramètres qui constituent un groupe de paramètres de cluster Amazon DocumentDB et leurs valeurs, et comment modifier ou mettre à jour ces valeurs.

Les paramètres peuvent être dynamiques ou statiques. Lorsque vous modifiez un paramètre dynamique et que vous enregistrez le groupe de paramètres de cluster, la modification est appliquée immédiatement, quel que soit le paramètre Apply Immediately. Lorsque vous modifiez un paramètre statique et que vous enregistrez le groupe de paramètres de cluster, la modification du paramètre est appliquée après que vous avez redémarré manuellement l'instance.

Afficher les paramètres d'un groupe de paramètres de cluster Amazon DocumentDB

Vous pouvez consulter les paramètres d'un cluster Amazon DocumentDB et leurs valeurs à l'aide du AWS Management Console ou. AWS CLI

Using the AWS Management Console

Pour afficher les détails d'un groupe de paramètres de cluster

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, choisissez Groupes de paramètres.

   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. Dans le volet Groupes de paramètres, sélectionnez le nom du groupe de paramètres de cluster dont vous voulez voir les détails.

4. La page qui s’affiche montre les valeurs suivantes pour chaque paramètre : nom du paramètre, valeur actuelle, valeurs autorisées, si le paramètre est modifiable, type d'application, type de données et description.

   

Using the AWS CLI

Pour afficher les paramètres et les valeurs d'un groupe de paramètres de cluster, utilisez l'opération describe-db-cluster-parameters avec les paramètres suivants.

• --db-cluster-parameter-group-name — Obligatoire. Le nom du groupe de paramètres de cluster pour lequel vous souhaitez obtenir une liste détaillée des paramètres.

• --source— Facultatif. S'il est fournit, il renvoie uniquement les paramètres pour une source spécifique. Les sources du paramètre peuvent être engine-default, system ou user.

L'exemple de code suivant répertorie les paramètres et leurs valeurs pour le groupe de paramètres custom3-6-param-grp. Pour obtenir des informations sur le groupe de paramètres, omettez la ligne --query. Pour obtenir des informations sur tous les groupes de paramètres, omettez la ligne --db-cluster-parameter-group-name.

Pour Linux, macOS ou Unix :

aws docdb describe-db-cluster-parameters \
   --db-cluster-parameter-group-name custom3-6-param-grp \
   --query 'Parameters[*].[ParameterName,ParameterValue]'

Pour Windows :

aws docdb describe-db-cluster-parameters ^
   --db-cluster-parameter-group-name custom3-6-param-grp ^
   --query 'Parameters[*].[ParameterName,ParameterValue]'

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

[
    [
        "audit_logs",
        "disabled"
    ],
    [
        "tls",
        "enabled"
    ],
    [
        "ttl_monitor",
        "enabled"
    ]
]

Modification des paramètres d'un groupe de paramètres de cluster Amazon DocumentDB

Vous pouvez modifier les paramètres d'un groupe de paramètres à l'aide de l'AWS Management Console ou de l'AWS CLI.

Using the AWS Management Console

Pour mettre à jour les paramètres d'un groupe de paramètres de cluster

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, choisissez Groupes de paramètres.

   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. Dans le volet Parameter groups (Groupes de paramètres), choisissez le groupe de paramètres de cluster dont vous souhaitez mettre à jour les paramètres.

4. La page qui s’affiche montre les paramètres et leurs détails correspondants pour ce groupe de paramètres de cluster. Sélectionnez un paramètre à mettre à jour.

5. En haut à droite de la page, choisissez Edit (Modifier) pour modifier la valeur du paramètre. Pour de plus amples informations sur les types de paramètres de cluster, veuillez consulter Référence des paramètres du cluster Amazon DocumentDB.

6. Effectuez votre modification, puis choisissez Modify cluster parameter (Modifier le paramètre de cluster) pour enregistrer les modifications. Pour ignorer vos modifications, choisissez Annuler.

Using the AWS CLI

Pour modifier les paramètres d'un groupe de paramètres de cluster, 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. Le paramètre ou les paramètres que vous voulez modifier. 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.

Pour modifier les valeurs des paramètres d'un groupe de paramètres de cluster (AWS CLI)

L'exemple suivant modifie le paramètre tls.

1. Liste des paramètres et de leurs valeurs pour 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. Modifier 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. Liste des valeurs du paramètre du 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": [
           {
               "ParameterName": "audit_logs",
               "ParameterValue": "disabled",
               "Description": "Enables auditing on cluster.",
               "Source": "system",
               "ApplyType": "dynamic",
               "DataType": "string",
               "AllowedValues": "enabled,disabled",
               "IsModifiable": true,
               "ApplyMethod": "pending-reboot"
           },
           {
               "ParameterName": "tls",
               "ParameterValue": "disabled",
               "Description": "Config to enable/disable TLS",
               "Source": "user",
               "ApplyType": "static",
               "DataType": "string",
               "AllowedValues": "disabled,enabled",
               "IsModifiable": true,
               "ApplyMethod": "pending-reboot"
           }
       ]
   }