Décrire les groupes de paramètres du cluster Amazon DocumentDB

Un groupe de paramètres de default cluster est créé automatiquement lorsque vous créez le premier cluster Amazon DocumentDB dans une nouvelle région ou lorsque vous utilisez un nouveau moteur. Les clusters suivants, créés dans la même région et dotés de la même version de moteur, sont créés avec le groupe de paramètres de default cluster.

Décrire les détails d'un groupe de paramètres de cluster Amazon DocumentDB

Pour décrire les détails d'un groupe de paramètres de cluster donné, procédez comme suit à l'aide de l'AWS Management Console ou de l'AWS Command Line Interface (AWS CLI).

Using the AWS Management Console

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

4. La page qui s'affiche répertorie les paramètres du groupe de paramètres, l'activité récente ainsi que les balises.

   • Sous Cluster parameters (Paramètres de cluster), vous pouvez voir le nom du paramètre, la valeur actuelle, les valeurs autorisées, si le paramètre est modifiable, son type d'application, son type de données et sa description. Vous pouvez modifier des paramètres individuels en sélectionnant le paramètre, puis en choisissant Modifier dans la section Cluster parameters (Paramètres de cluster) . Pour plus d'informations, consultez Modification des paramètres du cluster Amazon DocumentDB.

   • Sous Événements récents, vous pouvez voir les événements les plus récents pour ce groupe de paramètres. Vous pouvez filtrer ces événements à l'aide de la barre de recherche de cette section. Pour plus d'informations, consultez Gestion des événements Amazon DocumentDB mentents.

   • Dans Tags (Balises), vous pouvez voir les balises qui se trouvent dans ce groupe de paramètres de cluster. Vous pouvez ajouter ou supprimer des balises en choisissant Modifier dans la section Balises. Pour plus d'informations, consultez Balisage des ressources Amazon DocumentDB.

Using the AWS CLI

Vous pouvez utiliser la describe-db-cluster-parameter-groups AWS CLI commande pour afficher le nom de ressource Amazon (ARN), la famille, la description et le nom d'un seul groupe de paramètres de cluster ou de tous les groupes de paramètres de cluster dont vous disposez pour Amazon DocumentDB. Vous pouvez également utiliser la commande describe-db-cluster-parameters de l'AWS CLI pour afficher les paramètres et leurs détails dans un seul groupe de paramètres de cluster.

• --describe-db-cluster-parameter-groups— Pour consulter la liste de tous vos groupes de paramètres de cluster et leurs détails.

  • --db-cluster-parameter-group-name— Facultatif. Nom du groupe de paramètres de cluster que vous voulez décrire. Si ce paramètre n'est pas spécifié, tous les groupes de paramètres de cluster sont décrits.

• --describe-db-cluster-parameters— Pour répertorier tous les paramètres d'un groupe de paramètres et leurs valeurs.

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

Le code suivant répertorie jusqu'à 100 groupes de paramètres de cluster ainsi que leur ARN, leur famille, leur description et leur nom.

aws docdb describe-db-cluster-parameter-groups

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

{
          "DBClusterParameterGroups": [
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:default.docdb4.0",
                  "DBParameterGroupFamily": "docdb4.0",
                  "Description": "Default cluster parameter group for docdb4.0",
                  "DBClusterParameterGroupName": "default.docdb4.0"
              },
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:sample-parameter-group",
                  "DBParameterGroupFamily": "docdb4.0",
                  "Description": "Custom docdb4.0 parameter group",
                  "DBClusterParameterGroupName": "sample-parameter-group"
              }
          ]
}

Le code suivant répertorie l'ARN, la famille, la description et le nom de sample-parameter-group.

Pour Linux, macOS ou Unix :

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

Pour Windows :

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

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

{
          "DBClusterParameterGroups": [
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-parameter-group",
                  "Description": "Custom docdb4.0 parameter group",
                  "DBParameterGroupFamily": "docdb4.0",
                  "DBClusterParameterGroupName": "sample-parameter-group"
              }
          ]
}

Le code suivant répertorie les valeurs des paramètres dans 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": "change_stream_log_retention_duration",
            "ParameterValue": "17777",
            "Description": "Duration of time in seconds that the change stream log is retained and can be consumed.",
            "Source": "user",
            "ApplyType": "dynamic",
            "DataType": "integer",
            "AllowedValues": "3600-86400",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot"
         }
   ]
}

Déterminer le groupe de paramètres d'un cluster Amazon DocumentDB

Pour déterminer quel groupe de paramètres est associé à un cluster particulier, procédez comme suit à l'aide de l'AWS Management Console ou de l'AWS CLI.

Using the AWS Management Console

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 de gauche, choisissez Clusters.

3. Dans la liste des clusters, sélectionnez le nom du cluster qui vous intéresse.

4. La page qui s'affiche répertorie les détails du cluster sélectionné. Faites défiler vers le bas jusqu'à Cluster details (Détails du cluster). En bas de cette section, recherchez le nom du groupe de paramètres sous Cluster parameter group (Groupe de paramètres de cluster).

   

Using the AWS CLI

Le code suivant de l'AWS CLI détermine quel groupe de paramètres régit le sample-cluster du cluster.

aws docdb describe-db-clusters \
      --db-cluster-identifier sample-cluster \
      --query 'DBClusters[*].[DBClusterIdentifier,DBClusterParameterGroup]'      

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

[
       [
           "sample-cluster",
           "sample-parameter-group"
       ]
]