

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.

# Gestion des ressources Amazon DocumentDB
<a name="managing-documentdb"></a>

Ces sections couvrent les différents composants et les tâches associées à la gestion de votre implémentation Amazon DocumentDB (compatible avec MongoDB).

**Topics**
+ [Vue d'ensemble des tâches opérationnelles](operational_tasks.md)
+ [Clusters mondiaux](global-clusters.md)
+ [Gestion des clusters](db-clusters.md)
+ [Gestion des instances](db-instances.md)
+ [Gestion des groupes de sous-réseaux](document-db-subnet-groups.md)
+ [Haute disponibilité et réplication](replication.md)
+ [Gestion des index](managing-indexes.md)
+ [Gestion de la compression des documents](doc-compression.md)
+ [Gestion de la compression basée sur un dictionnaire](dict-compression.md)
+ [Gestion des événements](managing-events.md)
+ [Choix des régions et des zones de disponibilité](regions-and-azs.md)
+ [Gestion des groupes de paramètres du cluster](cluster_parameter_groups.md)
+ [Comprendre les points de terminaison](endpoints.md)
+ [Comprendre Amazon DocumentDB ARNs](documentdb-arns.md)
+ [Balisage de ressources](tagging.md)
+ [Gestion d'Amazon DocumentDB](db-instance-maintain.md)
+ [Comprendre les rôles liés aux services](service-linked-roles.md)
+ [Utilisation des flux de changement](change_streams.md)
+ [Utilisation du classement](collation.md)
+ [Utilisation des vues](views.md)
+ [Utilisation AWS Lambda avec les flux de modifications](using-lambda.md)

# Présentation des tâches opérationnelles d'Amazon DocumentDB
<a name="operational_tasks"></a>

Cette section décrit les tâches opérationnelles de votre cluster Amazon DocumentDB et explique comment accomplir ces tâches à l'aide du. AWS CLI

**Topics**
+ [Ajouter une réplique à un cluster Amazon DocumentDB](#operational_tasks-add_replica)
+ [Décrire les clusters et les instances](#operational_tasks-list_clusters_and_instances)
+ [Création d'un instantané de cluster](#operational_tasks-creating_snapshot)
+ [Restaurer à partir d'un instantané](#operational_tasks-restore_from_snapshot)
+ [Supprimer une instance d'un cluster](#operational_tasks-remove_instance_from_cluster)
+ [Suppression d’un cluster](#operational_tasks-delete_cluster)

## Ajouter une réplique à un cluster Amazon DocumentDB
<a name="operational_tasks-add_replica"></a>

*Après avoir créé l'instance principale pour votre cluster Amazon DocumentDB, vous pouvez ajouter une ou plusieurs répliques.* Un réplica est une instance en lecture seule qui a deux finalités :
+ **Évolutivité** — Si vous avez un grand nombre de clients nécessitant un accès simultané, vous pouvez ajouter d'autres répliques pour le dimensionnement des lectures.
+ **Haute disponibilité** : en cas de défaillance de l'instance principale, Amazon DocumentDB bascule automatiquement vers une instance de réplique et la désigne comme nouvelle instance principale. Si un réplica échoue, d'autres instances dans le cluster peuvent tout de même servir des demandes jusqu'à ce que le nœud en échec puisse être récupéré. 

Chaque cluster Amazon DocumentDB peut prendre en charge jusqu'à 15 répliques.

**Note**  
Pour bénéficier d'une tolérance aux pannes maximale, vous devez déployer les réplicas dans des zones de disponibilité distinctes. Cela permet de garantir que votre cluster Amazon DocumentDB peut continuer à fonctionner, même si une zone de disponibilité complète devient indisponible.

L' AWS CLI exemple suivant montre comment ajouter une nouvelle réplique. Le paramètre `--availability-zone` place le réplica dans la zone de disponibilité spécifiée.

```
aws docdb create-db-instance \
    --db-instance-identifier sample-instance \
    --db-cluster-identifier sample-cluster \
    --engine docdb \
    --db-instance-class db.r5.large \
    --availability-zone us-east-1a
```

## Décrire les clusters et les instances
<a name="operational_tasks-list_clusters_and_instances"></a>

L' AWS CLI exemple suivant répertorie tous les clusters Amazon DocumentDB d'une région. Pour certaines fonctionnalités de gestion telles que la gestion du cycle de vie des clusters et des instances, Amazon DocumentDB utilise une technologie opérationnelle partagée avec Amazon RDS. Le paramètre de `filterName=engine,Values=docdb` filtre renvoie uniquement les clusters Amazon DocumentDB. 

Pour plus d'informations sur la description et la modification des clusters, veuillez consulter [Cycle de vie du cluster Amazon DocumentDB](db-cluster-life-cycle.md).

```
aws docdb describe-db-clusters --filter Name=engine,Values=docdb
```

Le résultat de cette opération ressemble à ceci.

```
{
    "DBClusters": [
        {
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1b",
                "us-east-1a"
            ],
            "BackupRetentionPeriod": 1,
            "DBClusterIdentifier": "sample-cluster-1",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            ...
        },
        {
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1b",
                "us-east-1a"
            ],
            "BackupRetentionPeriod": 1,
            "DBClusterIdentifier": "sample-cluster-2",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            ...
        },
        {
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1b",
                "us-east-1a"
            ],
            "BackupRetentionPeriod": 1,
            "DBClusterIdentifier": "sample-cluster-3",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            ...
        }
    ]
}
```

L' AWS CLI exemple suivant répertorie les instances d'un cluster Amazon DocumentDB. Pour plus d'informations sur la description et la modification des clusters, veuillez consulter [Cycle de vie des instances Amazon DocumentDB](db-instance-life-cycle.md). 

```
aws docdb describe-db-clusters \
    --db-cluster-identifier sample-cluster \
    --query 'DBClusters[*].[DBClusterMembers]'
```

Le résultat se présente comme suit. Il existe deux sections dans ce résultat. L'instance principale est `sample-instance-1` (`"IsClusterWriter": true`). Il existe également une instance de réplica, `sample-instance2` (`"IsClusterWriter: false"`).

```
[
    [
        [
            {
                "DBInstanceIdentifier": "sample-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            },
            {
                "DBInstanceIdentifier": "sample-cluster-2",
                "IsClusterWriter": false,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ]
    ]
]
```

## Création d'un instantané de cluster
<a name="operational_tasks-creating_snapshot"></a>

Un *instantané de cluster* est une sauvegarde complète des données de votre cluster Amazon DocumentDB. Lorsque l'instantané est créé, Amazon DocumentDB lit vos données directement depuis le volume du cluster. Pour cette raison, vous pouvez créer un instantané, même aucune instance n'est exécutée à ce moment-là dans votre cluster. Le temps nécessaire à la création d'un instantané varie en fonction de la taille du volume de votre cluster.

Amazon DocumentDB prend en charge les sauvegardes automatiques, qui ont lieu tous les jours pendant la période de sauvegarde préférée, soit 30 minutes par jour. L' AWS CLI exemple suivant montre comment afficher la fenêtre de sauvegarde de votre cluster :

```
aws docdb describe-db-clusters \
    --db-cluster-identifier sample-cluster \
    --query 'DBClusters[*].PreferredBackupWindow'
```

Le résultat montre le créneau de sauvegarde (au format UTC) :

```
[
    "00:18-00:48"
]
```

Vous pouvez définir la fenêtre de sauvegarde lorsque vous créez votre cluster Amazon DocumentDB. Vous pouvez également modifier le créneau de sauvegarde, comme l'illustre l'exemple suivant. Si vous ne définissez pas de fenêtre de sauvegarde, Amazon DocumentDB en attribue une automatiquement à votre cluster.

```
aws docdb modify-db-cluster \
    --db-cluster-identifier sample-cluster \
    --preferred-backup-window "02:00-02:30"
```

Outre les sauvegardes automatiques, vous pouvez créer manuellement un instantané de cluster à tout moment. En faisant cela, vous spécifiez le cluster que vous souhaitez sauvegarder, et un nom unique pour votre instantané, afin de pouvoir restaurer à partir de ce dernier ultérieurement.

L' AWS CLI exemple suivant montre comment créer un instantané de vos données.

```
aws docdb create-db-cluster-snapshot \
    --db-cluster-identifier sample-cluster \
    --db-cluster-snapshot-identifier sample-cluster-snapshot
```

## Restaurer à partir d'un instantané
<a name="operational_tasks-restore_from_snapshot"></a>

Vous pouvez restaurer un instantané de cluster sur un nouveau cluster Amazon DocumentDB. Pour ce faire, vous fournissez le nom de l'instantané et le nom d'un nouveau cluster. Vous ne pouvez pas effectuer de restauration à partir d'un instantané vers un cluster existant ; Amazon DocumentDB crée un nouveau cluster lors de la restauration, puis le remplit avec les données de votre instantané. 

L'exemple suivant montre tous les instantanés pour le cluster `sample-cluster`.

```
aws docdb describe-db-cluster-snapshots \
    --db-cluster-identifier sample-cluster \
    --query 'DBClusterSnapshots[*].[DBClusterSnapshotIdentifier,SnapshotType,Status]'
```

Le résultat se présente comme suit. Un instantané manuel est créé manuellement, tandis qu'un instantané automatique est créé par Amazon DocumentDB dans la fenêtre de sauvegarde du cluster.

```
[
        "sample-cluster-snapshot", 
        "manual", 
        "available"
    ], 
    [
        "rds:sample-cluster", 
        "automated", 
        "available"
    ]
]
```

L'exemple suivant montre comment restaurer un cluster Amazon DocumentDB à partir d'un instantané.

```
aws docdb restore-db-cluster-from-snapshot \
    --engine docdb \
    --db-cluster-identifier new-sample-cluster \
    --snapshot-identifier sample-cluster-snapshot
```

Le nouveau cluster n'a aucune instance associée. Par conséquent, si vous souhaitez interagir avec le cluster, vous devez ajouter une instance à ce dernier.

```
aws docdb create-db-instance \
    --db-instance-identifier new-sample-instance \
    --db-instance-class db.r5.large \
    --engine docdb \
    --db-cluster-identifier new-sample-cluster
```

Vous pouvez utiliser les AWS CLI opérations suivantes pour suivre la progression de la création de clusters et d'instances. Lorsque les statuts du cluster et de l'instance sont disponibles, vous pouvez vous connecter au point de terminaison du nouveau cluster et accéder à vos données.

```
aws docdb describe-db-clusters \
    --db-cluster-identifier new-sample-cluster  \
    --query 'DBClusters[*].[Status,Endpoint]'
```

```
aws docdb describe-db-instances \
    --db-instance-identifier new-sample-instance \
    --query 'DBInstances[*].[DBInstanceStatus]'
```

## Supprimer une instance d'un cluster
<a name="operational_tasks-remove_instance_from_cluster"></a>

Amazon DocumentDB stocke toutes vos données dans le volume du cluster. Les données restent dans ce volume de cluster, même si vous supprimez toutes les instances de votre cluster. Si vous avez besoin d'accéder aux données à nouveau, vous pouvez ajouter une instance au cluster à tout moment, et reprendre votre activité là où vous l'aviez laissée.

L'exemple suivant montre comment supprimer une instance de votre cluster Amazon DocumentDB.

```
aws docdb delete-db-instance \
    --db-instance-identifier sample-instance
```

## Suppression d’un cluster
<a name="operational_tasks-delete_cluster"></a>

Avant de pouvoir supprimer un cluster Amazon DocumentDB, vous devez d'abord supprimer toutes ses instances. L' AWS CLI exemple suivant renvoie des informations sur les instances d'un cluster. Si cette opération renvoie des identifiants d'instance, vous devez supprimer chacune des instances. Pour de plus amples informations, veuillez consulter [Supprimer une instance d'un cluster](#operational_tasks-remove_instance_from_cluster). 

```
aws docdb describe-db-clusters \
    --db-cluster-identifier sample-cluster \
    --query 'DBClusters[*].DBClusterMembers[*].DBInstanceIdentifier'
```

Quand il ne reste plus d'instances, vous pouvez supprimer le cluster. A ce moment-là, vous devez choisir l'une des options suivantes :
+ **Créer un instantané final** — Capturez toutes les données du cluster dans un instantané afin de pouvoir recréer une nouvelle instance avec ces données ultérieurement. L'exemple suivant illustre la marche à suivre :

  ```
  aws docdb delete-db-cluster \
      --db-cluster-identifier sample-cluster \
      --final-db-snapshot-identifier sample-cluster-snapshot
  ```
+ **Ignorer l'instantané final** : supprimez définitivement toutes les données du cluster. Cette opération ne peut pas être annulée. L'exemple suivant illustre la marche à suivre :

  ```
  aws docdb delete-db-cluster \
      --db-cluster-identifier sample-cluster \
      --skip-final-snapshot
  ```

# Présentation des clusters globaux Amazon DocumentDB
<a name="global-clusters"></a>

## Qu'est-ce qu'un cluster mondial ?
<a name="w2aac33b9b3"></a>

Un cluster mondial comprend une région principale et jusqu'à 10 régions secondaires en lecture seule. Vous effectuez des opérations d'écriture directement sur le cluster principal de la région principale et Amazon DocumentDB réplique automatiquement les données vers les régions secondaires à l'aide d'une infrastructure dédiée. La latence est généralement inférieure à une seconde.

## En quoi les clusters mondiaux sont-ils utiles ?
<a name="w2aac33b9b5"></a>
+ **Restauration après des pannes à l'échelle de la région** : en cas de panne régionale, vous pouvez transformer l'un des clusters secondaires en cluster principal en quelques minutes, avec un objectif de temps de restauration (RTO) typique inférieur à une minute. L'objectif du point de restauration (RPO) est généralement mesuré en secondes, mais cela dépend du décalage sur le réseau au moment de la panne.
+ **Lectures globales avec latence locale** — Si vous avez des bureaux dans le monde entier, vous pouvez utiliser un cluster mondial pour tenir à jour vos principales sources d'informations dans la région principale. Les bureaux de vos autres régions peuvent accéder aux informations de leur propre région, avec une latence locale.
+ **Clusters secondaires évolutifs** : vous pouvez redimensionner vos clusters secondaires en ajoutant davantage d'instances en lecture seule dans une région secondaire. Le cluster secondaire est en lecture seule, il peut donc prendre en charge jusqu'à 16 instances de réplication en lecture seule au lieu de la limite habituelle de 15 pour un seul cluster.
+ **Réplication rapide des clusters principaux vers les clusters secondaires** : la réplication effectuée par un cluster global a peu d'impact sur les performances du cluster de base de données principal. Les ressources des instances de base de données sont entièrement dévouées aux charges de travail d’application en lecture et en écriture.

## Quelles sont les limites actuelles des clusters mondiaux ?
<a name="w2aac33b9b7"></a>
+ Les clusters globaux ne sont pas pris en charge sur Amazon DocumentDB v3.6.
+ Les clusters globaux sont pris en charge sur tous les types d'instances à l'exception de db.t3, db.t4g et db.r4.
+ Les clusters mondiaux ne sont pas disponibles dans les régions suivantes : Amérique du Sud (São Paulo), Europe (Milan), Chine (Pékin) et Chine (Ningxia).
+ Le basculement et le basculement global ne sont pas pris en charge lorsque les régions utilisent des versions de moteur différentes. Le basculement manuel est pris en charge en cas d'incompatibilité entre les versions du moteur.
+ Seul le cluster principal exécute les opérations d’écriture. Les clients qui effectuent des opérations d'écriture se connectent au point de terminaison du cluster principal.
+ Vous pouvez avoir un maximum de 10 régions secondaires et une région principale pour votre cluster.
+ Un cluster secondaire ne peut pas être arrêté. Un cluster principal ne peut pas être arrêté s'il est associé à des clusters secondaires. Seul un cluster régional qui ne possède aucun cluster secondaire peut être arrêté.
+ Les répliques associées au cluster secondaire peuvent redémarrer dans certaines circonstances. Si l'instance de la région principale redémarre ou bascule, les répliques de la région secondaire redémarrent également. Le cluster est alors indisponible jusqu'à ce que toutes les répliques soient à nouveau synchronisées avec l'instance d'écriture du cluster de base de données principal. Ce comportement est normal. Assurez-vous de bien comprendre l'impact sur votre cluster global avant d'apporter des modifications à votre cluster principal.
+ Vous ne pouvez pas utiliser de flux de modifications sur des clusters secondaires.

**Topics**
+ [Qu'est-ce qu'un cluster mondial ?](#w2aac33b9b3)
+ [En quoi les clusters mondiaux sont-ils utiles ?](#w2aac33b9b5)
+ [Quelles sont les limites actuelles des clusters mondiaux ?](#w2aac33b9b7)
+ [Guide de démarrage rapide](global-clusters.get-started.md)
+ [Gestion des clusters mondiaux](global-clusters.manage.md)
+ [Connecter les clusters mondiaux](global-clusters-connect.md)
+ [Surveillance des clusters mondiaux](global-clusters-monitor.md)
+ [Reprise après sinistre](global-clusters-disaster-recovery.md)

# Guide de démarrage rapide : clusters mondiaux
<a name="global-clusters.get-started"></a>

**Topics**
+ [Configuration](#global-clusters.config)
+ [Création d'un cluster mondial](#global-clusters-create)
+ [Ajouter une région à un cluster mondial](#global-clusters.add-region)
+ [Utilisation d'un instantané](#global-clusters.snapshot)

## Configuration
<a name="global-clusters.config"></a>

Le cluster global Amazon DocumentDB s'étend sur au moins deux. Régions AWS La région principale prend en charge un cluster qui possède une instance principale (d'écriture) et jusqu'à 15 instances de réplique, tandis qu'une région secondaire exécute un cluster en lecture seule composé entièrement de 16 instances de réplique au maximum. Un cluster mondial peut comporter jusqu'à cinq régions secondaires. Le tableau répertorie le nombre maximal de clusters, d'instances et de répliques autorisés dans un cluster global.


| Description | Primaire Région AWS | secondaire Région AWS | 
| --- | --- | --- | 
| Clusters | 1 | 5 (maximum) | 
| Instances de scripteur | 1 | 0 | 
| Instances en lecture seule (répliques Amazon DocumentDB), par cluster | 15 (max) | 16 (total) | 
| Instances en lecture seule (maximum autorisé, compte tenu du nombre réel de régions secondaires) | 15 - s | s = nombre total d'établissements secondaires Régions AWS | 

Les clusters ont les exigences spécifiques suivantes :
+ **Exigences relatives aux classes d'instance de base** de données : vous ne pouvez utiliser que les classes d'`db.r6g`instance `db.r5` et. 
+ **Région AWS exigences** — Le cluster principal doit se trouver dans une région, et au moins un cluster secondaire doit se trouver dans une région différente du même compte. Vous pouvez créer jusqu'à cinq clusters secondaires (en lecture seule), chacun devant se trouver dans une région différente. En d'autres termes, deux clusters ne peuvent pas se trouver dans la même région.
+ **Exigences en matière de dénomination** — Les noms que vous choisissez pour chacun de vos clusters doivent être uniques, dans toutes les régions. Vous ne pouvez pas utiliser le même nom pour différents clusters, même s'ils se trouvent dans des régions différentes.

## Création d'un cluster global Amazon DocumentDB
<a name="global-clusters-create"></a>

Êtes-vous prêt à créer votre premier cluster mondial ? Dans cette section, nous expliquerons comment créer un tout nouveau cluster global avec de nouveaux clusters et instances de base de données, en utilisant les instructions suivantes AWS Management Console ou AWS CLI en suivant les instructions suivantes. 

### À l'aide du AWS Management Console
<a name="global-clusters-create-console"></a>

1. Dans le AWS Management Console, accédez à **Amazon DocumentDB**.

1. **Lorsque vous accédez à la console Amazon DocumentDB, choisissez Clusters.**  
![\[La page Clusters de la console Amazon DocumentDB.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/choose-cluster.png)

1. Choisissez **Créer**.  
![\[Le bouton Créer apparaît dans le coin supérieur droit du tableau des clusters.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/choose-create.png)

1. Remplissez la section **Configuration** du formulaire de **création d'un cluster Amazon DocumentDB** en conséquence :
   + **Identifiant de cluster** : vous pouvez saisir un identifiant unique pour cette instance ou autoriser Amazon DocumentDB à fournir l'identifiant d'instance en fonction de l'identifiant de cluster.
   + Version du moteur : Choose **4.0.0**
   + Classe d'instance : Choisissez **db.r5.large**
   + Nombre d'instances : Choisissez **3**.  
![\[Formulaire d'options de configuration pour créer un cluster Amazon DocumentDB.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/create-config.png)

1. Dans la section **Authentification**, saisissez un nom d'utilisateur principal et un mot de passe principal.  
![\[Formulaire d'authentification permettant de spécifier un nom d'utilisateur et un mot de passe principaux pour un nouveau cluster Amazon DocumentDB.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/create-auth.png)

1. Choisissez **Afficher les paramètres avancés**.  
![\[Afficher le bouton de basculement des paramètres avancés à côté des boutons Annuler et Créer un cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/show-advanced.png)

1. Dans la section **Paramètres réseau** :
   + **Conservez les options par défaut pour **Virtual Private Cloud (VPC) et le groupe** de sous-réseaux.**  
![\[Formulaire de paramètres réseau indiquant les options du VPC, du groupe de sous-réseaux et des groupes de sécurité VPC. Les champs VPC et Subnet Group ont des options par défaut sélectionnées.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/default-vpc-1.png)
   + Pour les **groupes de sécurité VPC**, la **valeur par défaut (VPC)** doit déjà être ajoutée.  
![\[Formulaire de paramètres réseau indiquant que le VPC par défaut a déjà été ajouté.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/default-vpc-2.png)
   + Tapez `DocDB` dans le champ **Groupes de sécurité VPC** et sélectionnez **DocDB-Inbound** (VFC).  
![\[DocDB-Inbound VFC sélectionné dans le menu déroulant des groupes de sécurité VPC.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/inbound-vfc.png)

1. Pour les **options de cluster** et **E ncryption-at-rest**, conservez les sélections par défaut.  
![\[Options de cluster et Encryption-at-rest formulaires avec les options par défaut sélectionnées.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/leave-default-1.png)

1. Pour les **exportations **Backup** et Log**, conservez les sélections par défaut.  
![\[Backup and Log exporte les formulaires avec les options par défaut sélectionnées.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/leave-default-2.png)

1. Pour la **maintenance**, les **balises** et **la protection contre la suppression**, conservez les sélections par défaut.  
![\[Formulaires de protection relatifs à la maintenance, aux balises et à la suppression avec les options par défaut sélectionnées.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/leave-default-3.png)

1. Cliquez maintenant sur le bouton **Créer un cluster**.  
![\[Le bouton Créer un cluster apparaît à la fin du processus de création du cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/create-cluster.png)

### À l'aide du AWS CLI
<a name="global-clusters-create-cli"></a>

Pour créer un cluster régional Amazon DocumentDB, appelez le. [create-global-cluster AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-global-cluster.html) La AWS CLI commande suivante crée un cluster Amazon DocumentDB nommé. `global-cluster-id` Pour plus d'informations sur la protection contre les suppressions, consultez[Suppression d'un cluster Amazon DocumentDB](db-cluster-delete.md). 

Il s'`--engine-version`agit également d'un paramètre facultatif qui utilise par défaut la dernière version majeure du moteur. La version actuelle du moteur par défaut est `5.0.0` (remarque : Amazon DocumentDB 8.0 est disponible mais doit être explicitement spécifiée comme`8.0.0`). Lorsque de nouvelles versions majeures du moteur sont publiées, la version par défaut du moteur est mise à jour pour `--engine-version` refléter la dernière version majeure du moteur. Par conséquent, pour les charges de travail de production, et en particulier celles qui dépendent de scripts, d'automatisation ou de CloudFormation modèles, nous vous recommandons de spécifier explicitement la `--engine-version` version majeure prévue.

Si un `db-subnet-group-name` ou n'`vpc-security-group-id`est pas spécifié, Amazon DocumentDB utilisera le groupe de sous-réseaux et le groupe de sécurité Amazon VPC par défaut pour la région donnée.

Dans l'exemple suivant, remplacez chacune *user input placeholder* par vos propres informations.

Pour Linux, macOS ou Unix :

```
aws docdb create-db-cluster \
      --global-cluster-identifier global-cluster-id \
      --source-db-cluster-identifier arn:aws:rds:us-east-1:111122223333:cluster-id
```

Pour Windows :

```
aws docdb create-db-cluster ^
      --global-cluster-identifier global-cluster-id ^
      --source-db-cluster-identifier arn:aws:rds:us-east-1:111122223333:cluster-id
```

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

```
{
    "DBCluster": {
        "StorageEncrypted": false,
        "DBClusterMembers": [],
        "Engine": "docdb",
        "DeletionProtection" : "enabled",
        "ClusterCreateTime": "2018-11-26T17:15:19.885Z",
        "DBSubnetGroup": "default",
        "EngineVersion": "4.0.0",
        "MasterUsername": "masteruser",
        "BackupRetentionPeriod": 1,
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:cluster-id",
        "DBClusterIdentifier": "cluster-id",
        "MultiAZ": false,
        "DBClusterParameterGroup": "default.docdb4.0",
        "PreferredBackupWindow": "09:12-09:42",
        "DbClusterResourceId": "cluster-KQSGI4MHU4NTDDRVNLNTU7XVAY",
        "PreferredMaintenanceWindow": "tue:04:17-tue:04:47",
        "Port": 27017,
        "Status": "creating",
        "ReaderEndpoint": "cluster-id.cluster-ro-sfcrlcjcoroz.us-east-1.docdb.amazonaws.com",
        "AssociatedRoles": [],
        "HostedZoneId": "ZNKXTT8WH85VW",
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-77186e0d",
                "Status": "active"
            }
        ],
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1c",
            "us-east-1e"
        ],
        "Endpoint": "cluster-id.cluster-sfcrlcjcoroz.us-east-1.docdb.amazonaws.com"
    }
}
```

La création du cluster prend quelques minutes. Vous pouvez utiliser le AWS Management Console ou AWS CLI pour surveiller l'état de votre cluster. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'un cluster Amazon DocumentDB](monitoring_docdb-cluster_status.md). 

**Important**  
Lorsque vous utilisez le AWS CLI pour créer un cluster régional Amazon DocumentDB, aucune instance n'est créée. Par conséquent, vous devez créer explicitement une instance principale et tous les réplicas des instances dont vous avez besoin. Vous pouvez utiliser la console ou AWS CLI créer les instances. Pour plus d'informations, consultez [Ajouter une instance Amazon DocumentDB à un cluster](db-instance-add.md) et consultez le [CreateDBCluster](API_CreateDBCluster.md) manuel Amazon DocumentDB API Reference. 

Une fois que votre cluster régional est disponible, vous pouvez ajouter un cluster secondaire dans une autre région en suivant les instructions suivantes :[Ajouter un Région AWS à un cluster global Amazon DocumentDB](#global-clusters.add-region). Lorsque vous ajoutez une région, votre cluster régional devient votre cluster principal, et vous avez un nouveau cluster secondaire dans la région que vous avez choisie.

## Ajouter un Région AWS à un cluster global Amazon DocumentDB
<a name="global-clusters.add-region"></a>

Un cluster global a besoin d'au moins un cluster secondaire dans une région différente de celle du cluster principal, et vous pouvez ajouter jusqu'à cinq clusters secondaires. Notez que pour chaque cluster secondaire que vous ajoutez, vous devez réduire d'un le nombre de répliques autorisées dans le cluster principal. Par exemple, si votre cluster global comporte cinq régions secondaires, votre cluster principal ne peut avoir que 10 répliques (au lieu de 15). Pour plus d'informations, consultez [la section Exigences de configuration d'un cluster global Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/global-clusters.get-started.html#global-clusters.config).

### À l'aide du AWS Management Console
<a name="global-clusters-add-region-console"></a>

1. Connectez-vous à la console Amazon DocumentDB AWS Management Console et ouvrez-la.

1. Dans le panneau de navigation, choisissez **Clusters**.  
![\[La page Clusters de la console Amazon DocumentDB.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/choose-cluster.png)

1. Choisissez le cluster auquel vous souhaitez ajouter un cluster secondaire. Assurez-vous que le cluster l'est`Available`.  
![\[Liste des clusters régionaux et mondiaux indiquant le statut disponible, avec mydocdbglobalcluster surligné.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/choose-cluster-2.png)

1. Sélectionnez la liste déroulante des **actions**, puis choisissez **Ajouter une région.**  
![\[Le menu déroulant Actions de l'interface Clusters affiche l'option Ajouter une région.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/add-region.png)

1. Sur la Région AWS page **Ajouter une** région, choisissez la région secondaire. Notez que vous ne pouvez pas choisir une région qui possède déjà un cluster secondaire pour le même cluster mondial. De plus, il ne peut pas s'agir de la même région que le cluster principal. S'il s'agit de la première région que vous ajoutez, vous devrez également spécifier un identifiant de cluster global de votre choix.  
![\[Choisissez une région secondaire à l'aide du menu déroulant du formulaire Ajouter un Région AWS formulaire.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/add-region-2.png)

1. Complétez les champs restants pour le cluster secondaire dans la nouvelle région, puis sélectionnez **Créer un cluster**. Une fois que vous avez terminé d'ajouter la région, vous pouvez la voir dans la liste des **clusters** du AWS Management Console.  
![\[Étapes finales de l'ajout d'une région à un cluster, avec affichage du formulaire de configuration, de l'estimation du coût horaire et du bouton Créer un cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/quick-start/select-add-region.png)

### À l'aide du AWS CLI
<a name="global-clusters-add-region-cli"></a>
+ Utilisez la commande `create-db-cluster` CLI avec le nom `(--global-cluster-identifier)` de votre cluster global. Pour les autres paramètres, procédez comme suit :
  + Pour`--region`, choisissez une région différente de Région AWS celle de votre région principale.
  + Choisissez des valeurs spécifiques pour les paramètres `--engine` et `--engine-version`. 
  + Pour un cluster chiffré, spécifiez votre cluster principal Région AWS comme étant le cluster `--source-region` de chiffrement.

L'exemple suivant crée un nouveau cluster Amazon DocumentDB et l'attache au cluster global en tant que cluster secondaire en lecture seule. Dans la dernière étape, l'instance est ajoutée au nouveau cluster.

Dans l'exemple suivant, remplacez chacune *user input placeholder* par vos propres informations.

Pour Linux, macOS ou Unix :

```
aws docdb --region secondary-region-id \
  create-db-cluster \
    --db-cluster-identifier cluster-id \
    --global-cluster-identifier global-cluster-id \
    --engine-version version \
    --engine docdb

aws docdb --region secondary-region-id \
  create-db-instance \
    --db-cluster-identifier cluster-id \
    --global-cluster-identifier global-cluster-id \
    --engine-version version \
    --engine docdb
```

Pour Windows :

```
aws docdb --region secondary-region-id ^
  create-db-cluster ^
    --db-cluster-identifier cluster-id ^
    --global-cluster-identifier global-cluster-id ^
    --engine-version version ^
    --engine docdb

aws docdb --region secondary-region-id ^
  create-db-instance ^
    --db-cluster-identifier cluster-id ^
    --global-cluster-identifier global-cluster-id ^
    --engine-version version ^
    --engine docdb
```

## Utilisation d'un instantané pour votre cluster global Amazon DocumentDB
<a name="global-clusters.snapshot"></a>

Vous pouvez restaurer un instantané d'un cluster Amazon DocumentDB afin de l'utiliser comme point de départ pour votre cluster global. Pour ce faire, vous devez restaurer le snapshot et créer un nouveau cluster. Il servira de cluster principal de votre cluster mondial. Vous pouvez ensuite ajouter une autre région au cluster restauré, le convertissant ainsi en cluster global. 

# Gestion d'un cluster global Amazon DocumentDB
<a name="global-clusters.manage"></a>

Vous effectuez la plupart des opérations de gestion sur les clusters individuels qui constituent un cluster global. Lorsque vous sélectionnez **Grouper les ressources associées** sur la page **Clusters** de la console, le cluster principal et les clusters secondaires sont regroupés sous le cluster global associé.

L'onglet **Configuration** d'un cluster global indique l' Régions AWS endroit où les clusters sont exécutés, la version et l'identifiant du cluster global.

**Topics**
+ [Modification de clusters globaux](#global-clusters.modify)
+ [Modification des paramètres](#global-clusters.modify-parameters)
+ [Supprimer des clusters globaux](#global-clusters.remove)
+ [Supprimer des clusters globaux](#global-clusters.delete)
+ [Clusters sans tête](#global-clusters.headless)

## Modification d'un cluster global Amazon DocumentDB
<a name="global-clusters.modify"></a>

La page **Clusters** AWS Management Console répertorie tous vos clusters globaux, en indiquant le cluster principal et les clusters secondaires pour chacun d'entre eux. Le cluster global possède ses propres paramètres de configuration. Plus précisément, des régions sont associées à ses clusters principaux et secondaires.

Lorsque vous apportez des modifications au cluster global, vous avez la possibilité d'annuler les modifications.

Lorsque vous choisissez Continuer, vous confirmez les modifications.

## Modification des paramètres d'un cluster global Amazon DocumentDB
<a name="global-clusters.modify-parameters"></a>

Vous pouvez configurer les groupes de paramètres de cluster indépendamment pour chaque cluster au sein du cluster global. La plupart des paramètres fonctionnent de la même manière que pour les autres types de clusters Amazon DocumentDB. Nous vous recommandons de maintenir la cohérence des paramètres entre tous les clusters d'une base de données globale. Vous pourrez ainsi éviter les changements de comportement inattendus si vous choisissez un cluster secondaire en tant que cluster principal.

Par exemple, utilisez les mêmes paramètres pour les fuseaux horaires et les jeux de caractères afin d'éviter tout écart de comportement si un autre cluster devient le cluster principal.

## Supprimer un cluster d'un cluster global Amazon DocumentDB
<a name="global-clusters.remove"></a>

Il existe plusieurs situations dans lesquelles vous souhaiterez peut-être supprimer des clusters de votre cluster global. Par exemple, vous souhaiterez peut-être supprimer un cluster d'un cluster global si le cluster principal est dégradé ou isolé. Il devient alors un cluster provisionné autonome qui peut être utilisé pour créer un nouveau cluster global. Pour en savoir plus, veuillez consulter la section [Réalisation d'un basculement manuel pour un cluster global Amazon DocumentDB](global-clusters-disaster-recovery.md#manual-failover).

Vous souhaiterez peut-être également supprimer des clusters car vous souhaitez supprimer un cluster global dont vous n'avez plus besoin. Vous ne pouvez pas supprimer le cluster global tant que vous n'avez pas détaché tous les clusters associés, en laissant le cluster principal en dernier. Pour de plus amples informations, veuillez consulter [Supprimer un cluster d'un cluster global Amazon DocumentDB](#global-clusters.delete).

**Note**  
Lorsqu'un cluster est détaché du cluster global, il n'est plus synchronisé avec le cluster principal. Il devient un cluster provisionné autonome doté de fonctionnalités complètes read/write . En outre, il n'est plus visible dans la console Amazon DocumentDB. Il n'est visible que lorsque vous sélectionnez la région de la console dans laquelle se trouvait le cluster.

Vous pouvez supprimer des clusters de votre cluster global à l'aide de l'API AWS Management Console, de AWS CLI, ou de l'API RDS.

------
#### [ Using the AWS Management Console ]

1. Connectez-vous à la console Amazon DocumentDB AWS Management Console et accédez à celle-ci.

1. Choisissez **Clusters** dans la barre de navigation de gauche.  
![\[Image : la boîte de navigation Clusters affichant une liste des liens de clusters existants et leurs liens d'instance correspondants.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/choose-cluster.png)

1. Développez le cluster global afin de voir tous les clusters secondaires. Sélectionnez les clusters secondaires que vous souhaitez supprimer. Choisissez **Actions**, puis dans le menu déroulant, choisissez **Supprimer de la version globale**.  
![\[Image : la boîte de navigation Clusters montrant la sélection d'un cluster secondaire existant et mettant en évidence l'action « Supprimer du cluster global ».\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/remove-global.png)

1. Une invite s'affichera, vous demandant de confirmer que vous souhaitez détacher le secondaire du cluster global. Choisissez **Supprimer et promouvoir** pour supprimer le cluster du cluster global.  
![\[Image : l'invite de suppression et de promotion.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/remove-promote.png)

Désormais, ce cluster ne sert plus de cluster secondaire et n'est plus synchronisé avec le cluster principal. Il s'agit d'un cluster autonome doté de read/write fonctionnalités complètes.

Après avoir dissocié ou supprimé les clusters secondaires, vous pouvez procéder de la même façon pour dissocier le cluster principal. Vous ne pouvez pas détacher ou supprimer le cluster principal du cluster global tant que vous n'avez pas supprimé tous les clusters secondaires. Le cluster global peut rester dans la liste des clusters, avec zéro région et AZs. Vous pouvez le supprimer si vous ne souhaitez plus utiliser ce cluster global.

------
#### [ Using the AWS CLI ]

Pour supprimer un cluster d'un cluster global, exécutez la commande `remove-from-global-cluster` CLI avec les paramètres suivants :
+ `--global-cluster-identifier`— Le nom (identifiant) de votre cluster mondial.
+ `--db-cluster-identifier`— Le nom de chaque cluster à supprimer du cluster global. 

Les exemples suivants suppriment d'abord un cluster secondaire, puis le cluster principal d'un cluster global.

Pour Linux, macOS ou Unix :

```
aws docdb --region secondary_region \
  remove-from-global-cluster \
    --db-cluster-identifier secondary_cluster_ARN \
    --global-cluster-identifier global_cluster_id

aws docdb --region primary_region \
  remove-from-global-cluster \
    --db-cluster-identifier primary_cluster_ARN \
    --global-cluster-identifier global_cluster_id
```

Répétez la `remove-from-global-cluster` `--db-cluster-identifier` `secondary_cluster_ARN` commande pour chaque région secondaire de votre cluster global.

Pour Windows :

```
aws docdb --region secondary_region ^
  remove-from-global-cluster ^
    --db-cluster-identifier secondary_cluster_ARN ^
    --global-cluster-identifier global_cluster_id

aws docdb --region primary_region ^
  remove-from-global-cluster ^
    --db-cluster-identifier primary_cluster_ARN ^
    --global-cluster-identifier global_cluster_id
```

Répétez la `remove-from-global-cluster` `--db-cluster-identifier` `secondary_cluster_ARN` commande pour chaque région secondaire de votre cluster global.

------

## Supprimer un cluster d'un cluster global Amazon DocumentDB
<a name="global-clusters.delete"></a>

Pour supprimer un cluster global, procédez comme suit :
+ Supprimez tous les clusters secondaires du cluster global. Chaque cluster devient un cluster autonome. Voir la section précédente,[Supprimer un cluster d'un cluster global Amazon DocumentDB](#global-clusters.remove).
+ Dans chaque cluster autonome, supprimez toutes les répliques.
+ Supprimez le cluster principal du cluster global. Cela devient un cluster autonome.
+ Dans le cluster principal, supprimez d'abord toutes les répliques, puis supprimez l'instance principale. La suppression de l'instance principale du nouveau cluster autonome entraîne généralement la suppression à la fois du cluster et du cluster global.

------
#### [ Using the AWS Management Console ]

1. Connectez-vous à la console Amazon DocumentDB AWS Management Console et accédez à celle-ci.

1. Choisissez **Clusters** et recherchez le cluster global que vous souhaitez supprimer.  
![\[Image : la boîte de navigation Clusters affichant une liste des liens de clusters existants et leurs liens d'instance correspondants.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/choose-cluster.png)

1. Une fois votre cluster global sélectionné, choisissez **Supprimer** dans le menu **Actions**.  
![\[Image : la boîte de navigation Clusters montrant la sélection d'un cluster global et mettant en évidence l'action « Supprimer ».\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/global-clusters/delete-cluster.png)

Vérifiez que tous les clusters sont supprimés du cluster global. Le cluster mondial ne doit afficher aucune région AZs et une taille de zéro cluster. Si le cluster global contient des clusters, vous ne pouvez pas encore le supprimer. Vous devez d'abord suivre les instructions de l'étape précédente, **[Supprimer un cluster d'un cluster global Amazon DocumentDB](#global-clusters.remove)**.

------
#### [ Using the AWS CLI ]

Pour supprimer un cluster global, exécutez la commande `delete-global-cluster` CLI avec le nom Région AWS et l'identifiant du cluster global, comme indiqué dans l'exemple suivant.

Pour Linux, macOS ou Unix :

```
aws docdb --region primary_region delete-global-cluster \
   --global-cluster-identifier global_cluster_id
```

Pour Windows :

```
aws docdb --region primary_region delete-global-cluster ^
   --global-cluster-identifier global_cluster_id
```

------

## Création d'un cluster Amazon DocumentDB sans tête dans une région secondaire
<a name="global-clusters.headless"></a>

Bien qu'un cluster global Amazon DocumentDB nécessite au moins un cluster secondaire différent Région AWS du cluster principal, vous pouvez utiliser une configuration headless pour le cluster secondaire. Un cluster Amazon DocumentDB secondaire sans tête est un cluster sans instance. Ce type de configuration permet de réduire les dépenses d'un cluster global. Dans un cluster Amazon DocumentDB, le calcul et le stockage sont découplés. Sans l'instance, le calcul ne vous est pas facturé, uniquement le stockage. S'il est correctement configuré, le volume de stockage d'un périphérique secondaire sans tête est maintenu synchronisé avec le cluster principal. 

Vous ajoutez le cluster secondaire comme vous le faites habituellement lors de la création d'un cluster global Amazon DocumentDB. Toutefois, une fois que le cluster principal a commencé la réplication vers le cluster secondaire, vous supprimez l'instance en lecture seule du cluster secondaire. Ce cluster secondaire est désormais considéré comme « sans tête » car il ne possède plus d'instance. Cependant, le volume de stockage reste synchronisé avec le cluster Amazon DocumentDB principal. 

**Important**  
Nous recommandons uniquement les clusters headless aux clients qui peuvent tolérer des pannes régionales pendant plus de 15 minutes. En effet, la restauration après une défaillance régionale avec un cluster secondaire sans tête obligera l'utilisateur à créer une nouvelle instance après le basculement. La disponibilité d'une nouvelle instance peut prendre environ 10 à 15 minutes.

### Comment ajouter un cluster secondaire sans tête à votre cluster mondial
<a name="w2aac33b9c13c17b9"></a>

1. Connectez-vous à la console [Amazon DocumentDB AWS Management Console](https://console.aws.amazon.com/rds/) et ouvrez-la.

1. Choisissez **Clusters** dans la barre de navigation de gauche. 

1. Choisissez le cluster global qui a besoin d'un cluster secondaire. Assurez-vous que le cluster principal est`Available`. 

1. Pour **Actions**, choisissez **Add region (Ajouter une région)**.

1. Sur la page **Ajouter une région**, choisissez la région secondaire.
**Note**  
Vous ne pouvez pas choisir une région qui possède déjà un cluster secondaire pour le même cluster mondial. De plus, il ne peut pas s'agir de la même région que le cluster principal. 

1. Complétez les champs restants pour le cluster secondaire dans la nouvelle région. Il s'agit des mêmes options de configuration que pour n'importe quelle instance de cluster. 

1. Ajoutez une région. Une fois que vous avez terminé d'ajouter la région à votre cluster mondial, vous la verrez `Clusters` dans la liste du AWS Management Console. 

1. Vérifiez l'état du cluster secondaire et de son instance de lecteur avant de continuer, en utilisant le AWS Management Console ou le AWS CLI. Voici un exemple de commande si vous utilisez AWS CLI : 

   ```
   $ aws docdb describe-db-clusters --db-cluster-identifier secondary-cluster-id --query '*[].[Status]' --output text
   ```

   Plusieurs minutes peuvent être nécessaires pour que le statut d'un cluster secondaire récemment ajouté passe de « création » à « disponible ». Lorsque le cluster est disponible, vous pouvez supprimer l'instance de lecteur. 

1. Sélectionnez l'instance de lecteur dans le cluster secondaire, puis choisissez **Supprimer**. 

1. Après avoir supprimé l'instance de lecteur, le cluster secondaire fait toujours partie du cluster global. Aucune instance ne doit lui être associée.

**Note**  
Vous pouvez utiliser ce cluster Amazon DocumentDB secondaire sans tête pour récupérer manuellement votre cluster global Amazon DocumentDB suite à une panne imprévue dans la région principale si une telle panne se produit. 

# Connectez-vous à un cluster global Amazon DocumentDB
<a name="global-clusters-connect"></a>

La façon dont vous vous connectez à un cluster global varie selon que vous devez écrire dans le cluster ou lire depuis le cluster :
+ Pour les demandes ou requêtes en lecture seule, vous vous connectez au point de terminaison du lecteur pour le cluster de votre. Région AWS
+ Pour exécuter des instructions DML ou DDL, vous vous connectez au point de terminaison de cluster du cluster principal. Ce point de terminaison se trouve peut-être dans une autre application Région AWS que celle de votre application.

Lorsque vous visualisez un cluster global dans la console, vous pouvez voir tous les points de terminaison à usage général associés à tous ses clusters.

La façon dont vous vous connectez à un cluster global dépend de la nécessité d'écrire dans la base de données ou de lire des informations dans la base de données. Pour les opérations DDL, DML et de lecture que vous souhaitez effectuer depuis la région principale, vous devez vous connecter à votre cluster principal. Nous vous recommandons de vous connecter à votre cluster principal en utilisant le point de terminaison du cluster en mode Replica Set, avec une préférence de lecture de`secondaryPreferred=true`. Cela acheminera le trafic d'écriture vers l'instance d'écriture de votre cluster principal et le trafic de lecture vers l'instance de réplique de votre cluster principal.

Pour le trafic interrégional en lecture seule, vous devez vous connecter à l'un de vos clusters secondaires. Nous vous recommandons de vous connecter à votre cluster secondaire en utilisant le point de terminaison du cluster en mode Replica Set. Comme toutes les instances sont des instances de réplication en lecture seule, il n'est pas nécessaire de spécifier de préférence de lecture. Pour minimiser la latence, choisissez le point de terminaison du lecteur situé dans votre région ou dans la région la plus proche de chez vous.

# Surveillance des clusters globaux Amazon DocumentDB
<a name="global-clusters-monitor"></a>

Amazon DocumentDB (compatible avec MongoDB) s'intègre CloudWatch afin que vous puissiez collecter et analyser les métriques opérationnelles de vos clusters. Vous pouvez surveiller ces métriques à l'aide de la CloudWatch console, de la console Amazon DocumentDB, du AWS Command Line Interface (AWS CLI) ou de l' CloudWatch API.

Pour surveiller un cluster global, utilisez les CloudWatch mesures suivantes.


| Métrique | Description | 
| --- | --- | 
| GlobalClusterReplicatedWriteIO | Nombre moyen d' I/O opérations d'écriture facturées répliquées depuis le volume de cluster du volume principal Région AWS vers le volume de cluster du volume secondaire Région AWS, indiqué à intervalles de 5 minutes. Le nombre de réplications dans ReplicatedWriteIOs chaque région secondaire est le même que le nombre de réplications VolumeWriteIOPs effectuées dans la région par la région principale. | 
| GlobalClusterDataTransferBytes | La quantité de données transférée du cluster principal Région AWS vers le cluster secondaire est Région AWS mesurée en octets. | 
| GlobalClusterReplicationLag | Le délai, en millisecondes, lors de la réplication des événements de changement du cluster principal Région AWS vers celui d'un cluster secondaire Région AWS | 

Pour plus d'informations sur la façon de consulter ces statistiques, consultez la section [Affichage CloudWatch des données](https://docs.aws.amazon.com/documentdb/latest/developerguide/cloud_watch.html#cloud_watch-view_data).

# Reprise après sinistre et clusters globaux Amazon DocumentDB
<a name="global-clusters-disaster-recovery"></a>

**Topics**
+ [Réalisation d'un basculement géré pour un cluster global Amazon DocumentDB](#managed-failover)
+ [Réalisation d'un basculement manuel pour un cluster global Amazon DocumentDB](#manual-failover)
+ [Exécution d'une commutation pour un cluster global Amazon DocumentDB](#global-cluster-switchover)
+ [Déblocage d'un basculement ou d'un basculement d'un cluster global](#unblocking-gc-so-fo)

En utilisant un cluster mondial, vous pouvez vous remettre rapidement après des catastrophes telles que des défaillances régionales. La reprise après sinistre est généralement mesurée à l'aide de valeurs RTO et RPO.
+ **Objectif de délai de reprise (RTO)** : temps nécessaire à un système pour revenir à un état de fonctionnement normal après un sinistre. En d’autres termes, le RTO mesure les temps d’arrêt. Pour un cluster mondial, RTO en quelques minutes.
+ **Objectif de point de reprise (RPO)** : quantité de données pouvant être perdues (mesurée dans le temps). Pour un cluster mondial, le RPO est généralement mesuré en secondes. 
+ Pour récupérer après une panne imprévue, vous pouvez effectuer un basculement entre régions vers l'un des secondaires de votre cluster mondial. Lorsque votre cluster mondial comporte plusieurs régions secondaires, assurez-vous de dissocier toutes les régions secondaires que vous souhaitez promouvoir en tant que régions principales. Ensuite, vous promouvez l'une de ces régions secondaires comme nouvelle région principale Région AWS. Enfin, vous créez de nouveaux clusters dans chacune des autres régions secondaires et vous attachez ces clusters à votre cluster global.

## Réalisation d'un basculement géré pour un cluster global Amazon DocumentDB
<a name="managed-failover"></a>

Cette approche vise à assurer la continuité des activités dans le cas d’une véritable catastrophe régionale ou interruption complète du niveau de service.

Lors d'un basculement géré, votre cluster principal est transféré vers la région secondaire de votre choix tandis que la topologie de réplication existante de votre cluster global Amazon DocumentDB est conservée. Le cluster secondaire choisi promeut l’un de ses nœuds en lecture seule au statut d’enregistreur complet. Cette étape permet au cluster d’endosser le rôle de cluster principal. Votre base de données est indisponible pendant une courte période pendant que ce cluster endosse son nouveau rôle. Les données qui n'ont pas été répliquées de l'ancien cluster principal vers le cluster secondaire choisi peuvent être manquantes lorsque ce cluster secondaire devient le nouveau cluster principal. L'ancien volume principal fait de son mieux pour prendre un instantané avant de se synchroniser avec le nouveau volume principal afin que les données non répliquées soient préservées sur le cliché.

**Note**  
Vous ne pouvez effectuer un basculement de cluster interrégional géré sur un cluster global Amazon DocumentDB que si le cluster principal et tous les clusters secondaires possèdent les mêmes versions de moteur. Si les versions de votre moteur sont incompatibles, vous pouvez effectuer le basculement manuellement en suivant les étapes décrites dans [Réalisation d'un basculement manuel pour un cluster global Amazon DocumentDB](#manual-failover).  
Si les versions des moteurs de la région ne correspondent pas, le basculement sera bloqué. Vérifiez les mises à niveau en attente et appliquez-les pour vous assurer que les versions du moteur de toutes les régions correspondent et que le basculement du cluster mondial est débloqué. Pour de plus amples informations, veuillez consulter [Déblocage d'un basculement ou d'un basculement d'un cluster global](#unblocking-gc-so-fo).

Pour minimiser les pertes de données, nous vous recommandons de prendre les mesures suivantes avant d'utiliser cette fonctionnalité :
+ Mettez les applications hors ligne pour empêcher l'envoi d'écritures vers le cluster principal du cluster global Amazon DocumentDB.
+ Vérifiez les temps de latence pour tous les clusters secondaires Amazon DocumentDB. Le choix de la région secondaire présentant le retard de réplication minimum peut minimiser les pertes de données avec la région principale actuellement défaillante. Vérifiez les temps de latence de tous les clusters secondaires Amazon DocumentDB du cluster global en consultant la `GlobalClusterReplicationLag` métrique sur Amazon. CloudWatch Ces mesures indiquent le retard (en millisecondes) entre la réplication vers un cluster secondaire et le cluster principal.

  Pour plus d'informations sur CloudWatch les métriques pour Amazon DocumentDB, consultez. [Métriques Amazon DocumentDB](cloud_watch.md#cloud_watch-metrics_list)

Lors d'un basculement géré, le cluster secondaire choisi est promu à son nouveau rôle principal. Cependant, il n'hérite pas des différentes options de configuration du cluster principal. Une incompatibilité de configuration peut provoquer des problèmes de performances, des incompatibilités de charge de travail et d’autres comportements anormaux. Pour éviter de tels problèmes, nous vous recommandons de résoudre les différences entre vos clusters globaux Amazon DocumentDB pour ce qui suit :
+ **Configurez un groupe de paramètres de cluster Amazon DocumentDB pour le nouveau cluster principal, si nécessaire**. Vous pouvez configurer vos groupes de paramètres de cluster Amazon DocumentDB indépendamment pour chaque cluster de votre cluster global Amazon DocumentDB. Par conséquent, lorsque vous promouvez un cluster secondaire pour qu'il prenne le rôle principal, le groupe de paramètres du cluster secondaire peut être configuré différemment de celui du cluster principal. Si tel est le cas, modifiez le groupe de paramètres du cluster secondaire promu pour qu'il soit conforme aux paramètres de votre cluster principal. Pour savoir comment procéder, consultez [Modification des groupes de paramètres du cluster Amazon DocumentDB](cluster_parameter_groups-modify.md).
+ **Configurer les outils et les options de surveillance, tels que les CloudWatch événements et les alarmes Amazon** : configurez le cluster promu avec la même capacité de journalisation, les mêmes alarmes, etc. que celles nécessaires pour le cluster global. Comme pour les groupes de paramètres, la configuration de ces fonctionnalités n’est pas héritée du cluster principal durant le processus de basculement. Certaines CloudWatch mesures, telles que le délai de réplication, ne sont disponibles que pour les régions secondaires. Ainsi, un basculement modifie la façon d’afficher ces métriques et de définir des alarmes sur celles-ci, et peut nécessiter d’apporter des modifications à des tableaux de bord prédéfinis. Pour plus d'informations sur les clusters et la surveillance Amazon DocumentDB, consultez. [Surveillance d'Amazon DocumentDB](monitoring_docdb.md)

Généralement, le cluster secondaire choisi assume le rôle principal en une minute. Dès que le nœud d'enregistreur de la nouvelle région principale est disponible, vous pouvez y connecter vos applications et reprendre vos charges de travail. Une fois qu'Amazon DocumentDB a fait la promotion du nouveau cluster principal, il reconstruit automatiquement tous les clusters de régions secondaires supplémentaires.

Étant donné que les clusters globaux Amazon DocumentDB utilisent la réplication asynchrone, le délai de réplication dans chaque région secondaire peut varier. Amazon DocumentDB reconstruit ces régions secondaires pour qu'elles disposent exactement des mêmes point-in-time données que le nouveau cluster de régions principal. La durée de la tâche de reconstruction complète peut prendre de quelques minutes à plusieurs heures, selon la taille du volume de stockage et la distance entre les régions. Lorsque les clusters des régions secondaires ont fini de se reconstruire à partir de la nouvelle région principale, ils sont disponibles pour un accès en lecture. Dès que le nouveau rédacteur principal est promu et disponible, le cluster de la nouvelle région principale peut gérer les opérations de lecture et d'écriture pour le cluster global Amazon DocumentDB.

Pour restaurer la topologie d'origine du cluster global, Amazon DocumentDB surveille la disponibilité de l'ancienne région principale. Dès que cette région est saine et à nouveau disponible, Amazon DocumentDB l'ajoute automatiquement au cluster global en tant que région secondaire. Avant de créer le nouveau volume de stockage dans l'ancienne région principale, Amazon DocumentDB essaie de prendre un instantané de l'ancien volume de stockage au point de défaillance. Il le fait pour que vous puissiez l’utiliser pour récupérer les données manquantes. Si cette opération aboutit, Amazon DocumentDB place cet instantané nommé « rds : docdb-unplanned-global-failover - name-of-old-primary -DB-Cluster-Timestamp » dans la section des instantanés du. AWS Management Console Vous pouvez également voir cet instantané répertorié dans les informations renvoyées par l'opération `DescribeDBClusterSnapshots` d'API.

**Note**  
L’instantané de l’ancien volume de stockage est un instantané du système soumis à la période de conservation des sauvegardes configurée sur l’ancien cluster principal. Pour conserver cet instantané en dehors de la période de conservation, vous pouvez le copier pour l’enregistrer en tant qu’instantané manuel. Pour en savoir plus sur la copie des instantanés, y compris la tarification, consultez [Copier un instantané de cluster](backup_restore-copy_cluster_snapshot.md#backup_restore-copy_a_cluster_snapshot).

Une fois la topologie d'origine restaurée, vous pouvez rétablir votre cluster global dans la région principale d'origine en effectuant une opération de commutation au moment le plus approprié pour votre activité et votre charge de travail. Pour ce faire, suivez les étapes de [Exécution d'une commutation pour un cluster global Amazon DocumentDB](#global-cluster-switchover).

Vous pouvez basculer sur votre cluster global Amazon DocumentDB à l'aide de l' AWS Management Console API Amazon DocumentDB ou de l' AWS CLI API Amazon DocumentDB.

------
#### [ Using the AWS Management Console ]

**Effectuez un basculement géré sur votre cluster global Amazon DocumentDB**

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

1. Dans le panneau de navigation, choisissez **Clusters**.

1. Recherchez et choisissez le cluster global Amazon DocumentDB sur lequel vous souhaitez basculer.  
![\[Image : table de clusters avec cluster global sélectionné.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/failover-cluster-table.png)

1. **Choisissez **Switchover ou Failover** dans le menu Actions.**

1. Dans la boîte de dialogue qui apparaît, choisissez **Failover**, puis choisissez le cluster secondaire dans la liste déroulante du champ **Nouveau cluster principal**.  
![\[Image : boîte de dialogue de basculement ou de basculement global du cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/switch-fail-confirm.png)

1. Tapez « confirmer » dans le dernier champ. Ensuite, choisissez **Valider**.

   L'état du cluster principal passe à « **Basculement ».** Cette condition devrait prendre environ une minute. Pendant ce temps, l'état du nouveau cluster principal indique « **Modification...** «. Une fois que le nouveau serveur principal sera promu, il affichera « **Disponible** » et pourra servir les transactions en lecture et en écriture. Les régions secondaires, y compris l'ancienne région principale, afficheront « **Resynchronisation...** « pendant qu'il se resynchronise avec le nouveau primaire. Comme le nouveau serveur principal, il ne sera en mesure de traiter les transactions que lorsque le statut deviendra « **Disponible** ».

1. Une fois terminé, le cluster principal d'origine devient le cluster secondaire. Le cluster secondaire sélectionné devient le cluster principal.  
![\[Image : Tableau des clusters montrant le nouveau cluster principal.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/failover-complete.png)

------
#### [ Using the AWS CLI ]

**Effectuez un basculement géré sur votre cluster global Amazon DocumentDB**

Exécutez la commande [https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/failover-global-cluster.html](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/failover-global-cluster.html)CLI pour basculer sur votre cluster global Amazon DocumentDB. À l'aide de la commande, transmettez les valeurs des options suivantes :
+ `--region`
+ `--global-cluster-identifier`
+ `--target-db-cluster-identifier`
+ `--allow-data-loss`

Dans les exemples suivants, remplacez chacun *user input placeholder* par les informations de votre cluster.

Pour Linux, macOS ou Unix :

```
aws docdb failover-global-cluster \
   --region region_of_selected_secondary \
   --global-cluster-identifier global_cluster_id \
   --target-db-cluster-identifier arn_of_secondary_to_promote \
   --allow-data-loss
```

Pour Windows :

```
aws docdb failover-global-cluster ^
   --region region_of_selected_secondary ^
   --global-cluster-identifier global_cluster_id ^
   --target-db-cluster-identifier arn_of_secondary_to_promote ^
   --allow-data-loss
```

------

## Réalisation d'un basculement manuel pour un cluster global Amazon DocumentDB
<a name="manual-failover"></a>

Si un cluster entier dans un cluster Région AWS devient indisponible, vous pouvez promouvoir une read/write fonctionnalité dans un autre cluster du cluster global.

Vous pouvez activer manuellement le mécanisme de basculement global du cluster s'il Région AWS est préférable de choisir un cluster situé dans un autre cluster comme cluster principal. Par exemple, vous pouvez accroître la capacité de l'un des clusters secondaires, puis le promouvoir comme cluster principal. L'équilibre des activités entre eux Régions AWS peut également changer, de sorte que le fait de passer du cluster principal à un autre Région AWS peut réduire le temps de latence pour les opérations d'écriture.

La procédure suivante décrit la procédure à suivre pour promouvoir l'un des clusters secondaires d'un cluster global Amazon DocumentDB.

Pour promouvoir un cluster secondaire :

1. Arrêtez d'émettre des instructions DML et d'autres opérations d'écriture sur le cluster principal en cas Région AWS de panne.

1. Identifiez un cluster à partir d'un cluster secondaire Région AWS à utiliser comme nouveau cluster principal. Si vous en avez deux (ou plus) Régions AWS dans votre cluster global, choisissez le cluster secondaire qui présente le moins de temps de latence.

1. Détachez le cluster secondaire que vous avez choisi du cluster global.

   La suppression d'un cluster secondaire d'un cluster global arrête immédiatement la réplication du cluster principal vers ce cluster secondaire et en fait un cluster provisionné autonome doté de fonctionnalités complètes read/write . Tout autre cluster secondaire associé au cluster principal dans la région touchée par la panne est toujours disponible et peut accepter les appels de votre application. Ils consomment également des ressources. Puisque vous recréez le cluster global, pour éviter les problèmes liés au split brain et à d'autres problèmes, supprimez les autres clusters secondaires avant de créer le nouveau cluster global en suivant les étapes ci-dessous.

   Afin d’obtenir les étapes détaillées du détachement, consultez [Supprimer un cluster d'un cluster global Amazon DocumentDB](global-clusters.manage.md#global-clusters.remove).

1. Ce cluster devient le cluster principal d'un nouveau cluster mondial lorsque vous commencez à y ajouter des régions, à l'étape suivante.

1. Ajoutez un Région AWS au cluster. Lorsque vous effectuez cette opération, le processus de réplication du cluster primaire vers le cluster secondaire commence.

1. Ajoutez-en Régions AWS d'autres si nécessaire pour recréer la topologie requise pour prendre en charge votre application. Assurez-vous que les écritures de l'application sont envoyées au cluster approprié avant, pendant et après de telles modifications, afin d'éviter les incohérences de données entre les clusters du cluster global (problèmes liés au split brain).

1. Lorsque la panne est résolue et que vous êtes prêt à réattribuer votre cluster d'origine Région AWS comme cluster principal, effectuez les mêmes étapes dans le sens inverse.

1. Supprimez l'un des clusters secondaires du cluster global. Cela lui permettra de desservir read/write le trafic. 

1. Redirigez tout le trafic d'écriture vers le cluster principal dans l'original Région AWS.

1. Ajoutez un Région AWS pour configurer un ou plusieurs clusters secondaires de la même manière Région AWS que précédemment.

Les clusters globaux Amazon DocumentDB peuvent être gérés à l'aide AWS SDKs de ce qui vous permet de créer des solutions pour automatiser le processus de basculement des clusters mondiaux pour les cas d'utilisation liés à la reprise après sinistre et à la planification de la continuité des activités. L'une de ces solutions est mise à la disposition de nos clients sous licence Apache 2.0 et est accessible depuis notre référentiel d'outils [ici](https://github.com/awslabs/amazon-documentdb-tools/tree/master/global-clusters-automation). Cette solution utilise Amazon Route 53 pour la gestion des terminaux et fournit des AWS Lambda fonctions qui peuvent être déclenchées en fonction d'événements appropriés.

## Exécution d'une commutation pour un cluster global Amazon DocumentDB
<a name="global-cluster-switchover"></a>

En utilisant les bascules, vous pouvez modifier de façon routinière la région de votre cluster principal. Cette approche est destinée aux scénarios contrôlés tels que la maintenance opérationnelle et d’autres procédures opérationnelles planifiées.

Il existe trois cas d'utilisation courants pour l'utilisation des commutateurs :
+ Pour les exigences de « rotation régionale » imposées à des secteurs spécifiques. Par exemple, la réglementation des services financiers peut exiger que les systèmes de niveau 0 passent à une autre région pendant plusieurs mois afin de garantir que les procédures de reprise après sinistre sont régulièrement mises à l’épreuve.
+ Pour les applications « follow-the-sun » multirégionales. Par exemple, une entreprise peut souhaiter fournir une latence d’écriture plus faible dans différentes régions en fonction des heures d’ouverture dans différents fuseaux horaires.
+ Comme zero-data-loss méthode pour revenir à la région principale d'origine après un basculement.

**Note**  
Les switchovers sont conçus pour être utilisés sur un cluster global Amazon DocumentDB sain. Pour récupérer après une panne imprévue, suivez la procédure appropriée dans [Réalisation d'un basculement manuel pour un cluster global Amazon DocumentDB](#manual-failover).  
Pour effectuer une commutation, toutes les régions secondaires doivent exécuter exactement la même version de moteur que la région principale. Si les versions des moteurs de la région ne correspondent pas, le passage au numérique sera bloqué. Vérifiez les mises à niveau en attente et appliquez-les pour vous assurer que les versions du moteur de toutes les régions correspondent et que le passage au cluster mondial est débloqué. Pour de plus amples informations, veuillez consulter [Déblocage d'un basculement ou d'un basculement d'un cluster global](#unblocking-gc-so-fo).

Lors d'un changement, Amazon DocumentDB fait passer votre cluster principal à la région secondaire de votre choix tout en conservant la topologie de réplication existante de votre cluster global. Avant de démarrer le processus de transition, Amazon DocumentDB attend que tous les clusters de régions secondaires soient entièrement synchronisés avec le cluster de régions principal. Ensuite, le cluster de bases de données de la région principale passe en lecture seule et le cluster secondaire choisi promeut l'un de ses nœuds en lecture seule au statut d'enregistreur à part entière. La promotion de ce nœud au rang d'enregistreur permet à ce cluster secondaire d'endosser le rôle de cluster principal. Comme tous les clusters secondaires étaient synchronisés avec le cluster principal au début du processus, le nouveau cluster principal poursuit les opérations du cluster global Amazon DocumentDB sans perdre de données. Votre base de données est indisponible pendant une courte période durant laquelle les clusters principaux et secondaires sélectionnés endossent leurs nouveaux rôles.

Pour optimiser la disponibilité des applications, nous vous recommandons d’effectuer les opérations suivantes avant d’utiliser cette fonctionnalité :
+ Effectuez cette opération en dehors des heures de pointe ou à un autre moment lorsque les écritures sur le cluster principal sont minimes.
+ Mettez les applications hors ligne pour empêcher l'envoi d'écritures vers le cluster principal du cluster global Amazon DocumentDB.
+ Vérifiez les temps de latence de tous les clusters secondaires Amazon DocumentDB du cluster global en consultant la `GlobalClusterReplicationLag` métrique sur Amazon. CloudWatch Cette métrique indique le retard (en millisecondes) entre la réplication vers un cluster secondaire et le cluster principal. Cette valeur est directement proportionnelle au temps nécessaire à Amazon DocumentDB pour effectuer le basculement. Par conséquent, plus la valeur de retard est élevée, plus la bascule prendra de temps.

  Pour plus d'informations sur CloudWatch les métriques pour Amazon DocumentDB, consultez. [Métriques Amazon DocumentDB](cloud_watch.md#cloud_watch-metrics_list)

Au cours d'une commutation, le cluster de bases de données secondaire choisi est promu dans son nouveau rôle de cluster principal. Toutefois, il n’hérite pas des différentes options de configuration du cluster de bases de données principal. Une incompatibilité de configuration peut provoquer des problèmes de performances, des incompatibilités de charge de travail et d’autres comportements anormaux. Pour éviter de tels problèmes, nous vous recommandons de résoudre les différences entre vos clusters globaux Amazon DocumentDB pour ce qui suit :
+ **Configurez le groupe de paramètres de cluster Amazon DocumentDB pour le nouveau cluster principal, si nécessaire** — Vous pouvez configurer les groupes de paramètres de cluster Amazon DocumentDB indépendamment pour chaque cluster de votre cluster global Amazon DocumentDB. Cela signifie que lorsque vous promouvez un cluster de base de données secondaire pour endosser le rôle de cluster principal, le groupe de paramètres du cluster secondaire peut être configuré différemment de celui du principal. Si c'est le cas, modifiez le groupe de paramètres du cluster de base de données secondaire promu afin qu'il soit conforme aux paramètres de votre cluster principal. Pour savoir comment procéder, consultez [Gestion des groupes de paramètres du cluster Amazon DocumentDB](cluster_parameter_groups.md).
+ **Configurez les outils et options de surveillance, tels que les CloudWatch événements et les alarmes Amazon** : configurez le cluster promu avec la même capacité de journalisation, les mêmes alarmes, etc. que celles nécessaires pour le cluster global. Comme pour les groupes de paramètres, la configuration de ces fonctionnalités n’est pas héritée du cluster principal durant le processus de bascule. Certaines CloudWatch mesures, telles que le délai de réplication, ne sont disponibles que pour les régions principales. Ainsi, une bascule modifie la façon d’afficher ces métriques et de définir des alarmes associées, et peut nécessiter d’apporter des modifications à des tableaux de bord prédéfinis. Pour de plus amples informations, veuillez consulter [Surveillance d'Amazon DocumentDB](monitoring_docdb.md).

**Note**  
En général, la commutation de rôle peut prendre plusieurs minutes.

Une fois le processus de transition terminé, le cluster Amazon DocumentDB promu peut gérer les opérations d'écriture pour le cluster global.

Vous pouvez changer de cluster global Amazon DocumentDB en utilisant le AWS Management Console ou le : AWS CLI

------
#### [ Using the AWS Management Console ]

**Effectuez une commutation sur votre cluster global Amazon DocumentDB**

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

1. Dans le panneau de navigation, choisissez **Clusters**.

1. Recherchez et sélectionnez le cluster global Amazon DocumentDB que vous souhaitez transférer.  
![\[Image : table de clusters avec cluster global sélectionné.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/switchover-cluster-table.png)

1. **Choisissez **Switchover ou Failover** dans le menu Actions.**

1. Dans la boîte de dialogue qui apparaît, choisissez **Switchover**, puis choisissez le cluster secondaire dans la liste déroulante du champ **Nouveau cluster principal**.  
![\[Image : boîte de dialogue de commutation de cluster avec cluster secondaire sélectionné.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/switch-fail-confirm-2.png)

1. Choisissez **Confirmer**.

   L'état du cluster principal passe à « **Switching-over** ». Cette condition devrait prendre environ trois minutes. Pendant ce temps, l'état de tous les clusters régionaux indique « **Modification...** «. Une fois les régions synchronisées et le nouveau serveur principal promu, tous les champs de statut indiqueront « **Disponible** » et pourront traiter les transactions.

1. Une fois terminé, le cluster principal d'origine devient le cluster secondaire. Le cluster secondaire sélectionné devient le cluster principal.  
![\[Image : Tableau des clusters montrant le nouveau cluster principal.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/failover-complete.png)

------
#### [ Using the AWS CLI ]

**Effectuez une commutation sur votre cluster global Amazon DocumentDB**

Exécutez la commande [https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/switchover-global-cluster.html](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/switchover-global-cluster.html)CLI pour basculer entre votre cluster global Amazon DocumentDB. À l'aide de la commande, transmettez les valeurs des options suivantes :
+ `--region`
+ `--global-cluster-identifier`
+ `--target-db-cluster-identifier`

Dans les exemples suivants, remplacez chacun *user input placeholder* par les informations de votre cluster.

Pour Linux, macOS ou Unix :

```
aws docdb switchover-global-cluster \
   --region region_of_primary \
   --global-cluster-identifier global_cluster_id \
   --target-db-cluster-identifier arn_of_secondary_to_promote
```

Pour Windows :

```
aws docdb switchover-global-cluster ^
   --region region_of_primary ^
   --global-cluster-identifier global_cluster_id ^
   --target-db-cluster-identifier arn_of_secondary_to_promote
```

------

## Déblocage d'un basculement ou d'un basculement d'un cluster global
<a name="unblocking-gc-so-fo"></a>

Les basculements et les basculements de clusters globaux sont bloqués lorsque tous les clusters régionaux du cluster mondial ne sont pas équipés de la même version de moteur. Si les versions ne correspondent pas, cette erreur peut s'afficher en réponse lors de l'appel à un basculement ou à un basculement : le cluster de base de données cible spécifié exécute une version du moteur avec un niveau de correctif différent de celui du cluster de base de données source. Nous vous recommandons d'appliquer régulièrement les dernières versions du moteur afin de garantir que vous exécutez les dernières mises à jour afin de maintenir vos clusters globaux en bon état.

Pour résoudre cette erreur, veuillez d'abord mettre à jour toutes les régions secondaires, puis la région principale avec la même version du moteur en appliquant toutes les mesures de maintenance en attente. Pour consulter les actions de maintenance en attente et appliquer les modifications nécessaires pour corriger le problème, suivez les instructions figurant dans l'un des onglets suivants :

------
#### [ Using the AWS Management Console ]

Pour débloquer un basculement ou un basculement global de clusters, vous devez déterminer si des actions de maintenance sont en attente pour vos clusters et les appliquer. Pour afficher et appliquer les actions de maintenance, procédez comme suit :

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

1. Dans le panneau de navigation, choisissez **Clusters**.

1. Dans le tableau **Clusters**, localisez votre cluster global dans la colonne **Identifiant du cluster**. Dans votre cluster global, prenez note de chaque cluster secondaire et du cluster principal pour le cluster global donné, puis effectuez les étapes suivantes pour chacun d'eux.

1. Pour chaque cluster secondaire :

   1. Si une mise à jour est disponible pour votre cluster, elle est indiquée comme **Disponible**, **Obligatoire** ou **Fenêtre suivante** dans la colonne **Maintenance**.

   1. Pour effectuer une action, choisissez le cluster pour en afficher les détails, puis choisissez **Maintenance et sauvegardes**. Les éléments de **maintenance en attente** apparaissent.

   1. Sous **Description**, s'il est indiqué qu'une « nouvelle mise à jour de maintenance est disponible », sélectionnez-la, puis choisissez **Appliquer maintenant**.

1. Pour votre cluster principal :

   1. Si une mise à jour est disponible pour votre cluster, elle est indiquée comme **Disponible**, **Obligatoire** ou **Fenêtre suivante** dans la colonne **Maintenance**.

   1. Pour effectuer une action, choisissez le cluster pour en afficher les détails, puis choisissez **Maintenance et sauvegardes**. Les éléments de **maintenance en attente** apparaissent.

   1. Sous **Description**, s'il est indiqué qu'une « nouvelle mise à jour de maintenance est disponible », sélectionnez-la, puis choisissez **Appliquer maintenant**.

------
#### [ Using the AWS CLI ]

Pour débloquer un basculement ou un basculement global d'un cluster, vous devez déterminer si des actions de maintenance sont en attente pour le cluster et les appliquer. Procédez comme suit pour afficher et appliquer des actions de maintenance d'abord sur les clusters secondaires, puis sur le cluster principal de votre cluster global :

1. Exécutez d'abord ce qui suit sur le cluster régional de chaque région secondaire, puis pour le cluster régional des régions principales.

1. Exécutez la commande [https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html)CLI avec l'`--resource-identifier`option permettant de déterminer si des actions de maintenance sont disponibles pour votre cluster régional Amazon DocumentDB.

   Dans les exemples suivants, remplacez chacun *user input placeholder* par les informations de votre cluster.

   Pour Linux, macOS ou Unix :

   ```
   aws docdb describe-pending-maintenance-action \
      --resource-identifier arn:aws:rds:us-east-1:001234567890:cluster:docdb-2025-03-27-19-21-15
   ```

   Pour Windows :

   ```
   aws docdb describe-pending-maintenance-action ^
      --resource-identifier arn:aws:rds:us-east-1:001234567890:cluster:docdb-2025-03-27-19-21-15
   ```

   Le résultat ressemble à ceci :

   ```
   {
       "PendingMaintenanceActions": [
           {
               "ResourceIdentifier": "arn:aws:rds:us-east-1:001234567890:cluster:docdb-2025-03-27-19-21-15",
               "PendingMaintenanceActionDetails": [
                   {
                       "Action": "system-update",
                       "CurrentApplyDate": "2025-04-11T03:01:00Z",
                       "Description": "db-version-upgrade",
                       "ForcedApplyDate": "2025-06-18T03:01:00Z",
                       "AutoAppliedAfterDate": "2025-05-11T03:01:00Z"
                       "OptInStatus": "pending"
                   }
               ]
           }
       ]
   }
   ```

1. Si une action de maintenance est nécessaire, exécutez la commande [https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html)CLI avec les options suivantes :
   + `--resource-identifier`
   + `--apply-action`
   + `--opt-in-type`
   + `--region`

   Dans les exemples suivants, remplacez chacun *user input placeholder* par les informations de votre cluster.

   Pour Linux, macOS ou Unix :

   ```
   aws docdb apply-pending-maintenance-action \
      --resource-identifier arn:aws:rds:us-east-1:001234567890:cluster:docdb-2025-03-27-19-21-15 \
      --apply-action system-update \
      --opt-in-type immediate \
      --region us-east-1
   ```

   Pour Windows :

   ```
   aws docdb apply-pending-maintenance-action ^
      --resource-identifier arn:aws:rds:us-east-1:001234567890:cluster:docdb-2025-03-27-19-21-15 ^
      --apply-action system-update ^
      --opt-in-type immediate ^
      --region us-east-1
   ```

1. Une fois l'action de maintenance terminée, réexécutez la [https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html)commande pour vous assurer qu'aucune autre action n'est en attente pour votre cluster.

   Le résultat que vous souhaitez obtenir est le suivant :

   ```
   {
       "PendingMaintenanceActions": []
   }
   ```

------
#### [ Using the Amazon DocumentDB API ]

Pour débloquer un basculement ou un basculement global d'un cluster, vous devez déterminer si des actions de maintenance sont en attente pour le cluster et les appliquer. Utilisez ce qui suit APIs pour afficher et appliquer les actions de maintenance :

1. Exécutez d'abord ce qui suit sur le cluster régional de chaque région secondaire, puis pour le cluster régional des régions principales.

1. Appelez l'[https://docs.aws.amazon.com/documentdb/latest/developerguide/API_PendingMaintenanceAction.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_PendingMaintenanceAction.html)API pour déterminer si des actions de maintenance sont disponibles pour votre cluster global Amazon DocumentDB.

1. Appliquez les modifications en appelant l'[https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ApplyPendingMaintenanceAction.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ApplyPendingMaintenanceAction.html)API.

------

# Gestion des clusters Amazon DocumentDB
<a name="db-clusters"></a>

Pour gérer un cluster Amazon DocumentDB, vous devez disposer d'une politique IAM avec les autorisations appropriées du plan de contrôle Amazon DocumentDB. Ces autorisations vous permettent de créer, modifier et supprimer des instances et des clusters. La `AmazonDocDBFullAccess` politique fournit toutes les autorisations requises pour administrer un cluster Amazon DocumentDB. 

Les rubriques suivantes expliquent comment effectuer différentes tâches lorsque vous travaillez avec des clusters Amazon DocumentDB, notamment la création, la suppression, la modification, la connexion et l'affichage de clusters.

**Topics**
+ [Comprendre les clusters](db-clusters-understanding.md)
+ [Paramètres du cluster](db-cluster-parameters.md)
+ [Configurations de stockage en cluster](db-cluster-storage-configs.md)
+ [Déterminer le statut d'un cluster](db-cluster-status.md)
+ [Cycle de vie d'un cluster](db-cluster-life-cycle.md)
+ [Dimensionnement des clusters](db-cluster-manage-performance.md)
+ [Clonage d'un volume pour un cluster](db-cluster-cloning.md)
+ [Comprendre la tolérance aux pannes des clusters](db-cluster-fault-tolerance.md)

# Comprendre les clusters
<a name="db-clusters-understanding"></a>

Amazon DocumentDB sépare le calcul du stockage, et décharge la réplication et la sauvegarde des données vers le volume du cluster. Un volume de cluster fournit une couche de stockage durable, fiable et hautement disponible qui réplique les données de six façons dans trois zones de disponibilité. Les réplicas permettent une haute disponibilité des données et une mise à l'échelle en lecture. Chaque cluster peut redimensionner jusqu'à 15 répliques.


| Nom | Description | Opérations d'API (Verbes) | 
| --- | --- | --- | 
|  Cluster  |  Il se compose d'une ou de plusieurs instances, et d'un volume de stockage de clusters qui gère les données pour ces instances.  |  `create-db-cluster` `delete-db-cluster` `describe-db-clusters` `modify-db-cluster` | 
| Instance | La lecture et l'écriture de données sur le volume de stockage du cluster se font via des instances. Il existe deux types d'instances dans un cluster : une instance principale et un réplica. Un cluster possède toujours une instance principale et peut comporter de 0 à 15 répliques. |  `create-db-instance` `delete-db-instance` `describe-db-instances` `modify-db-instance` `describe-orderable-db-instance-options` `reboot-db-instance` | 
| Volume de cluster | un volume virtuel de stockage de base de données qui couvre trois zones de disponibilité, chacune d'entre elles ayant deux copies des données de cluster. | N/A | 
|  Instance principale  |  Prend en charge les opérations de lecture et d'écriture, et effectue toutes les modifications de données du volume de cluster. Chaque cluster possède une seule instance principale.  | N/A | 
|  Instance de réplica  |  Prend uniquement en charge les opérations de lecture. Chaque cluster Amazon DocumentDB peut comporter jusqu'à 15 instances de réplication en plus de l'instance principale. Plusieurs réplicas distribuent la charge de travail en lecture. En plaçant les réplicas dans des zones de disponibilité distinctes, vous pouvez aussi accroître la disponibilité de la base de données.  | N/A | 
|  Point de terminaison de cluster  |  Point de terminaison pour un cluster Amazon DocumentDB qui se connecte à l'instance principale actuelle du cluster. Chaque cluster Amazon DocumentDB possède un point de terminaison de cluster et une instance principale.  | N/A | 
|  Point de terminaison du lecteur  |  Point de terminaison pour un cluster Amazon DocumentDB qui se connecte à l'une des répliques disponibles pour ce cluster. Chaque cluster Amazon DocumentDB possède un point de terminaison lecteur. S'il existe plusieurs répliques, le point de terminaison du lecteur dirige chaque demande de connexion vers l'une des répliques Amazon DocumentDB.  | N/A | 
|  Point de terminaison d’instance  |  Point de terminaison pour une instance d'un cluster Amazon DocumentDB qui se connecte à une instance spécifique. Chaque instance d'un cluster, quel que soit le type d'instance, a son propre point de terminaison d'instance unique.  | N/A | 

# Paramètres du cluster Amazon DocumentDB
<a name="db-cluster-parameters"></a>

Lorsque vous créez ou modifier un cluster, il est important de comprendre quels paramètres sont immuables et lesquels sont modifiables, après la création du cluster. Le tableau suivant répertorie tous les paramètres qui sont spécifiques à un cluster. Comme indiqué dans le tableau, certains sont modifiables, d'autres ne le sont pas.

**Note**  
Ces paramètres ne doivent pas être confondus avec les groupes de paramètres du cluster Amazon DocumentDB et leurs paramètres. Pour plus d'informations sur les groupes de paramètres de cluster, consultez [Gestion des groupes de paramètres du cluster Amazon DocumentDB](cluster_parameter_groups.md). 


| Paramètre | Adaptabilité | Remarques | 
| --- | --- | --- | 
| DBClusterIdentifier | Oui |  Contraintes d'affectation de noms : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/db-cluster-parameters.html)  | 
| Engine | Non | Doit indiquer docdb. | 
| BackupRetentionPeriod | Oui | Doit être comprise entre 1 et 35 jours. | 
| DBClusterParameterGroupName | Oui |  Contraintes d'affectation de noms : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/db-cluster-parameters.html)  | 
| DBSubnetGroupName | Non | Une fois qu'un cluster a été créé, vous ne pouvez pas modifier son sous-réseau. | 
| EngineVersion | Non | La valeur peut être 5.0.0 (par défaut)4.0.0, ou3.6.0. | 
| KmsKeyId | Non | Si vous choisissez de chiffrer votre cluster, vous ne pouvez pas modifier la AWS KMS clé que vous avez utilisée pour chiffrer votre cluster. | 
| MasterUsername | Non |  Une fois qu'un cluster a été créé, vous ne pouvez pas modifier le `MasterUsername`. Contraintes d'affectation de noms : [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/db-cluster-parameters.html)  | 
| MasterUserPassword | Oui |  Contraintes: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/db-cluster-parameters.html)  | 
| Port | Oui | Le numéro de port s'applique à toutes les instances dans le cluster. | 
| PreferredBackupWindow | Oui |  | 
| PreferredMaintenanceWindow | Oui |  | 
| StorageEncrypted | Non | Si vous choisissez de chiffrer votre cluster, il ne peut pas être non chiffré. | 
| StorageType | Oui |  Type de stockage pour le cluster de base de données : Standard (`standard`) ou I/O-Optimized (`iopt1`). Valeur par défaut : `standard` Ce paramètre peut être configuré avec `CreateDBCluster` et`ModifyDBCluster`. Pour de plus amples informations, veuillez consulter [Configurations de stockage en cluster Amazon DocumentDB](db-cluster-storage-configs.md).  | 
| Tags | Oui |  | 
| VpcSecurityGroupIds | Non | Une fois qu'un cluster a été créé, vous ne pouvez pas modifier le VPC dans lequel réside le cluster. | 

# Configurations de stockage en cluster Amazon DocumentDB
<a name="db-cluster-storage-configs"></a>

À partir d'Amazon DocumentDB 5.0, les clusters basés sur des instances prennent en charge deux types de configuration de stockage :
+ **Stockage standard Amazon DocumentDB** : conçu pour les clients ayant une consommation faible à modérée I/O . Si vous pensez que vos I/O coûts seront inférieurs à 25 % de l'ensemble de votre cluster Amazon DocumentDB, cette option peut être idéale pour vous. Avec la configuration de stockage standard d'Amazon DocumentDB, vous êtes facturé sur une pay-per-request I/O base en plus des frais d'instance et de stockage. Cela signifie que votre facturation peut varier d'un cycle à l'autre en fonction de l'utilisation. La configuration est adaptée pour répondre aux I/O exigences fluctuantes de votre application.
+ **Stockage optimisé pour les E/S Amazon DocumentDB** : conçu pour les clients qui privilégient la prévisibilité des prix ou qui ont des applications intensives. I/O Les I/O-optimized configuration offers improved performance, increased throughput, and reduced latency for customers with I/O intensive workloads. If you expect your I/O costs to exceed 25% of your total Amazon DocumentDB cluster costs, this option offers enhanced price performance. With the Amazon DocumentDB I/O-optimized storage configuration, you won't be charged based on I/O opérations, garantissant des coûts prévisibles à chaque cycle de facturation. La configuration stabilise les coûts tout en améliorant les performances.

Vous pouvez passer de vos clusters de bases de données existants une fois tous les 30 jours à Amazon DocumentDB. L'I/O-optimized storage. You can switch back to Amazon DocumentDB standard storage at any time. The next date to modify the storage configuration to I/Ooptimisation peut être suivie à l'aide de la `describe-db-clusters` commande en utilisant AWS CLI ou via la page AWS Management Console de configuration du cluster.

Vous pouvez créer un nouveau cluster de bases de données incluant la configuration optimisée pour les E/S d'Amazon DocumentDB ou convertir vos clusters de bases de données existants en quelques clics [AWS Management Console](https://console.aws.amazon.com/docdb/), en modifiant un seul paramètre dans le [AWS Command Line Interface (AWS CLI)](https://aws.amazon.com/cli/) ou via. [AWS SDKs](https://aws.amazon.com/developer/tools/) Aucune interruption de service ou aucun redémarrage des instances n'est requis pendant ou après la modification de la configuration du stockage.

![\[Image : tableau décrivant les différences entre le stockage standard Amazon DocumentDB et le stockage optimisé.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/io-diagram-1.png)


## Création d'un cluster optimisé pour les E/S
<a name="w2aac33c11c13c15"></a>



------
#### [ Using the AWS Management Console ]

Pour créer ou modifier un cluster optimisé pour les E/S à l'aide de : AWS Management Console

1. **Sur la console de gestion Amazon DocumentDB, sous **Clusters**, choisissez **Create** ou sélectionnez le cluster et choisissez **Actions**, puis choisissez Modify.**

1. Si vous créez un nouveau cluster, assurez-vous de choisir Cluster **basé sur une instance** dans la section **Type de cluster** (il s'agit de l'option par défaut).  
![\[Image : capture d'écran de console des options de type de cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/create-cluster/cc-type.png)

1. Dans la section **Configuration**, sous **Configuration du stockage en cluster**, choisissez **Amazon DocumentDB** I/O-Optimized.  
![\[Image : capture d'écran de console des options de configuration du stockage en cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/storage-config-1.png)

1. Terminez la création ou la modification de votre cluster et choisissez **Créer un cluster** ou **Modifier le cluster**.

   Pour le processus complet de création d'un cluster, voir[Création d'un cluster et d'une instance principale à l'aide du AWS Management Console](db-cluster-create.md#db-cluster-create-con).

   Pour le processus complet de modification du cluster, voir[Modification d'un cluster Amazon DocumentDB](db-cluster-modify.md).

------
#### [ Using the AWS CLI ]

Pour créer un cluster optimisé pour les E/S à l'aide de : AWS CLI

Dans les exemples suivants, remplacez chacune *user input placeholder* par vos propres informations.

Pour Linux, macOS ou Unix :

```
aws docdb create-db-cluster \
      --db-cluster-identifier sample-cluster \
      --engine docdb \
      --engine-version 5.0.0 \
      --storage-type iopt1 \
      --deletion-protection \
      --master-username username \
      --master-user-password password
```

Pour Windows :

```
aws docdb create-db-cluster ^
      --db-cluster-identifier sample-cluster ^
      --engine docdb ^
      --engine-version 5.0.0 ^
      --storage-type iopt1 ^
      --deletion-protection ^
      --master-username username ^
      --master-user-password password
```

------

## Analyse des coûts pour déterminer la configuration du stockage
<a name="w2aac33c11c13c17"></a>

Avec Amazon DocumentDB, vous avez la possibilité de choisir votre configuration de stockage pour chaque cluster de base de données dont vous disposez. Afin de répartir correctement vos clusters entre les clusters standard et les clusters optimisés pour les E/S, vous pouvez suivre vos coûts Amazon DocumentDB par cluster. Pour ce faire, vous pouvez ajouter des balises aux clusters existants, activer le balisage de répartition des coûts dans votre [AWS Billing and Cost Management tableau de bord](https://aws.amazon.com/pricing/) et analyser vos coûts pour un cluster donné dans le [AWS Cost Explorer Service](https://aws.amazon.com/aws-cost-management/aws-cost-explorer/). Pour plus d'informations sur l'analyse des coûts, consultez notre blog [Utilisation des balises de répartition des coûts](https://aws.amazon.com/blogs/database/using-cost-allocation-tags-with-amazon-documentdb-with-mongodb-compatibility/).

# Déterminer le statut d'un cluster
<a name="db-cluster-status"></a>

Vous pouvez déterminer le statut d'un cluster à l'aide du AWS Management Console ou AWS CLI.

------
#### [ Using the AWS Management Console ]

Utilisez la procédure suivante pour connaître l'état de votre cluster Amazon DocumentDB à l'aide du AWS Management Console

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

1. Dans le panneau de navigation, choisissez **Clusters**.

1. Dans la colonne **Identifiant de cluster**, recherchez le nom du cluster qui vous intéresse. Ensuite, pour trouver le statut du cluster, allez à la colonne **Status (Statut)**, comme indiqué ci-dessous.  
![\[Capture d'écran de la page des clusters avec un exemple de cluster montrant le statut actif.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cluster-status-con.png)

------
#### [ Using the AWS CLI ]

Utilisez l'`describe-db-clusters`opération pour connaître l'état de votre cluster Amazon DocumentDB à l'aide du. AWS CLI

Le code suivant trouve le statut du cluster `sample-cluster`.

Pour Linux, macOS ou Unix :

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

Pour Windows :

```
aws docdb describe-db-clusters ^
    --db-cluster-identifier sample-cluster  ^
    --query 'DBClusters[*].[DBClusterIdentifier,Status]'
```

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

```
[
    [
        "sample-cluster",
        "available"
    ]
]
```

------

# Cycle de vie du cluster Amazon DocumentDB
<a name="db-cluster-life-cycle"></a>

Le cycle de vie d'un cluster Amazon DocumentDB inclut la création, la description, la modification et la suppression du cluster. Cette section fournit des informations sur la façon de réaliser ces processus. 

**Topics**
+ [Création d’un cluster](db-cluster-create.md)
+ [Décrire les clusters](db-cluster-view-details.md)
+ [Modification d’un cluster](db-cluster-modify.md)
+ [Détermination de la maintenance en attente](db-cluster-determine-pending-maintenance.md)
+ [Correctif mettant à jour la version du moteur d'un cluster](db-cluster-version-upgrade.md)
+ [Arrêt et démarrage d’un cluster](db-cluster-stop-start.md)
+ [Suppression d’un cluster](db-cluster-delete.md)

# Création d'un cluster Amazon DocumentDB
<a name="db-cluster-create"></a>

Un cluster Amazon DocumentDB se compose d'instances et d'un volume de cluster qui représente les données du cluster. Le volume de cluster est répliqué six fois dans trois zones de disponibilité en tant que volume virtuel unique. Le cluster contient une instance principale et, éventuellement, jusqu'à 15 instances de réplica. 

Les sections suivantes montrent comment créer un cluster Amazon DocumentDB à l'aide du AWS Management Console ou du. AWS CLI Vous pouvez ensuite ajouter des instances de réplica pour ce cluster. Lorsque vous utilisez la console pour créer votre cluster Amazon DocumentDB, une instance principale est automatiquement créée pour vous en même temps. Si vous utilisez le AWS CLI pour créer votre cluster Amazon DocumentDB, une fois que l'état du cluster est *disponible*, vous devez créer l'instance principale pour ce cluster.

## Conditions préalables
<a name="db-cluster-create-prerequisites"></a>

Les conditions requises pour créer un cluster Amazon DocumentDB sont les suivantes.

Si vous n'en avez pas Compte AWS, procédez comme suit pour en créer un.

**Pour vous inscrire à un Compte AWS**

1. Ouvrez l'[https://portal.aws.amazon.com/billing/inscription.](https://portal.aws.amazon.com/billing/signup)

1. Suivez les instructions en ligne.

   Dans le cadre de la procédure d’inscription, vous recevrez un appel téléphonique ou un SMS et vous saisirez un code de vérification en utilisant le clavier numérique du téléphone.

   Lorsque vous vous inscrivez à un Compte AWS, un *Utilisateur racine d'un compte AWS*est créé. Par défaut, seul l’utilisateur racine a accès à l’ensemble des Services AWS et des ressources de ce compte. La meilleure pratique de sécurité consiste à attribuer un accès administratif à un utilisateur, et à utiliser uniquement l’utilisateur racine pour effectuer les [tâches nécessitant un accès utilisateur racine](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#root-user-tasks).

### Prérequis pour VPC
<a name="db-cluster-create-prerequisites-vpc"></a>

Vous ne pouvez créer un cluster Amazon DocumentDB que dans un Amazon Virtual Private Cloud (Amazon VPC). Votre Amazon VPC doit disposer d'au moins un sous-réseau dans chacune des deux zones de disponibilité au moins pour que vous puissiez l'utiliser avec un cluster Amazon DocumentDB. En répartissant vos instances de cluster entre les zones de disponibilité, vous vous assurez qu'elles sont disponibles dans votre cluster dans le cas peu probable d'une défaillance de la zone de disponibilité.

### Conditions requises pour les sous-réseaux
<a name="db-cluster-create-prerequisites-subnet-groups"></a>

Lorsque vous créez un cluster Amazon DocumentDB, vous devez choisir un VPC et le groupe de sous-réseaux correspondant au sein de ce VPC pour lancer votre cluster. Les sous-réseaux déterminent la zone de disponibilité et la plage d'adresses IP au sein de cette zone de disponibilité que vous souhaitez utiliser pour lancer une instance. Dans le cadre de cette présentation, nous utiliserons les termes *sous-réseau* et *zone de disponibilité* indifféremment. Un groupe de sous-réseaux est un ensemble nommé de sous-réseaux (ou de zones de disponibilité). Un groupe de sous-réseaux vous permet de spécifier les zones de disponibilité que vous souhaitez utiliser pour lancer des instances Amazon DocumentDB. Par exemple, dans un cluster avec trois instances et pour une haute disponibilité, il est recommandé que chacune de ces instances soit mise en service dans des zones de disponibilité distinctes. Par conséquent, si une zone de disponibilité s'arrête, cela affecte une seule instance.

Les instances Amazon DocumentDB peuvent actuellement être mises en service dans un maximum de trois zones de disponibilité. Même si un groupe de sous-réseaux possède plus de trois sous-réseaux, vous ne pouvez utiliser que trois de ces sous-réseaux pour créer un cluster Amazon DocumentDB. Par conséquent, lors de la création d'un groupe de sous-réseaux, il est recommandé de choisir les trois sous-réseaux sur lesquels vous souhaitez déployer vos instances. Dans l'est des États-Unis (Virginie du Nord), votre groupe de sous-réseaux peut comporter six sous-réseaux (ou zones de disponibilité). Toutefois, lorsqu'un cluster Amazon DocumentDB est provisionné, Amazon DocumentDB choisit trois de ces zones de disponibilité qu'il utilise pour provisionner les instances. 

Supposons, par exemple, que lorsque vous créez un cluster, Amazon DocumentDB choisisse les zones de disponibilité \$11A, 1B et 1C\$1. Si vous essayez de créer une instance dans la zone de disponibilité \$11D\$1, l'appel d'API échoue. Toutefois, si vous choisissez de créer une instance sans spécifier de zone de disponibilité particulière, Amazon DocumentDB choisit une zone de disponibilité en votre nom. Amazon DocumentDB utilise un algorithme pour équilibrer la charge des instances entre les zones de disponibilité afin de vous aider à atteindre une haute disponibilité. Par exemple, si trois instances sont allouées, elles le seront par défaut sur trois zones de disponibilité et non toutes dans une seule zone.

**Recommandations :**
+ Sauf si vous avez une raison précise, créez toujours un groupe de sous-réseaux avec trois sous-réseaux. Cela permet de s'assurer que les clusters avec au moins trois instances sont en mesure de bénéficier d'une disponibilité plus importante, les instances étant allouées sur trois zones de disponibilité.
+ Répartissez toujours les instances sur plusieurs zones de disponibilité pour obtenir une haute disponibilité. Ne placez jamais toutes les instances d'un cluster dans une seule zone de disponibilité.
+ Des événements de basculement pouvant se produire à n'importe quel moment, vous ne devez pas supposer qu'une instance principale ou des instances de réplica sont toujours placées dans une zone de disponibilité spécifique.

### Prérequis supplémentaires
<a name="db-cluster-create-prerequisites-additional"></a>

Voici quelques prérequis supplémentaires pour créer un cluster Amazon DocumentDB :
+ Si vous vous connectez à AWS l'aide d'informations d'identification Gestion des identités et des accès AWS (IAM), votre compte IAM doit disposer de politiques IAM qui accordent les autorisations requises pour effectuer des opérations Amazon DocumentDB.

  Si vous utilisez un compte IAM pour accéder à la console Amazon DocumentDB, vous devez d'abord vous y connecter AWS Management Console avec votre compte IAM. [Accédez ensuite à la console Amazon DocumentDB à https://console.aws.amazon.com l'adresse /docdb.](https://console.aws.amazon.com/docdb)
+ Si vous voulez adapter les paramètres de configuration de votre cluster, vous devez spécifier un groupe de paramètres de cluster et un groupe de paramètres avec les valeurs de paramètre requises. Pour de plus amples informations sur la création ou la modification d'un groupe de paramètres de cluster ou d'un groupe de paramètres, veuillez consulter [Gestion des groupes de paramètres du cluster Amazon DocumentDB](cluster_parameter_groups.md).
+ Vous devez déterminer le numéro de TCP/IP port que vous souhaitez spécifier pour votre cluster. Les pare-feux de certaines entreprises bloquent les connexions aux ports par défaut d'Amazon DocumentDB. Si le pare-feu de votre entreprise bloque le port par défaut, choisissez un autre port pour le cluster. Toutes les instances d'un cluster utilisent le même port.

## Création d'un cluster et d'une instance principale à l'aide du AWS Management Console
<a name="db-cluster-create-con"></a>

Les procédures suivantes décrivent comment utiliser la console pour lancer un cluster Amazon DocumentDB avec une ou plusieurs instances.

### Création d'un cluster : utilisation des paramètres par défaut
<a name="db-cluster-create-con-basic"></a>

**Pour créer un cluster avec des instances à l'aide des paramètres par défaut à l'aide du AWS Management Console**

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

1. Si vous souhaitez créer votre cluster dans une région Région AWS autre que l'est des États-Unis (Virginie du Nord), choisissez la région dans la liste située dans le coin supérieur droit de la console.

1. Dans le volet de navigation, sélectionnez **Clusters**, puis **Create (Créer)**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Sur la page **Créer un cluster Amazon DocumentDB**, complétez le volet **Configuration**.

   1. **Identifiant du cluster** : acceptez le nom fourni par Amazon DocumentDB ou entrez un nom pour votre cluster, par exemple,. **sample-cluster**

      Contraintes d'attribution de nom relatives à un cluster :
      + La longueur est de [1 à 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.
      + Doit être unique pour tous les clusters d'Amazon RDS, Neptune et Amazon Compte AWS DocumentDB par région.

   1. **Version du moteur** : acceptez la version du moteur par défaut 5.0.0 ou choisissez éventuellement 8.0.0, 4.0.0 ou 3.6.0.

   1. **Classe d'instance** : acceptez la valeur par défaut `db.r5.large` ou choisissez la classe d'instance de votre choix dans la liste.

   1. **Nombre d'instances** : dans la liste, choisissez le nombre d'instances que vous souhaitez créer avec ce cluster. La première instance est l'instance principale, et toutes les autres instances sont des instances de réplica en lecture seule. Vous pouvez ajouter et supprimer des instances ultérieurement, si nécessaire. Par défaut, un cluster Amazon DocumentDB est lancé avec trois instances (une instance principale et deux répliques).

1. Complétez la section **Configuration du stockage en cluster**.

   Choisissez **Amazon DocumentDB Standard (par défaut) ou **Amazon DocumentDB**** I/O-Optimized. Pour de plus amples informations, veuillez consulter [Configurations de stockage en cluster Amazon DocumentDB](db-cluster-storage-configs.md).

1. Complétez le volet **Authentication (Authentification)**.

   1. **Nom d'utilisateur** —Entrez le nom de l'utilisateur principal. Pour vous connecter à votre cluster, vous devez utiliser le nom d'utilisateur principal.

      Contraintes de dénomination des utilisateurs principaux :
      + La longueur est de [1 à 63] caractères alphanumériques.
      + Le premier caractère doit être une lettre.
      + Ne peut pas être un mot réservé du moteur de base de données.

   1. Choisissez l'une des options de mot de passe suivantes :
      + **Géré dans AWS Secrets Manager** —Choisissez cette option si vous AWS Secrets Manager souhaitez gérer automatiquement le mot de passe de votre utilisateur principal.

        Si vous choisissez cette option, configurez la clé KMS en créant la vôtre ou en utilisant une clé créée par Secrets Manager.
      + **Autogéré** : choisissez cette option si vous souhaitez gérer vous-même le mot de passe de votre utilisateur principal. Si vous choisissez cette option, entrez un mot de passe pour l'utilisateur principal, puis confirmez-le. Pour vous connecter à votre cluster, vous devez utiliser le mot de passe de l'utilisateur principal.

        Contraintes du mot de passe :
        + Entre 8 et 100 caractères ASCII imprimables.
        + Tous les caractères ASCII imprimables peuvent être utilisés, à l'exception des suivants :
          + **/** (barre oblique)
          + **"** (guillemets doubles)
          + **@** (symbole arobase)

1. Au bas de l'écran, choisissez l'une des actions suivantes :
   + Pour créer le cluster maintenant, choisissez **Create cluster (Créer un cluster)**.
   + Pour ne pas créer de cluster, choisissez **Cancel (Annuler)**.
   + Pour configurer plus précisément le cluster avant de le créer, choisissez **Show additional configurations (Afficher les configurations supplémentaires)**, puis poursuivez avec la page [Création d'un cluster : configurations supplémentaires](#db-cluster-create-con-additional-configs).

     Les configurations couvertes dans la section **Additional Configurations (Configurations supplémentaires)** sont :
     + **Paramètres réseau** : le groupe de sécurité `default` VPC est utilisé par défaut.
     + **Options du cluster** : le port par défaut est 27017 et le groupe de paramètres par défaut.
     + **Chiffrement : le chiffrement** est activé par défaut à l'aide de la `(default) aws/rds` clé.
**Important**  
Une fois qu'un cluster est chiffré, il ne peut pas être déchiffré.
     + **Sauvegarde** — La valeur par défaut est de conserver les sauvegardes pendant 1 jour et de laisser Amazon DocumentDB choisir la fenêtre de sauvegarde.
     + **Exportations de journaux** : par défaut, les journaux d'audit ne sont pas exportés vers CloudWatch Logs.
     + **Maintenance** — Par défaut, Amazon DocumentDB choisit la fenêtre de maintenance.
     + **Protection contre la suppression** : protégez votre cluster contre toute suppression accidentelle. La valeur par défaut pour les clusters créés à l'aide de la console est *enabled (activé)*.

     Si vous acceptez les paramètres par défaut maintenant, vous pouvez modifier la plupart d'entre elles ultérieurement en modifiant le cluster.

1. Activez la connexion entrante pour le groupe de sécurité de votre cluster.

   Si vous n'avez pas modifié les paramètres par défaut de votre cluster, vous avez créé un cluster à l’aide du groupe de sécurité par défaut pour le VPC par défaut dans la région donnée. Pour vous connecter à Amazon DocumentDB, vous devez activer les connexions entrantes sur le port 27017 (ou le port de votre choix) pour le groupe de sécurité de votre cluster.

   **Pour ajouter une connexion entrante au groupe de sécurité de votre cluster**

   1. Connectez-vous à la console Amazon EC2 AWS Management Console et ouvrez-la à l'adresse. [https://console.aws.amazon.com/ec2/](https://console.aws.amazon.com/ec2/)

   1. Dans la section **Resources (Ressources)** de la fenêtre principale, choisissez **Security groups (Groupes de sécurité)**.  
![\[Image : liste de ressources mettant en évidence l'option de lien Security Groups.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-ec2-security-groups.png)

   1. Dans la liste des groupes de sécurité, localisez celui que vous avez utilisé lors de la création de votre cluster (il s’agit probablement du groupe de sécurité *par défaut*) et choisissez le champ à gauche de son nom.  
![\[Image : liste des groupes de sécurité mettant en évidence un groupe de sécurité dont la case est cochée.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-ec2-default-sg.png)

   1. Dans le menu **Actions**, choisissez **Edit inbound rules (Modifier les règles entrantes)**, puis choisissez ou saisissez les contraintes de règle.

      1. **Type** —Dans la liste, choisissez le protocole à ouvrir au trafic réseau.

      1. **Protocole** —Dans la liste, choisissez le type de protocole.

      1. **Plage de ports** : pour une règle personnalisée, entrez un numéro de port ou une plage de ports. Veillez à ce que le numéro de port ou la plage des ports comprenne le port spécifié lors de la création de votre cluster (par défaut, 27017).

      1. **Source** : indique le trafic qui peut atteindre votre instance. Dans la liste, choisissez le trafic source. Si vous choisissez **Custom (Personnalisé)**, spécifiez une adresse IP unique ou une plage d'adresses IP dans une notation CIDR (par exemple, 203.0.113.5/32).

      1. **Description** —Entrez une description pour cette règle.

      1. Lorsque vous avez terminé de créer la règle, choisissez **Save (Enregistrer)**.

### Création d'un cluster : configurations supplémentaires
<a name="db-cluster-create-con-additional-configs"></a>

Si vous souhaitez accepter les paramètres par défaut pour votre cluster, vous pouvez ignorer les étapes suivantes et choisir **Create cluster (Créer un cluster)**. 

1. Complétez le volet **Network settings (Paramètres de réseau)**.  
![\[Capture d'écran : volet Network settings (Paramètres de réseau) affichant les étapes de configuration des paramètres réseau.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/create-db-cluster-console-network-settings.png)

   1. **Virtual Private Cloud (VPC)** —Dans la liste, choisissez l'Amazon VPC dans lequel vous souhaitez lancer ce cluster.

   1. **Groupe de sous-réseaux** : dans la liste, choisissez le groupe de sous-réseaux que vous souhaitez utiliser pour ce cluster.

   1. **Groupes de sécurité VPC** : dans la liste, choisissez le groupe de sécurité VPC pour ce cluster.

1. Complétez le volet **Cluster options (Options du cluster)**.  
![\[Capture d'écran présentant le volet des options du cluster avec les étapes de configuration des paramètres pour le cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/create-db-cluster-console-cluster-options.png)

   1. **Port de base de données** : utilisez les flèches haut et bas pour définir le TCP/IP port que les applications utiliseront pour se connecter à votre instance.

   1. **Groupe de paramètres de cluster** : dans la liste des groupes de paramètres, choisissez le groupe de paramètres de cluster pour ce cluster.

1. Complétez le volet **Encryption (Chiffrement)**.  
![\[Capture d'écran présentant le volet de chiffrement avec les étapes de configuration du chiffrement pour le cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/encrypt-at-rest.png)

   1. **E ncryption-at-rest** —Choisissez l'une des options suivantes :
      + **Activer le chiffrement** : valeur par défaut. Toutes les données au repos sont chiffrées. Si vous choisissez de chiffrer vos données, vous ne pouvez pas annuler cette action.
      + **Désactiver le chiffrement** : vos données ne sont pas chiffrées.

   1. **AWS Clé KMS** : elle n'est disponible que si vous cryptez vos données. Dans la liste, choisissez la clé que vous souhaitez utiliser pour chiffrer les données de ce cluster. La valeur par défaut est `(default) aws/rds`.

      Si vous choisissez **Enter a key ARN (Entrer un ARN de clé),** vous devez indiquer un Amazon Resource Name (ARN) pour la clé.

1. Complétez le volet **Backup (Sauvegarde)**.  
![\[Capture d'écran du volet de sauvegarde affichant les étapes de configuration de la fenêtre de sauvegarde pour le cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/create-db-cluster-console-backup.png)

   1. **Période de conservation des sauvegardes** : dans la liste, choisissez le nombre de jours pendant lesquels vous pouvez conserver les sauvegardes automatiques de ce cluster avant de les supprimer.

   1. **Fenêtre de sauvegarde** : définissez l'heure et la durée quotidiennes pendant lesquelles Amazon DocumentDB doit effectuer des sauvegardes de ce cluster.

      1. **Heure de début** : dans la première liste, choisissez l'heure de début (UTC) pour démarrer vos sauvegardes automatiques. Dans la deuxième liste, choisissez la minute de l'heure à laquelle vous voulez que les sauvegardes automatiques commencent.

      1. **Durée** : dans la liste, choisissez le nombre d'heures à allouer à la création de sauvegardes automatiques.

1. Complétez le volet **Exportations de journaux** en sélectionnant les types de journaux que vous souhaitez exporter vers CloudWatch Logs.  
![\[Capture d'écran présentant le volet des exportations de journaux avec les étapes de configuration de la journalisation DML du cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/create-db-cluster-console-log-exports.png)
   + **Journaux d'audit** : sélectionnez cette option pour activer l'exportation des journaux d'audit vers Amazon CloudWatch Logs. Si vous sélectionnez **Audit logs (Journaux d'audit)**, vous devez activer `audit_logs` dans le groupe de paramètres personnalisés du cluster. Pour de plus amples informations, veuillez consulter [Audit des événements Amazon DocumentDB](event-auditing.md).
   + **Journaux du profileur** : sélectionnez cette option pour activer l'exportation des journaux du profileur d'opérations vers Amazon Logs. CloudWatch Si vous sélectionnez **Profiler logs (Journaux du profileur)**, vous devez également modifier les paramètres suivants dans le groupe de paramètres personnalisés du cluster :
     + `profiler`—Réglé sur. `enabled`
     + `profiler_threshold_ms`—Définissez une valeur `[0-INT_MAX]` pour définir le seuil pour les opérations de profilage.
     + `profiler_sampling_rate`: définissez une valeur pour `[0.0-1.0]` définir le pourcentage d'opérations lentes par rapport au profil.

     Pour de plus amples informations, veuillez consulter [Profilage des opérations Amazon DocumentDB](profiling.md).

1. Complétez le volet **Maintenance**.  
![\[Capture d'écran du volet Maintenance affichant les étapes de configuration de la fenêtre de maintenance pour le cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/create-db-cluster-console-maintenance.png)

   1. Choisissez l'une des options suivantes
     + **Sélectionnez une fenêtre** : vous pouvez spécifier le jour de la semaine, l'heure de début UTC et la durée pendant laquelle Amazon DocumentDB doit effectuer la maintenance de votre cluster.

       1. **Jour de début** : dans la liste, choisissez le jour de la semaine pour démarrer la maintenance du cluster.

       1. **Heure de début** : dans les listes, choisissez l'heure et la minute (UTC) pour démarrer la maintenance.

       1. **Durée** : dans la liste, choisissez le temps à allouer à la maintenance du cluster. Si la maintenance ne peut pas être effectuée dans le laps de temps spécifié, le processus se poursuit au-delà de la durée spécifiée jusqu'à ce qu'il se termine.
     + **Aucune préférence** : Amazon DocumentDB choisit le jour de la semaine, l'heure de début et la durée de la maintenance.

1. Si vous souhaitez ajouter une ou plusieurs balises à ce cluster, complétez le volet **Tags (Balises)**.  
![\[Capture d'écran de la case à cocher d’activation de la protection contre la suppression, qui est sélectionnée.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/create-db-cluster-console-tags.png)

   Pour chaque balise que vous souhaitez ajouter au cluster, répétez les étapes suivantes. Vous pouvez en avoir jusqu'à 10 sur un cluster.

   1. Sélectionnez **Add Tags (Ajouter des balises)**.

   1. Entrez la **clé** de la balise.

   1. Vous pouvez, si vous le souhaitez, entrer la **valeur** de la balise.

   Pour supprimer une balise, choisissez **Remove tag (Supprimer une balise)**.

1. **Deletion Protection (Protection contre la suppression)** est activée par défaut lorsque vous créez un cluster à l’aide de la console. Pour désactiver la protection contre la suppression, désactivez **Enable deletion protection (Activer la protection contre la suppression)**. Lorsque cette option est activée, la protection contre la suppression empêche la suppression d’un cluster. Pour supprimer un cluster protégé contre la suppression, vous devez tout d'abord modifier le cluster pour désactiver la protection contre la suppression.  
![\[Capture d'écran de la case à cocher d’activation de la protection contre la suppression, qui est sélectionnée.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/create-db-cluster-console-deletion-protection.png)

   Pour plus d'informations sur la protection de la suppression, consultez [Suppression d'un cluster Amazon DocumentDB](db-cluster-delete.md).

1. Pour créer le cluster, choisissez **Create cluster (Créer un cluster)**. Sinon, sélectionnez **Annuler**.

## Création d'un cluster à l'aide du AWS CLI
<a name="db-cluster-create-cli"></a>

Les procédures suivantes décrivent comment utiliser le AWS CLI pour lancer un cluster Amazon DocumentDB et créer une réplique Amazon DocumentDB.

**Parameters**
+ **--db-cluster-identifier** : obligatoire. Une chaîne en minuscules qui identifie ce cluster.    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/db-cluster-create.html)
+ **--engine** : obligatoire. Doit indiquer **docdb**.
+ **--deletion-protection \$1 --no-deletion-protection**—Facultatif. Lorsque la protection contre la suppression est activée, elle empêche la suppression d’un cluster. Lorsque vous utilisez le AWS CLI, le paramètre par défaut est de désactiver la protection contre la suppression.

  Pour plus d'informations sur la protection de la suppression, consultez [Suppression d'un cluster Amazon DocumentDB](db-cluster-delete.md).
+ **--storage-type standard \$1 iopt1**—Facultatif. Valeur par défaut : **standard**. Configuration de stockage du cluster. Les valeurs valides sont `standard` (Standard) ou `iopt1` (optimisées pour les E/S).
+ **--master-username** : obligatoire. Nom de l'utilisateur authentifié.    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/db-cluster-create.html)
+ **--master-user-password**—Facultatif. Mot de passe de l'utilisateur authentifié.    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/db-cluster-create.html)
+ **--manage-master-user-password**—Facultatif. Amazon DocumentDB génère le mot de passe de l'utilisateur principal et le gère tout au long de son cycle de vie dans Secrets Manager.

Pour accéder à des paramètres supplémentaires, consultez [CreateDBCluster](API_CreateDBCluster.md).

**Pour lancer un cluster Amazon DocumentDB à l'aide du AWS CLI**

Pour créer un cluster Amazon DocumentDB, appelez le. `create-db-cluster` AWS CLI La AWS CLI commande suivante crée un cluster Amazon DocumentDB nommé `sample-cluster` avec la protection contre la suppression activée. Pour plus d'informations sur la protection contre les suppressions, consultez[Suppression d'un cluster Amazon DocumentDB](db-cluster-delete.md).

Il s'`--engine-version`agit également d'un paramètre facultatif qui utilise par défaut la dernière version majeure du moteur. La version actuelle du moteur par défaut est 5.0.0 (remarque : Amazon DocumentDB 8.0 est disponible mais doit être explicitement spécifiée). Lorsque de nouvelles versions majeures du moteur sont publiées, la version par défaut du moteur est mise à jour pour `--engine-version` refléter la dernière version majeure du moteur. Par conséquent, pour les charges de travail de production, et en particulier celles qui dépendent de scripts, d'automatisation ou de CloudFormation modèles, nous vous recommandons de spécifier explicitement la `--engine-version` version majeure prévue.

**Note**  
Si un `db-subnet-group-name` ou n'`vpc-security-group-id`est pas spécifié, Amazon DocumentDB utilisera le groupe de sous-réseaux et le groupe de sécurité Amazon VPC par défaut pour la région donnée.

Pour Linux, macOS ou Unix :

```
aws docdb create-db-cluster \
      --db-cluster-identifier sample-cluster \
      --engine docdb \
      --engine-version 5.0.0 \
      --deletion-protection \
      --master-username masteruser \
      --master-user-password password
```

Pour Windows :

```
aws docdb create-db-cluster ^
      --db-cluster-identifier sample-cluster ^
      --engine docdb ^
      --engine-version 5.0.0 ^
      --deletion-protection ^
      --master-username masteruser ^
      --master-user-password password
```

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

```
{
    "DBCluster": {
        "StorageEncrypted": false,
        "DBClusterMembers": [],
        "Engine": "docdb",
        "DeletionProtection" : "enabled",
        "ClusterCreateTime": "2018-11-26T17:15:19.885Z",
        "DBSubnetGroup": "default",
        "EngineVersion": "5.0.0",
        "MasterUsername": "masteruser",
        "BackupRetentionPeriod": 1,
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
        "DBClusterIdentifier": "sample-cluster",
        "MultiAZ": false,
        "DBClusterParameterGroup": "default.docdb5.0",
        "PreferredBackupWindow": "09:12-09:42",
        "DbClusterResourceId": "cluster-KQSGI4MHU4NTDDRVNLNTU7XVAY",
        "PreferredMaintenanceWindow": "tue:04:17-tue:04:47",
        "Port": 27017,
        "Status": "creating",
        "ReaderEndpoint": "sample-cluster.cluster-ro-sfcrlcjcoroz.us-east-1.docdb.amazonaws.com",
        "AssociatedRoles": [],
        "HostedZoneId": "ZNKXTT8WH85VW",
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-77186e0d",
                "Status": "active"
            }
        ],
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1c",
            "us-east-1e"
        ],
        "Endpoint": "sample-cluster.cluster-sfcrlcjcoroz.us-east-1.docdb.amazonaws.com"
    }
}
```

La création du cluster prend quelques minutes. Vous pouvez utiliser le AWS Management Console ou AWS CLI pour surveiller l'état de votre cluster. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'un cluster Amazon DocumentDB](monitoring_docdb-cluster_status.md). 

**Important**  
Lorsque vous utilisez le AWS CLI pour créer un cluster Amazon DocumentDB, aucune instance n'est créée. Par conséquent, vous devez créer explicitement une instance principale et tous les réplicas des instances dont vous avez besoin. Vous pouvez utiliser la console ou AWS CLI créer les instances. Pour de plus amples informations, veuillez consulter [Ajouter une instance Amazon DocumentDB à un cluster](db-instance-add.md). 

Pour plus d'informations, consultez le [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBCluster.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBCluster.html)manuel *Amazon DocumentDB API Reference*. 

# Décrire les clusters Amazon DocumentDB
<a name="db-cluster-view-details"></a>

Vous pouvez utiliser la console de gestion Amazon DocumentDB ou le AWS CLI pour consulter des informations telles que les points de terminaison de connexion, les groupes de sécurité et les groupes de paramètres relatifs à vos clusters Amazon DocumentDB. VPCs

Pour plus d’informations, consultez les ressources suivantes :
+ [Surveillance de l'état d'un cluster Amazon DocumentDB](monitoring_docdb-cluster_status.md)
+ [Trouver les points de terminaison d'un cluster](db-cluster-endpoints-find.md)

------
#### [ Using the AWS Management Console ]

Utilisez la procédure suivante pour afficher les détails d'un cluster Amazon DocumentDB spécifié à l'aide de la console.

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans la liste des clusters, choisissez le nom du cluster dont vous voulez afficher les détails. Les informations sur le cluster sont organisées en six groupes :
   + **Résumé** : informations générales sur le cluster, notamment la version du moteur, l'état du cluster, la maintenance en attente et le statut de son groupe de paramètres.
   + **Connectivité et sécurité** : la section **Connect** répertorie les points de terminaison de connexion permettant de se connecter à ce cluster à l'aide du shell mongo ou d'une application. La section **Security Groups (Groupes de sécurité)** répertorie les groupes de sécurité associés à ce cluster ainsi que leur ID de VPC et leurs descriptions. 
   + **Configuration** : la section **Détails du cluster** répertorie les informations relatives au cluster, notamment le nom de ressource Amazon (ARN), le point de terminaison et le groupe de paramètres du cluster. Elle répertorie également les informations de sauvegarde du cluster, les détails de maintenance ainsi que les paramètres de sécurité et de réseau. La section **Cluster instances (Instances de cluster)** répertorie toutes les instances appartenant à votre cluster avec l'état du rôle et du groupe de paramètres de cluster de chaque instance.
   + **Surveillance** — Les métriques Amazon CloudWatch Logs pour ce cluster. Pour de plus amples informations, veuillez consulter [Surveillance d'Amazon DocumentDB avec CloudWatch](cloud_watch.md).
   + **Événements et tags** — La section **Événements récents** répertorie les événements récents pour ce cluster. Amazon DocumentDB conserve un enregistrement des événements liés à vos clusters, instances, instantanés, groupes de sécurité et groupes de paramètres de cluster. Ces informations comprennent la date, l'heure et le message associés à chaque événement. La section **Tags (Balises)** répertorie les balises attachées à ce cluster.

------
#### [ Using the AWS CLI ]

Pour afficher les détails de vos clusters Amazon DocumentDB à l'aide de AWS CLI, utilisez la `describe-db-clusters` commande comme indiqué dans les exemples ci-dessous. Pour plus d'informations, consultez le document [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusters.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusters.html)de référence de l'*API de gestion des ressources Amazon DocumentDB*. 

**Note**  
Pour certaines fonctionnalités de gestion telles que la gestion du cycle de vie des clusters et des instances, Amazon DocumentDB utilise une technologie opérationnelle partagée avec Amazon RDS. Le paramètre de `filterName=engine,Values=docdb` filtre renvoie uniquement les clusters Amazon DocumentDB. 

**Example**  
**Exemple 1 : répertorier tous les clusters Amazon DocumentDB**  
Le AWS CLI code suivant répertorie les détails de tous les clusters Amazon DocumentDB d'une région.   

```
aws docdb describe-db-clusters --filter Name=engine,Values=docdb
```
Le résultat de cette opération ressemble à ceci.  

```
{
    "DBClusters": [
        {
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1b",
                "us-east-1a"
            ],
            "BackupRetentionPeriod": 1,
            "DBClusterIdentifier": "sample-cluster-1",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            ...
        },
        {
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1b",
                "us-east-1a"
            ],
            "BackupRetentionPeriod": 1,
            "DBClusterIdentifier": "sample-cluster-2",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            ...
        },
        {
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1b",
                "us-east-1a"
            ],
            "BackupRetentionPeriod": 1,
            "DBClusterIdentifier": "sample-cluster-3",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            ...
        }
    ]
}
```

**Example**  
**Exemple 2 : répertorier tous les détails d'un cluster Amazon DocumentDB spécifié**  
Le AWS CLI code suivant répertorie les détails du cluster`sample-cluster`.  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-clusters \
   --filter Name=engine,Values=docdb \
   --db-cluster-identifier sample-cluster
```
Pour Windows :  

```
aws docdb describe-db-clusters ^
   --filter Name=engine,Values=docdb ^
   --db-cluster-identifier sample-cluster
```
Le résultat de cette opération ressemble à ceci.  

```
{
    "DBClusters": [
        {
            "AllocatedStorage": 1,
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1a",
                "us-east-1d"
            ],
            "BackupRetentionPeriod": 2,
            "DBClusterIdentifier": "sample-cluster",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            "EarliestRestorableTime": "2023-11-07T22:34:08.148000+00:00",
            "Endpoint": "sample-cluster.node.us-east-1.amazon.com",
            "ReaderEndpoint": "sample-cluster.node.us-east-1.amazon.com",
            "MultiAZ": false,
            "Engine": "docdb",
            "EngineVersion": "5.0.0",
            "LatestRestorableTime": "2023-11-10T07:21:16.772000+00:00",
            "Port": 27017,
            "MasterUsername": "chimeraAdmin",
            "PreferredBackupWindow": "22:22-22:52",
            "PreferredMaintenanceWindow": "sun:03:01-sun:03:31",
            "ReadReplicaIdentifiers": [],
            "DBClusterMembers": [
                {
                    "DBInstanceIdentifier": "sample-instance-1",
                    "IsClusterWriter": true,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "sample-instance-2",
                    "IsClusterWriter": true,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                
            ],
            "VpcSecurityGroups": [
                {
                    "VpcSecurityGroupId": "sg-9084c2ec",
                    "Status": "active"
                }
            ],
            "HostedZoneId": "Z06853723JYKYBXTJ49RB",
            "StorageEncrypted": false,
            "DbClusterResourceId": "cluster-T4LGLANHVAPGQYYULWUDKLVQL4",
            "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
            "AssociatedRoles": [],
            "IAMDatabaseAuthenticationEnabled": false,
            "ClusterCreateTime": "2023-11-06T18:05:41.568000+00:00",
            "EngineMode": "provisioned",
            "DeletionProtection": false,
            "HttpEndpointEnabled": false,
            "CopyTagsToSnapshot": false,
            "CrossAccountClone": false,
            "DomainMemberships": [],
            "TagList": [],
            "StorageType": "iopt1",
            "AutoMinorVersionUpgrade": false,
            "NetworkType": "IPV4",
            "IOOptimizedNextAllowedModificationTime": "2023-12-07T18:05:41.580000+00:00"
        }
    ]
}
```

**Example**  
**Exemple 3 : Répertorier les informations spécifiques d'un cluster Amazon DocumentDB**  
Pour répertorier un sous-ensemble des détails des clusters à l'aide du AWS CLI, ajoutez un qui spécifie les membres du cluster `--query` que l'`describe-db-clusters`opération doit répertorier. Le paramètre `--db-cluster-identifier` est l'identifiant du cluster particulier dont vous souhaitez afficher les détails. Pour plus d'informations sur les requêtes, voir [Comment filtrer la sortie avec l'`--query`option](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-output.html#controlling-output-filter) dans le *guide de AWS Command Line Interface l'utilisateur*.   
L'exemple suivant répertorie les instances d'un cluster Amazon DocumentDB.  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-clusters \
    --filter Name=engine,Values=docdb \
    --db-cluster-identifier sample-cluster \
    --query 'DBClusters[*].[DBClusterMembers]'
```
Pour Windows :  

```
aws docdb describe-db-clusters ^
    --filter Name=engine,Values=docdb ^
    --db-cluster-identifier sample-cluster ^
    --query 'DBClusters[*].[DBClusterMembers]'
```
Le résultat de cette opération ressemble à ceci.  

```
[
    [
        [
            {
                "DBInstanceIdentifier": "sample-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            },
            {
                "DBInstanceIdentifier": "sample-instance-2",
                "IsClusterWriter": false,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ]
    ]
]
```

------

# Modification d'un cluster Amazon DocumentDB
<a name="db-cluster-modify"></a>

Pour modifier un cluster, le cluster doit être à l'état *disponible* . Vous ne pouvez pas modifier un cluster qui est arrêté. Si le cluster est arrêté, commencez par démarrer le cluster, attendez que le cluster devienne *disponible*, puis apportez les modifications souhaitées. Pour de plus amples informations, veuillez consulter [Arrêt et démarrage d'un cluster Amazon DocumentDB](db-cluster-stop-start.md). 

------
#### [ Using the AWS Management Console ]

Utilisez la procédure suivante pour modifier un cluster Amazon DocumentDB spécifique à l'aide de la console.

**Pour modifier un cluster Amazon DocumentDB**

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Spécifiez le cluster que vous souhaitez modifier en cliquant sur le bouton situé à gauche du nom du cluster.

1. Choisissez **Actions**, puis **Modify (Modifier)**.

1. Dans le volet **Modify cluster: <cluster-name> (Modifier le cluster : <nom-cluster>)**, apportez les modifications souhaitées. Vous pouvez effectuer des modifications dans les domaines suivants :
   + **Spécifications du cluster** : nom du cluster, groupes de sécurité et gestion des informations d'identification.
   + **Configuration du stockage** en cluster : mode de stockage des données du cluster. Choisissez entre une configuration standard et une configuration optimisée pour les E/S.
   + **Options du cluster** : port et groupe de paramètres du cluster.
   + **Sauvegarde** : période de conservation des sauvegardes et fenêtre de sauvegarde du cluster.
   + **Exportations de journaux** : activez ou désactivez l'exportation des journaux d'audit ou de profilage.
   + **Maintenance** —Définissez la fenêtre de maintenance du cluster.
   + **Protection contre la suppression** : activez ou désactivez la protection contre la suppression sur le cluster. Par défaut, la protection contre la suppression est activée.

1. Lorsque vous avez terminé, choisissez **Continue (Continuer)** pour afficher un récapitulatif de vos modifications.

1. Si vous êtes satisfait de vos modifications, vous pouvez choisir **Modify cluster (Modifier le cluster)** pour modifier votre cluster. Vous pouvez également choisir **Back (Précédent)** ou **Cancel (Annuler)** pour modifier ou annuler vos modifications, respectivement. 

L'application de vos modifications prend quelques minutes. Vous pouvez uniquement utiliser le cluster lorsqu'il présente le statut *disponible*. Vous pouvez surveiller l'état du cluster en utilisant la console ou la AWS CLI. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'un cluster Amazon DocumentDB](monitoring_docdb-cluster_status.md). 

------
#### [ Using the AWS CLI ]

Utilisez l'opération `modify-db-cluster` pour modifier le cluster spécifié à l'aide de l’ AWS CLI. Pour plus d'informations, consultez le [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html)manuel *Amazon DocumentDB API Reference*.

**Parameters**
+ **--db-cluster-identifier** : obligatoire. Identifiant du cluster Amazon DocumentDB que vous allez modifier.
+ **--backup-retention-period**—Facultatif. Nombre de jours de conservation des sauvegardes automatiques. Les valeurs valides sont comprises entre 1 et 35.
+ **--storage-type**—Facultatif. Configuration de stockage du cluster. Les valeurs valides sont `standard` (Standard) ou `iopt1` (optimisées pour les E/S).
+ **--db-cluster-parameter-group-name**—Facultatif. Le nom du groupe de paramètres de cluster à utiliser pour le cluster.
+ **--manage-master-user-password**—Facultatif. Amazon DocumentDB génère le mot de passe de l'utilisateur principal et le gère tout au long de son cycle de vie dans Secrets Manager.
+ **--rotate-master-user-password**—Facultatif. Secrets Manager génère une nouvelle version secrète pour le secret existant. La nouvelle version du secret contient le nouveau mot de passe de l'utilisateur principal. Amazon DocumentDB modifie le mot de passe de l'utilisateur principal du cluster afin qu'il corresponde au mot de passe de la nouvelle version secrète.

  Vous devez spécifier l'**--apply-immediately**option lorsque vous faites pivoter le mot de passe principal.
+ **--master-user-password**—Facultatif. Le nouveau mot de passe de l'utilisateur principal de la base de données.

  Contraintes du mot de passe :
  + La longueur est de [8 à 100] caractères ASCII imprimables.
  + Tous les caractères ASCII imprimables peuvent être utilisés, à l'exception des suivants :
    + **/** (barre oblique)
    + **"** (guillemets doubles)
    + **@** (symbole arobase)
+ **--new-db-cluster-identifier**—Facultatif. 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 d'affectation de noms :
  + La longueur est de [1 à 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.
  + Doit être unique pour tous les clusters d'Amazon RDS, Amazon Neptune et Amazon DocumentDB par région Compte AWS.
+ **--preferred-backup-window**—Facultatif. L'intervalle de temps quotidien (en UTC) au cours duquel les sauvegardes automatiques sont créées.
  + Format : `hh24:mm-hh24:mm`
+ **--preferred-maintenance-window**—Facultatif. Intervalle de temps hebdomadaire (en UTC) pendant lequel peut se produire la maintenance du système.
  + Format : `ddd:hh24:mm-ddd:hh24:mm`
  + Jours valables : `Sun`, `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, et `Sat`.
+ **--deletion-protection**ou **--no-deletion-protection** —Facultatif. Indique si la protection contre la suppression doit être activée sur ce cluster. La protection contre la suppression empêche toute suppression accidentelle d’un cluster tant que cette fonction n’est pas désactivée. Pour de plus amples informations, veuillez consulter [Suppression d'un cluster Amazon DocumentDB](db-cluster-delete.md). 
+ **--apply-immediately**ou **--no-apply-immediately** —Utilisez `--apply-immediately` pour effectuer la modification immédiatement. Utilisez `--no-apply-immediately` pour effectuer la modification au cours de la fenêtre de maintenance suivante de votre cluster.

**Example**  
Le code suivant modifie la période de conservation des sauvegardes pour le cluster `sample-cluster`.  
Pour Linux, macOS ou Unix :  

```
aws docdb modify-db-cluster \
       --db-cluster-identifier sample-cluster \
       --apply-immediately \
       --backup-retention-period 7
```
Pour Windows :  

```
aws docdb modify-db-cluster ^
       --db-cluster-identifier sample-cluster ^
       --apply-immediately ^
       --backup-retention-period 7
```
Le résultat de cette opération ressemble à ceci.  

```
{
    "DBCluster": {
        "BackupRetentionPeriod": 7,
        "DbClusterResourceId": "cluster-VDP53QEWST7YHM36TTXOPJT5YE",
        "Status": "available",
        "DBClusterMembers": [
            {
                "PromotionTier": 1,
                "DBClusterParameterGroupStatus": "in-sync",
                "DBInstanceIdentifier": "sample-cluster-instance",
                "IsClusterWriter": true
            }
        ],
        "ReadReplicaIdentifiers": [],
        "AvailabilityZones": [
            "us-east-1b",
            "us-east-1c",
            "us-east-1a"
        ],
        "ReaderEndpoint": "sample-cluster.cluster-ro-ctevjxdlur57.us-east-1.rds.amazonaws.com",
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
        "PreferredMaintenanceWindow": "sat:09:51-sat:10:21",
        "EarliestRestorableTime": "2018-06-17T00:06:19.374Z",
        "StorageEncrypted": false,
        "MultiAZ": false,
        "AssociatedRoles": [],
        "MasterUsername": "<your-master-user-name>",
        "DBClusterIdentifier": "sample-cluster",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "HostedZoneId": "Z2SUY0A1719RZT",
        "LatestRestorableTime": "2018-06-18T21:17:05.737Z",
        "AllocatedStorage": 1,
        "Port": 27017,
        "Engine": "docdb",
        "DBClusterParameterGroup": "default.docdb3.4",
        "Endpoint": "sample-cluster.cluster-ctevjxdlur57.us-east-1.rds.amazonaws.com",
        "DBSubnetGroup": "default",
        "PreferredBackupWindow": "00:00-00:30",
        "EngineVersion": "3.4",
        "ClusterCreateTime": "2018-06-06T19:25:47.991Z",
        "IAMDatabaseAuthenticationEnabled": false
    }
}
```

L'application de vos modifications prend quelques minutes. Vous pouvez uniquement utiliser le cluster lorsqu'il présente le statut *disponible*. Vous pouvez surveiller l'état du cluster en utilisant la console ou la AWS CLI. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'un cluster Amazon DocumentDB](monitoring_docdb-cluster_status.md). 

------

# Détermination de la maintenance en attente
<a name="db-cluster-determine-pending-maintenance"></a>

Vous pouvez déterminer si vous disposez de la dernière version du moteur Amazon DocumentDB en déterminant si vous avez une maintenance de cluster en attente.

------
#### [ Using the AWS Management Console ]

Vous pouvez utiliser le AWS Management Console pour déterminer si un cluster a une maintenance en attente.

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Recherchez la colonne **Maintenance** afin de déterminer si un cluster est en attente de maintenance.  
![\[Capture d'écran de la console montrant le champ de maintenance du cluster Amazon DocumentDB.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-cluster-pending-maintenance.png)

   **None (Aucune)** indique que le cluster exécute la dernière version du moteur. **Available (Disponible)** indique que le cluster est en attente de la maintenance, ce qui implique qu'une mise à niveau du moteur est nécessaire.

1. Si votre cluster est en attente de maintenance, poursuivez avec les étapes de la section [Exécution d'une mise à jour corrective de la version du moteur d'un cluster](db-cluster-version-upgrade.md). 

------
#### [ Using the AWS CLI ]

Vous pouvez utiliser le AWS CLI pour déterminer si un cluster possède la dernière version du moteur en utilisant l'`describe-pending-maintenance-actions`opération avec les paramètres suivants.

**Parameters**
+ **--resource-identifier**—Facultatif. ARN d'accès à la ressource (cluster). Si ce paramètre n'est pas spécifié, les actions de maintenance en attente pour tous les clusters sont répertoriées.
+ **--region**—Facultatif. La région AWS dans laquelle vous voulez exécuter cette opération, par exemple `us-east-1`.

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-pending-maintenance-actions \
   --resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster \
   --region us-east-1
```
Pour Windows :  

```
aws docdb describe-pending-maintenance-actions ^
   --resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster ^
   --region us-east-1
```
Le résultat de cette opération ressemble à ceci.  

```
{
    "PendingMaintenanceActions": [
        {
            "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
            "PendingMaintenanceActionDetails": [
                {
                    "Description": "New feature",
                    "Action": "db-upgrade",
                    "ForcedApplyDate": "2019-02-25T21:46:00Z",
                    "AutoAppliedAfterDate": "2019-02-25T07:41:00Z",
                    "CurrentApplyDate": "2019-02-25T07:41:00Z"
                }
            ]
        }
    ]
}
```

Si votre cluster est en attente de maintenance, poursuivez avec les étapes de la section [Exécution d'une mise à jour corrective de la version du moteur d'un cluster](db-cluster-version-upgrade.md). 

------

# Exécution d'une mise à jour corrective de la version du moteur d'un cluster
<a name="db-cluster-version-upgrade"></a>

Dans cette section, nous expliquerons comment déployer une mise à jour de correctif à l'aide du AWS Management Console ou du AWS CLI. Une mise à jour de correctif est une mise à jour de la même version du moteur (par exemple, la mise à jour d'une version du moteur 3.6 vers une version du moteur 3.6 plus récente). Vous pouvez le mettre à jour immédiatement ou lors de la prochaine fenêtre de maintenance de votre cluster. Pour déterminer si votre moteur a besoin d'une mise à jour, consultez[Détermination de la maintenance en attente](db-cluster-determine-pending-maintenance.md). Notez que lorsque vous appliquez la mise à jour, votre cluster subira des temps d'arrêt.

**Note**  
Si vous essayez de passer d'une version majeure du moteur à une autre, par exemple de la version 3.6 à la version 5.0, reportez-vous à la section [Mise à niveau sur place de la version majeure d'Amazon DocumentDB](docdb-mvu.md) ou[Mise à niveau de votre cluster Amazon DocumentDB à l'aide de AWS Database Migration Service](docdb-migration.versions.md). Une mise à niveau de version majeure sur place ne prend en charge que docdb 5.0 comme version du moteur cible.

Deux exigences de configuration sont requises pour obtenir les dernières mises à jour des correctifs pour la version du moteur d'un cluster :
+ Le statut du cluster doit être *disponible*.
+ Le cluster doit exécuter une version antérieure du moteur.

------
#### [ Using the AWS Management Console ]

La procédure suivante applique les mises à jour des correctifs à la version du moteur de votre cluster à l'aide de la console. Vous avez la possibilité de procéder à la mise à jour immédiatement ou lors de la prochaine fenêtre de maintenance de votre cluster.

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

1. Dans le panneau de navigation, choisissez **Clusters**. Dans la liste des clusters, choisissez le bouton sur la gauche du cluster que vous voulez mettre à niveau. Le statut du cluster doit être *disponible*.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans le menu **Actions**, choisissez l'une des options suivantes. Ces options de menu sont sélectionnables uniquement si le cluster que vous avez choisi n'exécute pas la version la plus récente du moteur.  
![\[Image : Actions de mise à niveau d'Amazon DocumentDB\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-upgrade-action.png)
   + **Mettre à niveau maintenant** —Lance immédiatement le processus de mise à niveau. Votre cluster est hors ligne pendant la mise à niveau vers la version la plus récente du moteur.
   + **Mise à niveau à la fenêtre suivante** : lance le processus de mise à niveau lors de la fenêtre de maintenance suivante du cluster. Votre cluster est hors ligne pendant la mise à niveau vers la version la plus récente du moteur.

1. Lorsque la fenêtre de confirmation s'ouvre, choisissez l'une des options suivantes :
   + **Mise** à niveau : pour mettre à niveau votre cluster vers la dernière version du moteur conformément au calendrier choisi à l'étape précédente.
   + **Annuler** : pour annuler la mise à niveau du moteur du cluster et continuer avec la version actuelle du moteur du cluster.

------
#### [ Using the AWS CLI ]

Vous pouvez appliquer des mises à jour de correctifs à votre cluster à l'aide de l'`apply-pending-maintenance-action`opération AWS CLI et avec les paramètres suivants.

**Parameters**
+ **--resource-identifier** : obligatoire. L'ARN du cluster Amazon DocumentDB que vous allez mettre à niveau.
+ **--apply-action** : obligatoire. Les valeurs suivantes sont autorisées. Pour mettre à niveau la version du moteur de votre cluster, utilisez `db-upgrade`.
  + **db-upgrade**
  + **system-update**
+ **--opt-in-type** : obligatoire. Les valeurs suivantes sont autorisées.
  + `immediate`—Appliquez immédiatement l'action de maintenance.
  + `next-maintenance`—Appliquez l'action de maintenance lors de la fenêtre de maintenance suivante.
  + `undo-opt-in`—Annulez toutes les demandes d'`next-maintenance`opt-in existantes.

**Example**  
L'exemple de correctif suivant met à jour la version du moteur de `sample-cluster` vers la version 4.0.0.  
Pour Linux, macOS ou Unix :  

```
aws docdb apply-pending-maintenance-action \
   --resource-identifier arn:aws:rds:us-east-1:123456789012\:cluster:sample-cluster \
   --apply-action db-upgrade \
   --opt-in-type immediate
```
Pour Windows :  

```
aws docdb apply-pending-maintenance-action ^
   --resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster ^
   --apply-action db-upgrade ^
   --opt-in-type immediate
```
Le résultat de cette opération ressemble à ce qui suit.  

```
{
    "ResourcePendingMaintenanceActions": {
        "ResourceIdentifier": "arn:aws:rds:us-east-1:444455556666:cluster:docdb-2019-01-09-23-55-38",
        "PendingMaintenanceActionDetails": [
            {
                "CurrentApplyDate": "2019-02-20T20:57:06.904Z",
                "Description": "Bug fixes",
                "ForcedApplyDate": "2019-02-25T21:46:00Z",
                "OptInStatus": "immediate",
                "Action": "db-upgrade",
                "AutoAppliedAfterDate": "2019-02-25T07:41:00Z"
            }
        ]
    }
}
```

------

# Arrêt et démarrage d'un cluster Amazon DocumentDB
<a name="db-cluster-stop-start"></a>

L'arrêt et le démarrage des clusters Amazon DocumentDB peuvent vous aider à gérer les coûts des environnements de développement et de test. Au lieu de créer et de supprimer des clusters et des instances à chaque fois que vous utilisez Amazon DocumentDB, vous pouvez arrêter temporairement toutes les instances de votre cluster lorsqu'elles ne sont pas nécessaires. Vous pouvez ensuite les redémarrer lorsque vous reprenez vos tests.

**Topics**
+ [Présentation de l’arrêt et du démarrage d’un cluster](#db-cluster-stop-start-overview)
+ [Opérations que vous pouvez effectuer sur un cluster arrêté](#db-cluster-stopped-operations)

## Présentation de l’arrêt et du démarrage d’un cluster
<a name="db-cluster-stop-start-overview"></a>

Pendant les périodes où vous n'avez pas besoin d'un cluster Amazon DocumentDB, vous pouvez arrêter toutes les instances de ce cluster en même temps. Vous pouvez ensuite à tout moment redémarrer le cluster dès que vous avez besoin de l'utiliser. Le démarrage et l'arrêt simplifie les processus de configuration et de destruction des clusters utilisés à des fins de développement, de test ou d'activités similaires qui ne nécessitent pas une disponibilité continue. Vous pouvez arrêter et démarrer un cluster en utilisant AWS Management Console ou en AWS CLI une seule action, quel que soit le nombre d'instances présentes dans le cluster.

Pendant que votre cluster est arrêté, le volume de stockage du cluster reste inchangé. Vous êtes facturé uniquement pour le stockage, les instantanés manuels et le stockage des sauvegardes automatiques pendant la fenêtre de conservation spécifiée. Aucune heure d'instance ne vous est facturée. Amazon DocumentDB démarre automatiquement votre cluster au bout de sept jours afin qu'il ne prenne aucun retard par rapport aux mises à jour de maintenance requises. Lorsque votre cluster démarre après sept jours, vous êtes à nouveau facturé pour les instances dans le cluster. Pendant l'arrêt de votre cluster, vous ne pouvez pas interroger votre volume de stockage car l'interrogation nécessite que les instances soient à l'état disponible.

Lorsqu'un cluster Amazon DocumentDB est arrêté, ni le cluster ni ses instances ne peuvent être modifiés de quelque manière que ce soit. Cela inclut l'ajout ou la suppression d'instances, ou la suppression du cluster.

------
#### [ Using the AWS Management Console ]

La procédure suivante vous montre comment arrêter un cluster avec une ou plusieurs instances à l'état disponible, ou démarrer un cluster arrêté.

**Pour arrêter ou démarrer un cluster Amazon DocumentDB**

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans la liste des clusters, choisissez le bouton sur la gauche du nom du cluster que vous voulez arrêter ou démarrer.

1. Choisissez **Actions**, puis l'action que vous souhaitez exécuter sur le cluster.
   + Si vous souhaitez arrêter le cluster et que celui-ci est disponible :

     1. Choisissez **Arrêter**.  
![\[Image : arrêt d’un cluster\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cluster-stop.png)

        Pour éviter d’activer le mécanisme de basculement, l'opération stoppe d'abord les instances de réplica, puis l'instance principale.

     1. Dans la boîte de dialogue de confirmation, confirmez que vous souhaitez arrêter le cluster en choisissant **Stop cluster (Arrêter le cluster)**. Sinon, choisissez **Cancel (Annuler)** pour conserver le cluster en cours d'exécution.  
![\[Image : démarrage d’un cluster\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cluster-stop-confirm.png)
   + Si vous souhaitez démarrer un cluster et que celui-ci est arrêté, choisissez **Start (Démarrer)**.  
![\[Image : démarrage d’un cluster\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cluster-start.png)

1. Surveillez le statut du cluster et de ses instances. Si vous avez démarré le cluster, vous pouvez utiliser celui-ci et ses instances lorsqu’ils sont *disponibles*. Pour de plus amples informations, veuillez consulter [Déterminer le statut d'un cluster](db-cluster-status.md).   
![\[Image : statut de l'arrêt et du démarrage de clusters\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cluster-stop-start-status.png)

------
#### [ Using the AWS CLI ]

Les exemples de code suivants montrent comment arrêter un cluster avec une ou plusieurs instances à l'état disponible, ou démarrer un cluster arrêté.

Pour arrêter un cluster avec une ou plusieurs instances disponibles à l'aide de AWS CLI, utilisez l'`stop-db-cluster`opération. Pour démarrer un cluster arrêté, utilisez l'opération `start-db-cluster`. Les deux opérations utilisent le paramètre `--db-cluster-identifier`.

**Paramètre :**
+ **--db-cluster-identifier** : obligatoire. Le nom du cluster à arrêter ou démarrer.

**Example — Pour arrêter un cluster à l'aide du AWS CLI**  
Le code suivant arrête le cluster `sample-cluster`. Le cluster doit avoir une ou plusieurs instances à l'état disponible.  
Pour Linux, macOS ou Unix :  

```
aws docdb stop-db-cluster \
   --db-cluster-identifier sample-cluster
```
Pour Windows :  

```
aws docdb stop-db-cluster ^
   --db-cluster-identifier sample-cluster
```

**Example — Pour démarrer un cluster à l'aide du AWS CLI**  
Le code suivant démarre le cluster `sample-cluster`. Le cluster doit être actuellement à l’arrêt.  
Pour Linux, macOS ou Unix :  

```
aws docdb start-db-cluster \
   --db-cluster-identifier sample-cluster
```
Pour Windows :  

```
aws docdb start-db-cluster ^
   --db-cluster-identifier sample-cluster
```

------

## Opérations que vous pouvez effectuer sur un cluster arrêté
<a name="db-cluster-stopped-operations"></a>

Lorsqu'un cluster Amazon DocumentDB est arrêté, vous pouvez effectuer une point-in-time restauration à tout moment pendant la période de conservation automatique des sauvegardes que vous avez spécifiée. Pour plus de détails sur la réalisation d'une point-in-time restauration, consultez[Restaurer à un point dans le temps](backup_restore-point_in_time_recovery.md). 

Vous ne pouvez pas modifier la configuration d'un cluster Amazon DocumentDB, ou de l'une de ses instances, lorsque le cluster est arrêté. De même, vous ne pouvez pas ajouter ou supprimer des instances au niveau du cluster, ni supprimer le cluster si une ou plusieurs instances lui sont toujours associées. Vous devez démarrer le cluster avant d’effectuer des opérations d’administration de ce type.

Amazon DocumentDB applique toute maintenance planifiée à votre cluster arrêté uniquement après son redémarrage. Au bout de sept jours, Amazon DocumentDB démarre automatiquement un cluster arrêté afin qu'il ne prenne pas trop de retard dans son état de maintenance. Lorsque le cluster redémarre, vous êtes à nouveau facturé pour les instances dans le cluster.

Lorsqu'un cluster est arrêté, Amazon DocumentDB n'effectue aucune sauvegarde automatique et ne prolonge pas la période de conservation des sauvegardes.

# Suppression d'un cluster Amazon DocumentDB
<a name="db-cluster-delete"></a>

Vous pouvez supprimer un cluster Amazon DocumentDB à l'aide du AWS Management Console ou du. AWS CLI Pour supprimer un cluster, celui-ci doit être à l'état *disponible* et ne doit pas avoir d'instances associées. Si le cluster est arrêté, commencez par démarrer le cluster, attendez que le cluster devienne *disponible*, puis supprimez le cluster. Pour de plus amples informations, veuillez consulter [Arrêt et démarrage d'un cluster Amazon DocumentDB](db-cluster-stop-start.md). 

## Protection contre la suppression
<a name="db-cluster-deletion-protection"></a>

Pour protéger votre cluster de toute suppression accidentelle, vous pouvez activer la *protection contre la suppression*. La protection contre la suppression est activée par défaut lorsque vous créez un cluster à l'aide de la console. Elle est toutefois désactivée par défaut si vous créez un cluster à l'aide de l' AWS CLI.

Amazon DocumentDB applique la protection contre la suppression à un cluster, que vous exécutiez l'opération de suppression à l'aide de la console ou du. AWS CLI Si la protection contre la suppression est activée, vous ne pouvez pas supprimer de cluster. Pour supprimer un cluster pour lequel la protection contre la suppression est activée, vous devez commencer par modifier le cluster et désactiver la protection contre la suppression.

Lorsque vous utilisez la console avec la protection contre la suppression activée sur un cluster, vous ne pouvez pas supprimer la dernière instance du cluster car cela supprime également le cluster. Vous pouvez supprimer la dernière instance d'un cluster protégé contre la suppression à l’aide de l’ AWS CLI. Toutefois, le cluster lui-même existe toujours, et vos données sont conservées. Vous pouvez accéder aux données en créant de nouvelles instances pour le cluster. Pour plus d'informations sur l'activation et la désactivation de la protection contre la suppression, consultez : 
+ [Création d'un cluster Amazon DocumentDB](db-cluster-create.md)
+ [Modification d'un cluster Amazon DocumentDB](db-cluster-modify.md)

------
#### [ Using the AWS Management Console ]

Pour supprimer un cluster à l'aide du AWS Management Console, la protection contre la suppression doit être désactivée.

**Pour déterminer si la protection contre la suppression est activée pour un cluster :**

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Notez que dans la zone de navigation Clusters, la colonne **Identifiant du cluster** indique à la fois les clusters et les instances. Les instances sont répertoriées sous les clusters, comme dans la capture d'écran ci-dessous.  
![\[Image : la boîte de navigation Clusters affichant une liste des liens de clusters existants et leurs liens d'instance correspondants.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/clusters.png)

1. Choisissez le nom du cluster et sélectionnez l'onglet **Configuration** . Dans la section **Cluster details (Détails du cluster)**, recherchez **Deletion protection (Protection contre la suppression)**. Si la protection contre la suppression est activée, modifiez le cluster pour la désactiver. Pour plus d'informations sur la modification d'un cluster, consultez [Modification d'un cluster Amazon DocumentDB](db-cluster-modify.md). 

   Lorsque **Deletion protection (Protection contre la suppression)** est désactivée, vous pouvez supprimer le cluster.

**Pour supprimer un cluster :**

1. Dans le panneau de navigation, choisissez **Clusters**. 

1. Déterminez si le cluster possède des instances en consultant la colonne **Identifiant du cluster** pour les instances répertoriées en dessous. Avant de pouvoir supprimer un cluster, vous devez supprimer toutes ses instances. Pour de plus amples informations, veuillez consulter [Suppression d'une instance Amazon DocumentDB](db-instance-delete.md). 

1. Selon si votre cluster a des instances, effectuez l'une des étapes suivantes.
   + Si le cluster n'a aucune instance, sélectionnez le bouton situé à gauche du nom du cluster et choisissez **Actions**. Dans le menu déroulant, choisissez **Delete (Supprimer)**. Renseignez la boîte de dialogue **Delete (Supprimer) <nom-cluster>**, puis choisissez **Delete (Supprimer)**. 
   + Si le cluster a une ou plusieurs instances, procédez comme suit :

     1. Dans le panneau de navigation, choisissez **Clusters**.

     1. Supprimez chacune des instances du cluster en cochant la case à gauche du nom du cluster. Choisissez **Actions**, puis **Delete (Supprimer)**. Renseignez la boîte de dialogue **Delete (Supprimer) <nom-cluster>**, puis choisissez **Delete (Supprimer)**.

        Lorsque vous supprimez la dernière instance, le cluster est également supprimé. Pour plus d'informations sur la suppression d'instances, consultez[Suppression d'une instance Amazon DocumentDB](db-instance-delete.md). 

La suppression du cluster prend plusieurs minutes. Pour surveiller le statut du cluster, consultez [Surveillance de l'état d'un cluster Amazon DocumentDB](monitoring_docdb-cluster_status.md). 

------
#### [ Using the AWS CLI ]

Vous ne pouvez pas supprimer un cluster qui a des instances associées. Pour déterminer les instances associées à votre cluster, exécutez la commande `describe-db-clusters` et supprimez toutes les instances du cluster. Ensuite, si nécessaire, désactivez la protection contre la suppression de votre cluster et, enfin, supprimez le cluster.

1. **Tout d'abord, supprimer tous les instances de cluster.**

   Pour déterminer quelles instances vous devez supprimer, exécutez la commande suivante.

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

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

   ```
   [
       [
           "sample-cluster",
           [
               "sample-instance-1",
               "sample-instance-2"
           ]
       ]
   ]
   ```

   Si le cluster que vous souhaitez supprimer a des instances associées, supprimez-les comme indiqué ci-dessous.

   ```
   aws docdb delete-db-instance \
       --db-instance-identifier sample-instance
   ```

1. **Ensuite, désactivez la protection contre la suppression.**

   L'utilisation AWS CLI de pour supprimer toutes les instances d'un cluster ne supprime pas le cluster. Vous devez également supprimer le cluster, mais pour ce faire, la protection contre la suppression doit être désactivée.

   Pour déterminer si la protection contre la suppression est activée pour le cluster, exécutez la commande suivante.
**Astuce**  
Pour connaître l'état de protection contre la suppression de tous vos clusters Amazon DocumentDB, omettez le paramètre. `--db-cluster-identifier`

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

   Le résultat de cette opération ressemble à ceci.

   ```
   [
       [
           "sample-cluster",
           "true"
       ]
   ]
   ```

   Si la protection contre la suppression est activée pour le cluster, modifiez le cluster et désactivez la protection contre la suppression. Pour désactiver la protection contre la suppression sur le cluster, exécutez la commande suivante.

   ```
   aws docdb modify-db-cluster \
       --db-cluster-identifier sample-cluster \
       --no-deletion-protection \
       --apply-immediately
   ```

1. **Enfin, supprimez le cluster.**

   Une fois que la protection contre la suppression est désactivée, vous pouvez supprimer le cluster. Pour supprimer un cluster, utilisez l'opération `delete-db-cluster` avec les paramètres suivants.
   + **--db-cluster-identifier** : obligatoire. Identifiant du cluster que vous souhaitez supprimer.
   + **--final-db-snapshot-identifier**—Facultatif. Si vous voulez un instantané final, vous devez inclure ce paramètre avec un nom pour l'instantané final. Vous devez inclure soit `--final-db-snapshot-identifier` ou `--skip-final-snapshot`.

     Contraintes d'affectation de noms :
     + La longueur est de [1 à 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.
     + Doit être unique pour tous les clusters d'Amazon RDS, Amazon Neptune et Amazon DocumentDB par région Compte AWS.
   + **--skip-final-snapshot**—Facultatif. Utilisez ce paramètre uniquement si vous ne souhaitez pas prendre un instantané final avant de supprimer votre cluster. Le paramètre par défaut consiste à prendre un instantané final. Vous devez inclure soit `--final-db-snapshot-identifier` ou `--skip-final-snapshot`.

   Le AWS CLI code suivant supprime le cluster `sample-cluster` avec un instantané final. L'opération échoue si des instances sont associées au cluster ou si la protection contre la suppression est activée.  
**Example**  

   Pour Linux, macOS ou Unix :

   ```
   aws docdb delete-db-cluster \
       --db-cluster-identifier sample-cluster \
       --final-db-snapshot-identifier sample-cluster-final-snapshot
   ```

   Pour Windows :

   ```
   aws docdb delete-db-cluster ^
       --db-cluster-identifier sample-cluster ^
       --final-db-snapshot-identifier sample-cluster-final-snapshot
   ```  
**Example**  

   Le AWS CLI code suivant supprime le cluster `sample-cluster` sans prendre de capture finale.

   Pour Linux, macOS ou Unix :

   ```
   aws docdb delete-db-cluster \
       --db-cluster-identifier sample-cluster \
       --skip-final-snapshot
   ```

   Pour Windows :

   ```
   aws docdb delete-db-cluster ^
       --db-cluster-identifier sample-cluster ^
       --skip-final-snapshot
   ```

   Le résultat de l'opération `delete-db-cluster` est le cluster que vous allez supprimer.

   La suppression du cluster prend plusieurs minutes. Pour surveiller le statut du cluster, consultez [Surveillance de l'état d'un cluster](monitoring_docdb-cluster_status.md). 

------

# Dimensionnement des clusters Amazon DocumentDB
<a name="db-cluster-manage-performance"></a>

Amazon DocumentDB vous permet de dimensionner le stockage et le calcul de vos clusters en fonction de vos besoins. Cette section décrit comment vous pouvez utiliser le dimensionnement du stockage, le dimensionnement des instances et le dimensionnement de la lecture pour gérer les performances et le dimensionnement de vos clusters et instances Amazon DocumentDB.

**Topics**
+ [Dimensionnement du stockage](#db-cluster-manage-scaling-storage)
+ [Mise à l’échelle d’instances](#db-cluster-manage-scaling-instance)
+ [Dimensionnement en lecture](#db-cluster-manage-scaling-reads)
+ [Evaluation de l'écriture](#db-cluster-manage-scaling-writes)

## Dimensionnement du stockage
<a name="db-cluster-manage-scaling-storage"></a>

Le stockage Amazon DocumentDB s'adapte automatiquement aux données de votre volume de cluster. À mesure que vos données augmentent, le volume de stockage de votre cluster augmente par incréments de 10 GiB, jusqu'à 128 TiB.

## Mise à l’échelle d’instances
<a name="db-cluster-manage-scaling-instance"></a>

Vous pouvez redimensionner votre cluster Amazon DocumentDB selon vos besoins en modifiant la classe d'instance pour chaque instance du cluster. Amazon DocumentDB prend en charge plusieurs classes d'instances optimisées pour Amazon DocumentDB.

Pour de plus amples informations, veuillez consulter [Modification d'une instance Amazon DocumentDB](db-instance-modify.md). 

## Dimensionnement en lecture
<a name="db-cluster-manage-scaling-reads"></a>

Vous pouvez obtenir un dimensionnement de lecture pour votre cluster Amazon DocumentDB en créant jusqu'à 15 répliques Amazon DocumentDB dans le cluster. Chaque réplique Amazon DocumentDB renvoie les mêmes données depuis le volume du cluster avec un décalage de réplication minimal, généralement moins de 100 millisecondes après que l'instance principale a écrit une mise à jour. À mesure que votre trafic de lecture augmente, vous pouvez créer des répliques Amazon DocumentDB supplémentaires et vous y connecter directement pour répartir la charge de lecture de votre cluster. Les répliques Amazon DocumentDB ne doivent pas nécessairement appartenir à la même classe d'instance que l'instance principale. 

Pour de plus amples informations, veuillez consulter [Ajouter une instance Amazon DocumentDB à un cluster](db-instance-add.md). 

Pour augmenter l'échelle de lecture avec Amazon DocumentDB, nous vous recommandons de vous connecter à votre cluster en tant que jeu de répliques et de distribuer les lectures aux instances de réplication à l'aide des fonctionnalités de préférence de lecture intégrées de votre pilote. Pour plus d'informations, consultez [Connexion à Amazon DocumentDB en tant que jeu de répliques](connect-to-replica-set.md).

## Evaluation de l'écriture
<a name="db-cluster-manage-scaling-writes"></a>

Vous pouvez augmenter la capacité d'écriture de votre cluster Amazon DocumentDB en augmentant la taille de l'instance principale de votre cluster. Cette section fournit deux méthodes pour mettre à l'échelle l'instance principale de votre cluster en fonction de vos besoins. La première option vise à minimiser l'impact sur les applications, mais nécessite des étapes supplémentaires. La deuxième option offre plus de simplicité car elle comporte moins d'étapes, mais son impact potentiel sur votre application est plus important. 

Selon votre application, vous pouvez choisir l'approche qui vous convient le mieux. Pour plus d'informations sur les tailles d'instance disponibles et les coûts, consultez la page de [tarification d'Amazon DocumentDB](https://aws.amazon.com/documentdb/pricing/).

1. **Optimisation pour une disponibilité et des performances élevées** : si vous vous connectez à votre cluster en [mode réplica set](connect-to-replica-set.md) (recommandé), vous pouvez utiliser le processus suivant pour minimiser l'impact sur votre application lors du dimensionnement de votre instance principale. Cette méthode minimise l'impact car elle préserve ou accroît la haute disponibilité de votre cluster, et ajoute des cibles de mise à l'échelle en lecture au cluster en tant qu'instances, au lieu de les mettre à jour.

   1. Ajoutez un ou plusieurs réplicas du type d'instance plus important à votre cluster (voir [Ajouter une instance Amazon DocumentDB à un cluster](db-instance-add.md)). Nous recommandons que tous les réplicas soient du même type d'instance ou d'un type d'instance plus important que celui de l'instance principale. Cela évite une diminution involontaire des performances en écriture que provoquerait le basculement vers un type d'instance plus petit. Pour la plupart des clients, cela signifie doubler temporairement le nombre d'instances dans leur cluster, puis supprimer les réplicas plus petits une fois la mise à l'échelle terminée.

   1. Définissez le niveau de basculement sur la priorité zéro pour tous les nouveaux réplicas, en veillant à ce qu'un réplica du type d'instance plus petit ait la priorité de basculement la plus élevée. Pour de plus amples informations, veuillez consulter [Contrôle de la cible de basculement](failover.md#failover-target_control). 

   1. Lancez un basculement manuel, ce qui entraînera la promotion de l'un des nouveaux réplicas en instance principale. Pour de plus amples informations, veuillez consulter [Test du basculement](failover.md#failover-testing). 
**Note**  
Cela entraînera un temps d'arrêt d'environ 30 secondes pour votre cluster. Veuillez prévoir vos opérations en conséquence.

   1. Supprimez du cluster tous les réplicas dont le type d'instance est plus petit que celui de votre nouvelle instance principale.

   1. Redéfinissez le niveau de basculement de toutes les instances sur la même priorité (généralement, cela signifie de les redéfinir sur 1).

   Supposons par exemple que vous avez un cluster qui contient actuellement trois instances `r5.large` (une instance principale et deux réplicas) et que vous souhaitez mettre à l'échelle vers un type d'instance `r5.xlarge`. Pour ce faire, vous devez d'abord ajouter trois instances de réplica `r5.xlarge` à votre cluster, puis définir le niveau de basculement des nouveaux réplicas `r5.xlarge` sur zéro. Vous devez ensuite lancer un basculement manuel (sachant que cela entraînera un temps d'arrêt d'environ 30 secondes de votre application). Une fois le basculement terminé, vous supprimez les trois instances `r5.large` de votre cluster, en laissant le cluster mis à l'échelle avec des instances `r5.xlarge`.

   Pour optimiser les coûts, les instances Amazon DocumentDB sont facturées par tranches d'une seconde, avec un minimum de dix minutes après un changement de statut facturable tel que la création, la modification ou la suppression d'une instance. Pour de plus amples informations, veuillez consulter [Optimisation des coûts](best_practices.md#best_practices-cost_optimization) dans la documentation relative aux bonnes pratiques.

1. **Optimiser pour la simplicité** — Cette approche optimise la simplicité. Il n'étend ni ne contracte le cluster, mais il peut réduire temporairement votre capacité de lecture.

   Il est possible que la modification de la classe d'instance d'une réplique empêche cette instance de traiter les demandes pendant une courte période, de quelques secondes à moins de 30 secondes. Si vous vous connectez à votre cluster en [mode réplica set](connect-to-replica-set.md) (recommandé), cela réduira votre capacité de lecture d'une réplique (par exemple, à 66 % de capacité dans un cluster à 3 nœuds, ou à 75 % de capacité dans un cluster à 4 nœuds, etc.) pendant l'opération de dimensionnement.

   1. Redimensionnez l'une des instances de réplication de votre cluster. Pour de plus amples informations, veuillez consulter [Gestion des classes d'instances](db-instance-classes.md). 

   1. Attendez que l'instance soit disponible (voir[Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md)). 
**Note**  
Cela entraînera un temps d'arrêt d'environ 30 secondes pour votre cluster. Veuillez prévoir vos opérations en conséquence.

   1. Continuez à exécuter les étapes 1 et 2 jusqu'à ce que toutes les instances de répliques aient été redimensionnées, une par une.

   1. Lancez un basculement manuel. Cela fera de l'une des répliques l'instance principale. Pour de plus amples informations, veuillez consulter [Basculement d'Amazon DocumentDB](failover.md).
**Note**  
Cela entraînera jusqu'à 30 secondes d'indisponibilité pour votre cluster, mais cela prend souvent moins de temps que cela. Veuillez prévoir vos opérations en conséquence.

   1. Redimensionnez l'ancienne instance principale (désormais une réplique).

# Clonage d'un volume pour un cluster Amazon DocumentDB
<a name="db-cluster-cloning"></a><a name="cloning"></a>

En utilisant le clonage Amazon DocumentDB, vous pouvez créer un nouveau cluster qui utilise le même volume de cluster Amazon DocumentDB et possède les mêmes données que l'original. Le processus est conçu pour être rapide et rentable. Le nouveau cluster avec son volume de données associé est appelé *clone*. La création d’un clone est plus rapide et plus économe en espace que la copie physique des données à l’aide d’autres techniques telles que la restauration d’instantané.

Amazon DocumentDB prend en charge la création d'un clone provisionné Amazon DocumentDB à partir d'un cluster Amazon DocumentDB provisionné. Lorsque vous créez un clone à l'aide d'une configuration de déploiement différente de celle de la source, le clone est créé à l'aide de la dernière version du moteur Amazon DocumentDB de la source. 

Lorsque vous créez des clones à partir de vos clusters Amazon DocumentDB, les clones sont créés dans AWS votre compte, le même compte qui possède le cluster Amazon DocumentDB source. 

**Topics**
+ [Présentation du clonage d'Amazon DocumentDB](#db-cloning-overview)
+ [Limites du clonage d'Amazon DocumentDB](#db-cloning-limitations)
+ [Comment fonctionne le clonage d'Amazon DocumentDB](#db-how-db-cloning-works)
+ [Création d'un clone Amazon DocumentDB](#db-creating-db-clone)

## Présentation du clonage d'Amazon DocumentDB
<a name="db-cloning-overview"></a>

Amazon DocumentDB utilise un *copy-on-write protocole* pour créer un clone. Ce mécanisme utilise un espace supplémentaire minimal pour créer un clone initial. Lorsque le clone est créé pour la première fois, Amazon DocumentDB conserve une copie unique des données utilisées par le cluster de base de données source et le nouveau cluster Amazon DocumentDB (cloné). Du stockage supplémentaire est alloué uniquement lorsque des modifications sont apportées aux données (sur le volume de stockage Amazon DocumentDB) par le cluster Amazon DocumentDB source ou le clone du cluster Amazon DocumentDB. Pour en savoir plus sur le copy-on-write protocole, voir[Comment fonctionne le clonage d'Amazon DocumentDB](#db-how-db-cloning-works). 

Le clonage Amazon DocumentDB est particulièrement utile pour configurer rapidement des environnements de test à l'aide de vos données de production, sans risquer de les corrompre. Vous pouvez utiliser des clones pour de nombreux types d’applications, telles que les suivantes :
+ Expérimentez des changements potentiels (par exemple, des changements de schémas et de groupes de paramètres) pour évaluer tous les impacts. 
+ Exécutez des opérations imposant une charge de travail élevée, telles que l’exportation de données ou l’exécution de requêtes analytiques sur le clone. 
+ Créez une copie de votre cluster de bases de données de production à des fins de développement, de test ou autres.

Vous pouvez créer plusieurs clones à partir du même cluster Amazon DocumentDB. Vous pouvez également créer plusieurs clones à partir d’un autre clone. 

Après avoir créé un clone Amazon DocumentDB, vous pouvez configurer les instances Amazon DocumentDB différemment du cluster Amazon DocumentDB source. Par exemple, il se peut que vous n'ayez pas besoin d'un clone à des fins de développement pour répondre aux mêmes exigences de haute disponibilité que le cluster Amazon DocumentDB de production source. Dans ce cas, vous pouvez configurer le clone avec une seule instance Amazon DocumentDB plutôt qu'avec les multiples instances de base de données utilisées par le cluster Amazon DocumentDB.

Lorsque vous avez fini d’utiliser le clone à des fins de test, de développement ou autres, vous pouvez le supprimer.

## Limites du clonage d'Amazon DocumentDB
<a name="db-cloning-limitations"></a>

Amazon DocumentDB ; le clonage présente actuellement les limites suivantes :
+ Vous pouvez créer autant de clones que vous le souhaitez, jusqu'au nombre maximal de clusters de bases de données autorisés dans la Région AWS. Toutefois, lorsque vous avez créé 15 clones, le 16ème est une copie intégrale. L'opération de clonage agit comme une point-in-time restauration.
+ Vous ne pouvez pas créer de clone dans une AWS région différente de celle du cluster Amazon DocumentDB source.
+ Vous ne pouvez pas créer de clone à partir d'un cluster Amazon DocumentDB dépourvu d'instances de base de données. Vous ne pouvez cloner que des clusters Amazon DocumentDB dotés d'au moins une instance de base de données.
+ Vous pouvez créer un clone dans un cloud privé virtuel (VPC) différent de celui du cluster Amazon DocumentDB. Dans ce cas, les sous-réseaux de VPCs doivent correspondre aux mêmes zones de disponibilité.

## Comment fonctionne le clonage d'Amazon DocumentDB
<a name="db-how-db-cloning-works"></a>

Le clonage Amazon DocumentDB fonctionne au niveau de la couche de stockage d'un cluster Amazon DocumentDB. Il utilise un *copy-on-write*protocole à la fois rapide et peu encombrant en termes de support durable sous-jacent supportant le volume de stockage Amazon DocumentDB. Vous pouvez en savoir plus sur les volumes de cluster Amazon DocumentDB dans. [Gestion des clusters Amazon DocumentDB](db-clusters.md) 

**Topics**
+ [Comprendre le copy-on-write protocole](#db-copy-on-write-protocol)
+ [Suppression d'un volume de cluster source](#db-deleting-source-cluster-volume)

### Comprendre le copy-on-write protocole
<a name="db-copy-on-write-protocol"></a>

Un cluster Amazon DocumentDB stocke les données dans des pages du volume de stockage Amazon DocumentDB sous-jacent. 

Par exemple, dans le schéma suivant, vous pouvez trouver un cluster Amazon DocumentDB (A) comportant quatre pages de données, 1, 2, 3 et 4. Imaginez qu'un clone, B, soit créé à partir du cluster Amazon DocumentDB. Lors de la création du clone, aucune donnée n’est copiée. Le clone pointe plutôt vers le même ensemble de pages que le cluster Amazon DocumentDB source.

![\[Volume de cluster Amazon DocumentDB avec 4 pages pour le cluster source, A, et le clone, B\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cloning-copy-on-write-protocol-1.png)


Lors de la création du clone, aucun stockage supplémentaire n’est généralement nécessaire. Le copy-on-write protocole utilise le même segment sur le support de stockage physique que le segment source. Un stockage supplémentaire n’est requis que si la capacité du segment source n’est pas suffisante pour le segment de clone entier. Dans ce cas, le segment source est copié sur un autre périphérique physique. 

Dans les diagrammes suivants, vous pouvez trouver un exemple du copy-on-write protocole en action utilisant le même cluster A et son clone, B, comme indiqué ci-dessus. Supposons que vous apportiez une modification à votre cluster Amazon DocumentDB (A) qui entraîne une modification des données contenues sur la page 1. Au lieu d'écrire sur la page 1 d'origine, Amazon DocumentDB crée une nouvelle page 1 [A]. Le volume du cluster Amazon DocumentDB pour le cluster (A) pointe désormais vers les pages 1 [A], 2, 3 et 4, tandis que le clone (B) fait toujours référence aux pages d'origine. 

![\[Volume du cluster de base de données source Amazon DocumentDB et son clone, tous deux modifiés.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cloning-copy-on-write-protocol-2.png)


Sur le clone, une modification est apportée à la page 4 sur le volume de stockage. Au lieu d'écrire sur la page 4 d'origine, Amazon DocumentDB crée une nouvelle page, 4 [B]. Le clone pointe maintenant vers les pages 1, 2, 3 et 4[B], tandis que le cluster (A) continue de pointer vers les pages 1[A], 2, 3 et 4. 

![\[Volume du cluster de base de données source Amazon DocumentDB et son clone, tous deux modifiés.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cloning-copy-on-write-protocol-3.png)


Au fur et à mesure que de nouvelles modifications se produisent au fil du temps, à la fois dans le volume du cluster Amazon DocumentDB source et dans le clone, davantage de stockage est nécessaire pour capturer et stocker les modifications. 

### Suppression d'un volume de cluster source
<a name="db-deleting-source-cluster-volume"></a>

Lorsque vous supprimez un volume de cluster source auquel un ou plusieurs clones sont associés, ceux-ci ne sont pas affectés. Les clones continuent de pointer vers les pages qui étaient précédemment la propriété du volume de cluster source. 

## Création d'un clone Amazon DocumentDB
<a name="db-creating-db-clone"></a>

Vous pouvez créer un clone dans le même AWS compte que le cluster Amazon DocumentDB source. Pour ce faire, vous pouvez utiliser le AWS Management Console ou les AWS CLI et les procédures suivantes.

En utilisant le clonage Amazon DocumentDB, vous pouvez créer un clone de cluster Amazon DocumentDB provisionné à partir d'un cluster Amazon DocumentDB provisionné.

------
#### [ Using the AWS Management Console ]

La procédure suivante décrit comment cloner un cluster Amazon DocumentDB à l'aide du. AWS Management Console

Création d'un clone à l'aide des AWS Management Console résultats dans un cluster Amazon DocumentDB avec une instance Amazon DocumentDB.

 Ces instructions s'appliquent aux clusters de base de données appartenant au même AWS compte qui crée le clone. Le cluster de base de données doit appartenir au même AWS compte, car le clonage entre comptes n'est pas pris en charge dans Amazon DocumentDB. 

**Pour créer un clone d'un cluster de base de données appartenant à votre AWS compte à l'aide du AWS Management Console**

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

1. Dans le panneau de navigation, choisissez **Clusters**. 

1. Choisissez votre cluster Amazon DocumentDB dans la liste, et pour **Actions**, choisissez **Create** clone.  
![\[La création d'un clone commence par la sélection de votre cluster Amazon DocumentDB.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cloning-create-clone-1.png)

   La page Créer un clone s'ouvre, où vous pouvez configurer un **identifiant de cluster** et une **classe d'instance**, ainsi que d'autres options pour le clone de cluster Amazon DocumentDB. 

1. Dans la section **Settings** (Paramètres), procédez comme suit :

   1. Dans le **champ Identifiant du cluster**, entrez le nom que vous souhaitez attribuer à votre cluster Amazon DocumentDB cloné.

   1. Pour la **configuration de l'instance**, sélectionnez une **classe d'instance** appropriée pour votre cluster Amazon DocumentDB cloné.  
![\[La création d'un clone commence par la sélection de votre cluster Amazon DocumentDB et la spécification d'une taille d'instance de base de données.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cloning-create-clone-2.png)

   1.  Pour les **paramètres réseau**, choisissez un **groupe de sous-réseaux** pour votre cas d'utilisation et les groupes de sécurité VPC associés. 

   1.  Pour **E ncryption-at-rest**, si le chiffrement est activé sur le cluster source (le cluster cloné), le chiffrement doit également être activé sur le cluster cloné. Si ce scénario est vrai, les options **Activer le chiffrement** sont grisées (désactivées) mais l'option **Activer le chiffrement** est sélectionnée. À l'inverse, si le chiffrement n'est pas activé dans le cluster source, les options **Activer le chiffrement** sont disponibles et vous pouvez choisir d'activer ou de désactiver le chiffrement.   
![\[Spécifiez les paramètres réseau et de chiffrement pour votre clone de cluster Amazon DocumentDB.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cloning-create-clone-3-nw-encryption.png)

   1. Complétez la nouvelle configuration du clone de cluster en sélectionnant le type de journaux à exporter (facultatif), en saisissant un port spécifique utilisé pour se connecter au cluster et en activant la protection contre la suppression accidentelle du cluster (activée par défaut).  
![\[Complétez la nouvelle configuration du clone en sélectionnant éventuellement le type de journaux à exporter, un port spécifique utilisé pour se connecter au cluster et une protection contre la suppression accidentelle du cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cloning-create-clone-4-log-options-del-prot-b.png)

   1. Terminez de saisir tous les paramètres de votre clone de cluster Amazon DocumentDB. Pour en savoir plus sur les paramètres du cluster et de l'instance Amazon DocumentDB, consultez. [Gestion des clusters Amazon DocumentDB](db-clusters.md) 

1. Choisissez **Create clone** pour lancer le clone Amazon DocumentDB du cluster Amazon DocumentDB de votre choix.

Lorsque le clone est créé, il est répertorié avec vos autres clusters Amazon DocumentDB dans la section **Bases** de données de la console et affiche son état actuel. Votre clone est prêt à être utilisé quand son état est **Disponible**.

------
#### [ Using the AWS CLI ]

L'utilisation du AWS CLI pour cloner votre cluster Amazon DocumentDB implique quelques étapes. 

La `restore-db-cluster-to-point-in-time` AWS CLI commande que vous utilisez génère un cluster Amazon DocumentDB vide avec 0 instance Amazon DocumentDB. En d'autres termes, la commande restaure uniquement le cluster Amazon DocumentDB, et non les instances de base de données de ce cluster. Vous faites cela séparément une fois le clone disponible. Les deux étapes du processus sont les suivantes : 

1. Créez le clone à l'aide de la commande [restore-db-cluster-to- point-in-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html) CLI. Les paramètres que vous utilisez avec cette commande contrôlent le type de capacité et d'autres détails du cluster Amazon DocumentDB vide (clone) en cours de création. 

1. Créez l'instance Amazon DocumentDB pour le clone à l'aide de la commande [create-db-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html)CLI pour recréer l'instance Amazon DocumentDB dans le cluster Amazon DocumentDB restauré. 

Les commandes suivantes supposent que votre AWS région AWS CLI est configurée par défaut. Cette approche vous évite de passer le nom de `--region` dans chaque commande. Pour plus d'informations, consultez [Configuration de l' AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html). Vous pouvez également spécifier la `--region` dans chacune des commandes de la CLI qui suivent. 

**Topics**

**Création du clone**

Les paramètres spécifiques que vous passez à la commande de la CLI `[restore-db-cluster-to-point-in-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html)` varient. Ce que vous transmettez dépend du type de clone que vous souhaitez créer.

Utilisez la procédure suivante pour créer un clone Amazon DocumentDB provisionné à partir d'un cluster Amazon DocumentDB provisionné. 

**Pour créer un clone du même mode de moteur que le cluster Amazon DocumentDB source**
+ Utilisez la commande de la CLI `[restore-db-cluster-to-point-in-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html)` et spécifiez les valeurs des paramètres suivants :
  + `--db-cluster-identifier` – Choisissez un nom explicite pour votre clone. Vous nommez le clone lorsque vous utilisez la commande [restore-db-cluster-to- point-in-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html) CLI. 
  + `--restore-type` : utilisez la commande `copy-on-write` pour créer un clone du cluster de bases de données source. Sans ce paramètre, le cluster Amazon DocumentDB `restore-db-cluster-to-point-in-time` restaure plutôt que de créer un clone. La valeur par défaut pour `restore-type` est`full-copy`.
  + `--source-db-cluster-identifier`— Utilisez le nom du cluster Amazon DocumentDB source que vous souhaitez cloner.
  + `--use-latest-restorable-time` – Cette valeur pointe vers les données de volume restaurables les plus récentes pour le clone. Ce paramètre est obligatoire car`restore-type copy-on-write`, cependant, vous ne pouvez pas utiliser le `restore-to-time parameter` avec.

L'exemple suivant crée un clone nommé `my-clone` à partir d'un cluster nommé `my-source-cluster`.

Pour Linux, macOS ou Unix :

```
aws docdb restore-db-cluster-to-point-in-time \
    --source-db-cluster-identifier my-source-cluster \
    --db-cluster-identifier my-clone \
    --restore-type copy-on-write \
    --use-latest-restorable-time
```

Pour Windows :

```
aws docdb restore-db-cluster-to-point-in-time ^
    --source-db-cluster-identifier my-source-cluster ^
    --db-cluster-identifier my-clone ^
    --restore-type copy-on-write ^
    --use-latest-restorable-time
```

La commande renvoie l'objet JSON contenant les détails du clone. Vérifiez que votre cluster de bases de données cloné est disponible avant d’essayer de créer l’instance de base de données pour votre clone. Pour plus d'informations, consultez la section Vérification de l'état et obtention des informations relatives au clone ci-dessous : 

**Vérifier le statut et obtenir les détails du clone**

Vous pouvez utiliser la commande suivante pour vérifier l'état de votre cluster de base de données vide nouvellement créé.

```
$ aws docdb describe-db-clusters --db-cluster-identifier my-clone --query '*[].[Status]' --output text
```

Vous pouvez également obtenir le statut et les autres valeurs dont vous avez besoin pour créer l'instance de base de données pour votre clone en utilisant la AWS CLI requête suivante : 

Pour Linux, macOS ou Unix :

```
aws docdb describe-db-clusters --db-cluster-identifier my-clone \
  --query '*[].{Status:Status,Engine:Engine,EngineVersion:EngineVersion}'
```

Pour Windows :

```
aws docdb describe-db-clusters --db-cluster-identifier my-clone ^
  --query "*[].{Status:Status,Engine:Engine,EngineVersion:EngineVersion}"
```

Cette requête retourne une sortie similaire à la suivante.

```
[
  {
        "Status": "available",
        "Engine": "docdb",
        "EngineVersion": "4.0.0",
    }
]
```

**Création de l'instance Amazon DocumentDB pour votre clone**

Utilisez la commande [create-db-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html)CLI pour créer l'instance de base de données pour votre clone. 

Le `--db-instance-class` paramètre est utilisé uniquement pour les clusters Amazon DocumentDB provisionnés.

Pour Linux, macOS ou Unix :

```
aws docdb create-db-instance \
    --db-instance-identifier my-new-db \
    --db-cluster-identifier my-clone \
    --db-instance-class  db.r5.4xlarge \
    --engine docdb
```

Pour Windows :

```
aws docdb create-db-instance ^
    --db-instance-identifier my-new-db ^
    --db-cluster-identifier my-clone ^
    --db-instance-class  db.r5.4xlarge ^
    --engine docdb
```

**Paramètres à utiliser pour le clonage**

Le tableau suivant récapitule les différents paramètres utilisés pour cloner des `restore-db-cluster-to-point-in-time` clusters Amazon DocumentDB.


| Paramètre | Description | 
| --- | --- | 
|  --source-db-cluster-identifier | Utilisez le nom du cluster Amazon DocumentDB source que vous souhaitez cloner. | 
|  --db-cluster-identifier | Choisissez un nom explicite pour votre clone. Vous nommez votre clone à l'aide de la commande ` restore-db-cluster-to-point-in-time`. Ensuite, vous passez ce nom à la commande `create-db-instance`.  | 
|  —type de restauration | Spécifiez `copy-on-write` comme `--restore-type` pour créer un clone du cluster de base de données source plutôt que de restaurer le cluster Amazon DocumentDB source.  | 
|  --use-latest-restorable-time | Cette valeur pointe vers les données de volume restaurables les plus récentes pour le clone. | 

------

# Comprendre la tolérance aux pannes des clusters Amazon DocumentDB
<a name="db-cluster-fault-tolerance"></a>

Les clusters Amazon DocumentDB sont par conception tolérants aux pannes. Le volume de chaque cluster couvre plusieurs zones de disponibilité en une seule Région AWS, et chaque zone de disponibilité contient une copie des données de volume du cluster. Cette fonctionnalité signifie que votre cluster peut tolérer une défaillance d'une zone de disponibilité sans perte de données et uniquement une brève interruption de service. 

En cas de défaillance de l'instance principale d'un cluster, Amazon DocumentDB effectue automatiquement un basculement vers une nouvelle instance principale de deux manières :
+ En promouvant une réplique Amazon DocumentDB existante vers la nouvelle instance principale choisie en fonction du paramètre de niveau de promotion de chaque réplique, puis en créant une instance de remplacement pour l'ancienne instance principale. Le basculement vers l'instance de réplique prend généralement moins de 30 secondes. Les opérations de lecture et d'écriture peuvent être brièvement interrompues pendant cette période. Pour augmenter la disponibilité de votre cluster, nous vous recommandons de créer au moins une ou plusieurs répliques Amazon DocumentDB dans au moins deux zones de disponibilité différentes.
+ Par la création d'une nouvelle instance principale. Cela ne se produit que si vous ne disposez pas d'une instance de réplication dans votre cluster et cela peut prendre quelques minutes.

Si le cluster possède une ou plusieurs répliques Amazon DocumentDB, une réplique Amazon DocumentDB est promue en instance principale en cas de défaillance. Un événement d'échec se traduit par une brève interruption, pendant laquelle les opérations de lecture et d'écriture échouent avec une exception. Cependant, le service est généralement restauré en moins de 120 secondes, et souvent en moins de 60 secondes. Pour augmenter la disponibilité de votre cluster, nous vous recommandons de créer au moins une ou plusieurs répliques Amazon DocumentDB dans au moins deux zones de disponibilité différentes. 

Vous pouvez personnaliser l'ordre dans lequel vos répliques Amazon DocumentDB sont promues vers l'instance principale après une panne en attribuant une priorité à chaque réplique. Les priorités s’étendent de la valeur 0 pour la plus haute priorité à la valeur 15 pour la plus basse priorité. En cas de défaillance de l'instance principale, la réplique Amazon DocumentDB ayant la priorité la plus élevée est promue vers la nouvelle instance principale. Vous pouvez modifier la priorité d'une réplique Amazon DocumentDB à tout moment. La modification de la priorité ne déclenche pas un basculement. Vous pouvez utiliser l'opération `modify-db-instance` avec le paramètre `--promotion-tier`. Pour en savoir plus sur la personnalisation de la priorité de basculement d'une instance, consultez [Basculement d'Amazon DocumentDB](failover.md).

Plusieurs répliques Amazon DocumentDB peuvent partager la même priorité, ce qui se traduit par des niveaux de promotion. Si deux répliques Amazon DocumentDB ou plus partagent la même priorité, la réplique la plus grande est promue en tant que réplique principale. Si deux répliques Amazon DocumentDB ou plus partagent la même priorité et la même taille, une réplique arbitraire appartenant au même niveau de promotion est promue. 

Si le cluster ne contient aucune réplique Amazon DocumentDB, l'instance principale est recréée lors d'un événement de défaillance. Un événement d'échec se traduit par une interruption, pendant laquelle les opérations de lecture et d'écriture échouent avec une exception. Le service est rétabli quand la nouvelle instance principale est créée, ce qui prend généralement moins de 10 minutes. La promotion d'une réplique Amazon DocumentDB vers l'instance principale est beaucoup plus rapide que la création d'une nouvelle instance principale. 

# Gestion des instances Amazon DocumentDB
<a name="db-instances"></a>

Les rubriques suivantes fournissent des informations qui vous aideront à gérer vos instances Amazon DocumentDB. Elles incluent des détails sur les classes et les statuts des instances, et sur la façon de créer, supprimer et modifier une instance.

**Topics**
+ [Déterminer le statut d'une instance](#db-instance-status)
+ [Cycle de vie d’une instance](db-instance-life-cycle.md)
+ [Gestion des classes d'instances](db-instance-classes.md)
+ [Instances basées sur les volumes NVMe](db-instance-nvme.md)

## Déterminer le statut d'une instance
<a name="db-instance-status"></a>

Pour connaître les statuts d'instance valides, leur signification et savoir comment identifier le statut de vos instances, consultez [Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md).

# Cycle de vie des instances Amazon DocumentDB
<a name="db-instance-life-cycle"></a>

Le cycle de vie d'une instance Amazon DocumentDB inclut la création, la modification, la maintenance et la mise à niveau, l'exécution de sauvegardes et de restaurations, le redémarrage et la suppression de l'instance. Cette section fournit des informations sur la façon de réaliser ces processus. 

**Topics**
+ [Ajouter une instance](db-instance-add.md)
+ [Décrire les instances](db-instance-view-details.md)
+ [Modification d'une instance](db-instance-modify.md)
+ [Redémarrage d'une instance](db-instance-reboot.md)
+ [Suppression d'une instance](db-instance-delete.md)

Vous pouvez créer une nouvelle instance Amazon DocumentDB à l'aide du AWS Management Console ou du. AWS CLI Pour ajouter une instance à un cluster, le cluster doit être dans un état *available (disponible)*. Vous ne pouvez pas ajouter une instance à un cluster qui est arrêté. Si le cluster est arrêté, commencez par démarrer le cluster, attendez que le cluster devienne *disponible*, puis ajoutez une instance. Pour de plus amples informations, veuillez consulter [Arrêt et démarrage d'un cluster Amazon DocumentDB](db-cluster-stop-start.md). 

**Note**  
Si vous créez un cluster Amazon DocumentDB à l'aide de la console, une instance est automatiquement créée pour vous en même temps. Si vous souhaitez créer des instances supplémentaires, appliquez l'une des procédures suivantes.

# Ajouter une instance Amazon DocumentDB à un cluster
<a name="db-instance-add"></a>

------
#### [ Using the AWS Management Console ]

Utilisez la procédure suivante pour créer une instance pour votre cluster à l'aide de la console Amazon DocumentDB.

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Pour choisir le cluster auquel vous voulez ajouter une instance, sélectionnez le bouton à gauche du nom du cluster.

1. Choisissez **Actions**, puis **Add instances (Ajouter des instances)**.

1. Dans la page **Add instance to: (Ajouter une instance à :)<cluster-name>**, répétez les étapes suivantes pour chaque instance que vous souhaitez ajouter au cluster. Vous pouvez en avoir jusqu'à 15.

   1. **Identifiant d'instance** : vous pouvez saisir un identifiant unique pour cette instance ou autoriser Amazon DocumentDB à fournir l'identifiant d'instance en fonction de l'identifiant de cluster.

      Contraintes d'affectation de noms :
      + La longueur est de [1 à 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.
      + Doit être unique pour toutes les instances d'Amazon RDS, Neptune et Amazon Compte AWS DocumentDB par région.

   1. **Classe d'instance** : dans la liste déroulante, choisissez le type d'instance que vous souhaitez pour cette instance.

   1. **Niveau de promotion** : dans la liste déroulante, choisissez le niveau de promotion pour votre instance ou choisissez *Aucune préférence* pour autoriser Amazon DocumentDB à définir le niveau de promotion pour votre instance. Plus le chiffre est bas, plus la priorité est élevée. Pour de plus amples informations, veuillez consulter [Contrôle de la cible de basculement](failover.md#failover-target_control).

   1. Pour ajouter d'autres instances, choisissez **Add additional instances (Ajouter des instances supplémentaires)** et répétez les étapes a, b et c.

1. Mettez fin à l'opération.
   + Pour ajouter des instances à votre cluster, choisissez **Create (Créer)**.
   + Pour annuler l'opération, choisissez **Annuler**.

La création d'une instance prend quelques minutes. Vous pouvez utiliser la console ou AWS CLI consulter le statut de l'instance. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'une instance](monitoring_docdb-instance_status.md). 

------
#### [ Using the AWS CLI ]

Utilisez l'`create-db-instance` AWS CLI opération avec les paramètres suivants pour créer l'instance principale de votre cluster.
+ **--db-instance-class** — Obligatoire. La capacité de calcul et de mémoire de l'instance, par exemple `db.m4.large`. Les classes d'instance ne sont pas toutes disponibles Régions AWS.
+ **--db-instance-identifier** — Obligatoire. Chaîne en minuscules () qui identifie l'instance.

  Contraintes d'affectation de noms :
  + La longueur est de [1 à 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.
  + Doit être unique pour toutes les instances d'Amazon RDS, Neptune et Amazon Compte AWS DocumentDB par région.
+ **--engine** — Obligatoire. Doit indiquer `docdb`.
+ **--availability-zone**— Facultatif La zone de disponibilité dans laquelle vous voulez créer l'instance. Utilisez ce paramètre pour localiser vos instances dans différentes zones de disponibilité, afin d'accroître la tolérance aux pannes. Pour de plus amples informations, veuillez consulter [Amazon DocumentDB Haute disponibilité et réplication](replication.md). 
+ **--promotion-tier**— Facultatif Le niveau de priorité de basculement pour cette instance. Il doit être compris entre 0 et 15, les chiffres les plus bas indiquant une priorité plus élevée. Pour de plus amples informations, veuillez consulter [Contrôle de la cible de basculement](failover.md#failover-target_control). 

1. **Tout d'abord, déterminez dans quelles zones de disponibilité vous pouvez créer votre instance. **

   Si vous souhaitez spécifier la zone de disponibilité avant de créer votre instance, exécutez la commande suivante pour déterminer quelles zones de disponibilité sont disponibles pour votre cluster Amazon DocumentDB.

   Pour Linux, macOS ou Unix :

   ```
   aws docdb describe-db-clusters \
          --query 'DBClusters[*].[DBClusterIdentifier,AvailabilityZones[*]]'
   ```

   Pour Windows :

   ```
   aws docdb describe-db-clusters ^
          --query 'DBClusters[*].[DBClusterIdentifier,AvailabilityZones[*]]'
   ```

   Le résultat de cette opération ressemble à ceci.

   ```
   [
       [
           "sample-cluster",
           [
               "us-east-1c",
               "us-east-1b",
               "us-east-1a"
           ]
       ]
   ]
   ```

1. **Ensuite, identifiez les classes d'instance que vous pouvez créer dans votre région. **

   Pour déterminer quelles classes d'instances sont disponibles dans votre région, exécutez la commande suivante. Dans la sortie, choisissez une classe d'instance pour l'instance que vous souhaitez ajouter à votre cluster Amazon DocumentDB. 

   Pour Linux, macOS ou Unix :

   ```
   aws docdb describe-orderable-db-instance-options \
           --engine docdb \
           --query 'OrderableDBInstanceOptions[*].DBInstanceClass'
   ```

   Pour Windows :

   ```
   aws docdb describe-orderable-db-instance-options ^
           --engine docdb ^
           --query 'OrderableDBInstanceOptions[*].DBInstanceClass'
   ```

   Le résultat de cette opération ressemble à ceci.

   ```
   [
       "db.r5.16xlarge",
       "db.r5.2xlarge",
       "db.r5.4xlarge",
       "db.r5.8xlarge",
       "db.r5.large",
       "db.r5.xlarge"
   ]
   ```

1. **Enfin, ajoutez une instance à votre cluster Amazon DocumentDB.**

   Pour ajouter une instance à votre cluster Amazon DocumentDB, exécutez la commande suivante.

   Pour Linux, macOS ou Unix :

   ```
   aws docdb create-db-instance \
          --db-cluster-identifier sample-cluster \
          --db-instance-identifier sample-instance-2 \
          --availability-zone us-east-1b \
          --promotion-tier 2 \
          --db-instance-class db.r5.xlarge \
          --engine docdb
   ```

   Pour Windows :

   ```
   aws docdb create-db-instance ^
          --db-cluster-identifier sample-cluster ^
          --db-instance-identifier sample-instance-2 ^
          --availability-zone us-east-1b ^
          --promotion-tier 2 ^
          --db-instance-class db.r5.xlarge ^
          --engine docdb
   ```

   Le résultat de cette opération ressemble à ceci.

   ```
   {
       "DBInstance": {
           "DBInstanceIdentifier": "sample-instance-2",
           "DBInstanceClass": "db.r5.xlarge",
           "Engine": "docdb",
           "DBInstanceStatus": "creating",
           "PreferredBackupWindow": "02:00-02:30",
           "BackupRetentionPeriod": 1,
           "VpcSecurityGroups": [
               {
                   "VpcSecurityGroupId": "sg-abcd0123",
                   "Status": "active"
               }
           ],
           "AvailabilityZone": "us-east-1b",
           "DBSubnetGroup": {
               "DBSubnetGroupName": "default",
               "DBSubnetGroupDescription": "default",
               "VpcId": "vpc-6242c31a",
               "SubnetGroupStatus": "Complete",
               "Subnets": [
                   {
                       "SubnetIdentifier": "subnet-abcd0123",
                       "SubnetAvailabilityZone": {
                           "Name": "us-west-2a"
                       },
                       "SubnetStatus": "Active"
                   },
                   {
                       "SubnetIdentifier": "subnet-wxyz0123",
                       "SubnetAvailabilityZone": {
                           "Name": "us-west-2b"
                       },
                       "SubnetStatus": "Active"
                   }
               ]
           },
           "PreferredMaintenanceWindow": "sun:11:35-sun:12:05",
           "PendingModifiedValues": {},
           "EngineVersion": "3.6.0",
           "AutoMinorVersionUpgrade": true,
           "PubliclyAccessible": false,
           "DBClusterIdentifier": "sample-cluster",
           "StorageEncrypted": true,
           "KmsKeyId": "arn:aws:kms:us-east-1:<accountID>:key/sample-key",
           "DbiResourceId": "db-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
           "CACertificateIdentifier": "rds-ca-2019",
           "PromotionTier": 2,
           "DBInstanceArn": "arn:aws:rds:us-east-1:<accountID>:db:sample-instance-2"
       }
   }
   ```

La création de l'instance prend quelques minutes. Vous pouvez utiliser la console ou AWS CLI consulter le statut de l'instance. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md). 

------

# Décrire les instances Amazon DocumentDB
<a name="db-instance-view-details"></a>

Vous pouvez utiliser la console de gestion Amazon DocumentDB ou le AWS CLI pour consulter des informations telles que les points de terminaison de connexion, les groupes de sécurité, l'autorité de certification et les groupes VPCs de paramètres relatifs à vos instances Amazon DocumentDB.

------
#### [ Using the AWS Management Console ]

Pour afficher les détails de vos instances à l'aide de l’ AWS Management Console, suivez les étapes ci-dessous.

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans la boîte de navigation Clusters, vous verrez la colonne **Cluster Identifier**. Vos instances sont répertoriées sous des clusters, comme dans la capture d'écran ci-dessous.  
![\[Tableau des clusters présentant la liste des clusters sous la colonne Identifiant du cluster, avec les instances imbriquées dans les clusters.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/choose-clusters.png)

1. Dans la liste des instances, choisissez le nom de l'instance dont vous souhaitez voir les détails. Les informations relatives à l'instance sont organisées dans les groupes suivants :
   + **Résumé** : informations générales sur l'instance, notamment la version du moteur, la classe, le statut et toute maintenance en attente.
   + **Connectivité et sécurité** : la section **Connect** répertorie les points de terminaison de connexion permettant de se connecter à cette instance avec le shell mongo ou une application. La section **Security Groups (Groupes de sécurité)** répertorie les groupes de sécurité associés à cette instance ainsi que leur ID et de VPC et leurs descriptions.
   + **Configuration** : la section **Détails** répertorie les configurations et le statut de l'instance, y compris le nom de ressource Amazon (ARN), le point de terminaison, le rôle, la classe et l'autorité de certification de l'instance. Elle répertorie également les paramètres de sécurité et de réseau de l'instance, ainsi que les informations de sauvegarde. La section **Cluster details (Détails du cluster)** répertorie les détails du cluster auquel cette instance appartient. La section **Cluster instances (Instances de cluster)** répertorie toutes les instances appartenant à votre cluster avec l'état du rôle et du groupe de paramètres de cluster de chaque instance.
**Note**  
Vous pouvez modifier le cluster associé à votre instance en sélectionnant **Modify (Modifier)** en regard de l'en-tête **Cluster details (Détails du cluster)**. Pour de plus amples informations, veuillez consulter [Modification d'un cluster Amazon DocumentDB](db-cluster-modify.md). 
   + **Surveillance** : CloudWatch enregistre les métriques pour cette instance. Pour de plus amples informations, veuillez consulter [Surveillance d'Amazon DocumentDB avec CloudWatch](cloud_watch.md). 
   + **Événements et tags** : la section **Événements récents** répertorie les événements récents pour cette instance. Amazon DocumentDB conserve un enregistrement des événements liés à vos clusters, instances, instantanés, groupes de sécurité et groupes de paramètres de cluster. Ces informations comprennent la date, l'heure et le message associés à chaque événement. La section **Tags (Balises)** répertorie les balises attachées à ce cluster. Pour de plus amples informations, veuillez consulter [Balisage des ressources Amazon DocumentDB](tagging.md).

------
#### [ Using the AWS CLI ]

Pour consulter les détails de vos instances Amazon DocumentDB à l'aide de AWS CLI, utilisez la `describe-db-clusters` commande comme indiqué dans les exemples ci-dessous. Pour plus d'informations, consultez le document [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBInstances.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBInstances.html)de référence de l'*API de gestion des ressources Amazon DocumentDB*. 

**Note**  
Pour certaines fonctionnalités de gestion telles que la gestion du cycle de vie des clusters et des instances, Amazon DocumentDB utilise une technologie opérationnelle partagée avec Amazon RDS. Le paramètre de `filterName=engine,Values=docdb` filtre renvoie uniquement les clusters Amazon DocumentDB.

1. **Répertoriez toutes les instances Amazon DocumentDB.**

   Le AWS CLI code suivant répertorie les détails de toutes les instances Amazon DocumentDB d'une région.

   Pour Linux, macOS ou Unix :

   ```
   aws docdb describe-db-instances \
       --filter Name=engine,Values=docdb
   ```

   Pour Windows :

   ```
   aws docdb describe-db-instances \
       --filter Name=engine,Values=docdb
   ```

1. **Répertorier tous les détails d'une instance Amazon DocumentDB spécifiée**

   Le code suivant répertorie les détails de `sample-cluster-instance`. L'inclusion du paramètre `--db-instance-identifier` avec le nom d'une instance limite la sortie aux informations sur cette instance particulière.

   Pour Linux, macOS ou Unix :

   ```
   aws docdb describe-db-instances \
       --db-instance-identifier sample-cluster-instance
   ```

   Pour Windows :

   ```
   aws docdb describe-db-instances \
       --db-instance-identifier sample-cluster-instance
   ```

   Le résultat de cette opération ressemble à ce qui suit.

   ```
   {
       "DBInstances": [
           {
               "DbiResourceId": "db-BJKKB54PIDV5QFKGVRX5T3S6GM",
               "DBInstanceArn": "arn:aws:rds:us-east-1:012345678901:db:sample-cluster-instance-00",
               "VpcSecurityGroups": [
                   {
                       "VpcSecurityGroupId": "sg-77186e0d",
                       "Status": "active"
                   }
               ],
               "DBInstanceClass": "db.r5.large",
               "DBInstanceStatus": "creating",
               "AutoMinorVersionUpgrade": true,
               "PreferredMaintenanceWindow": "fri:09:32-fri:10:02",
               "BackupRetentionPeriod": 1,
               "StorageEncrypted": true,
               "DBClusterIdentifier": "sample-cluster",
               "EngineVersion": "3.6.0",
               "AvailabilityZone": "us-east-1a",
               "Engine": "docdb",
               "PromotionTier": 2,
               "DBInstanceIdentifier": "sample-cluster-instance",
               "PreferredBackupWindow": "00:00-00:30",
               "PubliclyAccessible": false,
               "DBSubnetGroup": {
                   "DBSubnetGroupName": "default",
                   "Subnets": [
                       {
                           "SubnetIdentifier": "subnet-4e26d263",
                           "SubnetAvailabilityZone": {
                               "Name": "us-east-1a"
                           },
                           "SubnetStatus": "Active"
                       },
                       {
                           "SubnetIdentifier": "subnet-afc329f4",
                           "SubnetAvailabilityZone": {
                               "Name": "us-east-1c"
                           },
                           "SubnetStatus": "Active"
                       },
                       {
                           "SubnetIdentifier": "subnet-b3806e8f",
                           "SubnetAvailabilityZone": {
                               "Name": "us-east-1e"
                           },
                           "SubnetStatus": "Active"
                       },
                       {
                           "SubnetIdentifier": "subnet-53ab3636",
                           "SubnetAvailabilityZone": {
                               "Name": "us-east-1d"
                           },
                           "SubnetStatus": "Active"
                       },
                       {
                           "SubnetIdentifier": "subnet-991cb8d0",
                           "SubnetAvailabilityZone": {
                               "Name": "us-east-1b"
                           },
                           "SubnetStatus": "Active"
                       },
                       {
                           "SubnetIdentifier": "subnet-29ab1025",
                           "SubnetAvailabilityZone": {
                               "Name": "us-east-1f"
                           },
                           "SubnetStatus": "Active"
                       }
                   ],
                   "VpcId": "vpc-91280df6",
                   "DBSubnetGroupDescription": "default",
                   "SubnetGroupStatus": "Complete"
               },
               "PendingModifiedValues": {},
               "KmsKeyId": "arn:aws:kms:us-east-1:012345678901:key/0961325d-a50b-44d4-b6a0-a177d5ff730b"
           }
       ]
   }
   ```

------

# Modification d'une instance Amazon DocumentDB
<a name="db-instance-modify"></a>

Vous pouvez modifier votre instance Amazon DocumentDB à l'aide du AWS Management Console ou du. AWS CLI Pour modifier une instance, l'instance doit être dans l'état *available (disponible)*. Vous ne pouvez pas modifier une instance qui est arrêtée. Si le cluster est arrêté, commencez par démarrer le cluster, attendez que l'instance devienne *disponible*, puis apportez les modifications souhaitées. Pour de plus amples informations, veuillez consulter [Arrêt et démarrage d'un cluster Amazon DocumentDB](db-cluster-stop-start.md). 

------
#### [ Using the AWS Management Console ]

Pour modifier une instance Amazon DocumentDB spécifique à l'aide de la console, procédez comme suit.

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans la boîte de navigation Clusters, vous verrez la colonne **Cluster Identifier**. Vos instances sont répertoriées sous des clusters, comme dans la capture d'écran ci-dessous.  
![\[Tableau des clusters présentant la liste des clusters sous la colonne Identifiant du cluster, avec les instances imbriquées dans les clusters.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/choose-clusters.png)

1. Cochez la case située à gauche de l'instance que vous souhaitez modifier.

1. Choisissez **Actions**, puis **Modify (Modifier)**.

1. Dans le volet **Modify instance: <instance-name> (Modifier l'instance : <nom-instance>)**, apportez les modifications souhaitées. Vous pouvez apporter les modifications suivantes :
   + **Spécifications de l'instance** : identifiant et classe de l'instance. Contraintes d'attribution de noms aux identifiants d'instance :
     + **Identifiant d'instance** — Entrez un nom unique pour toutes les instances que vous possédez Compte AWS dans la région actuelle. L'identifiant d'instance doit contenir [1 à 63] caractères alphanumériques ou traits d'union, avoir une lettre comme premier caractère et ne peut pas se terminer par un tiret ni contenir deux tirets consécutifs.
     + **Classe d'instance** : dans le menu déroulant, sélectionnez une classe d'instance pour votre instance Amazon DocumentDB. Pour de plus amples informations, veuillez consulter [Gestion des classes d'instances](db-instance-classes.md).
   + **Autorité de certification** : certificat de serveur pour cette instance. Pour de plus amples informations, veuillez consulter [Mise à jour de vos certificats TLS Amazon DocumentDB](ca_cert_rotation.md). 
   + **Basculement** : lors du basculement, l'instance présentant le niveau de promotion le plus élevé sera promue au niveau principal. Pour de plus amples informations, veuillez consulter [Basculement d'Amazon DocumentDB](failover.md). 
   + **Maintenance** : fenêtre de maintenance au cours de laquelle les modifications ou correctifs en attente sont appliqués aux instances du cluster.

1. Lorsque vous avez terminé, choisissez **Continue (continuer)** pour afficher un récapitulatif de vos modifications.

1. Après vérification de vos modifications, vous pouvez les appliquer immédiatement ou au cours de la fenêtre de maintenance suivante sous **Scheduling of modifications (Planification des modifications)**. Choisissez **Modify instance (Modifier l'instance)** pour enregistrer vos modifications. Vous pouvez également choisir **Cancel (Annuler)** pour ignorer vos modifications.

L'application de vos modifications prend quelques minutes. Vous pouvez uniquement utiliser l'instance lorsqu'elle présente le statut *disponible*. Vous pouvez surveiller l'état de l'instance en utilisant la console ou la AWS CLI. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md). 

------
#### [ Using the AWS CLI ]

Pour modifier une instance Amazon DocumentDB spécifique à l'aide du AWS CLI, utilisez le `modify-db-instance` avec les paramètres suivants. Pour plus d'informations, voir [Modifier DBInstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBInstance.html). Le code suivant modifie la classe d'instance en `db.r5.large` pour l'instance `sample-instance`.

**Parameters**
+ **--db-instance-identifier** — Obligatoire. Identifiant de l'instance à modifier.
+ **--db-instance-class**— Facultatif La nouvelle capacité de calcul et de mémoire de l'instance ; par exemple,`db.r5.large`. Les classes d'instance ne sont pas toutes disponibles Régions AWS. Si vous modifiez la classe d'instance, une panne se produit lors de la modification. La modification est appliquée lors de la fenêtre de maintenance suivante, sauf si `ApplyImmediately` elle est spécifiée comme vraie pour cette demande.
+ **--apply-immediately**ou **--no-apply-immediately** — Facultatif. Indique si cette modification doit être appliquée immédiatement ou s'il faut attendre le prochain créneau de maintenance. Si ce paramètre n'est pas appliqué, la modification est réalisée au cours du créneau de maintenance suivant.

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb modify-db-instance \
       --db-instance-identifier sample-instance \
       --db-instance-class db.r5.large \
       --apply-immediately
```
Pour Windows :  

```
aws docdb modify-db-instance ^
       --db-instance-identifier sample-instance ^
       --db-instance-class db.r5.large ^
       --apply-immediately
```
Le résultat de cette opération ressemble à ceci.  

```
{
    "DBInstances": [
        {
            "DBInstanceIdentifier": "sample-instance-1",
            "DBInstanceClass": "db.r5.large",
            "Engine": "docdb",
            "DBInstanceStatus": "modifying",
            "Endpoint": {                     
                "Address": "sample-instance-1.node.us-east-1.docdb.amazonaws.com",
                "Port": 27017,   
                "HostedZoneId": "ABCDEFGHIJKLM"
            },
            "InstanceCreateTime": "2020-01-10T22:18:55.921Z",
            "PreferredBackupWindow": "02:00-02:30",
            "BackupRetentionPeriod": 1,
            "VpcSecurityGroups": [
                {                             
                    "VpcSecurityGroupId": "sg-abcd0123",
                    "Status": "active"
                }
            ],
            "AvailabilityZone": "us-east-1a",
            "DBSubnetGroup": {
                "DBSubnetGroupName": "default",
                "DBSubnetGroupDescription": "default",
                "VpcId": "vpc-abcd0123",
                "SubnetGroupStatus": "Complete",
                "Subnets": [
                    {
                        "SubnetIdentifier": "subnet-abcd0123",
                        "SubnetAvailabilityZone": {
                            "Name": "us-east-1a"
                        },
                        "SubnetStatus": "Active"
                    },
                    {
                        "SubnetIdentifier": "subnet-abcd0123",
                        "SubnetAvailabilityZone": {
                            "Name": "us-east-1b"
                        },
                        "SubnetStatus": "Active"
                    }
                ]
            },
            "PreferredMaintenanceWindow": "sun:10:57-sun:11:27",
            "PendingModifiedValues": {
                "DBInstanceClass": "db.r5.large"
            },
            "EngineVersion": "3.6.0",
            "AutoMinorVersionUpgrade": true,
            "PubliclyAccessible": false,
            "DBClusterIdentifier": "sample-cluster",
            "StorageEncrypted": true,
            "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
            "DbiResourceId": "db-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
            "CACertificateIdentifier": "rds-ca-2019",
            "PromotionTier": 1,                     
            "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:sample-instance-1",
            "EnabledCloudwatchLogsExports": [
                "profiler"
            ]
        }
    ]
}
```

L'application de vos modifications prend quelques minutes. Vous pouvez uniquement utiliser l'instance lorsqu'elle présente le statut *disponible*. Vous pouvez surveiller l'état de l'instance à l'aide du AWS Management Console ou AWS CLI. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md). 

------

# Redémarrage d'une instance Amazon DocumentDB
<a name="db-instance-reboot"></a>

Il se peut que vous deviez redémarrer votre instance Amazon DocumentDB, généralement pour des raisons de maintenance. Par exemple, si vous effectuez certaines modifications, telles que la modification du groupe de paramètres associé à un cluster, vous devez redémarrer les instances du cluster pour que ces modifications prennent effet. Vous pouvez redémarrer une instance spécifiée à l'aide du AWS Management Console ou du AWS CLI.

Le redémarrage d'une instance entraîne celui du service du moteur de base de données. Le redémarrage d'une instance entraîne une interruption momentanée, au cours de laquelle le statut de l'instance est défini sur `rebooting`. Un événement Amazon DocumentDB est créé lorsque le redémarrage est terminé.

Le redémarrage d'une instance n'entraîne pas de basculement. Pour basculer un cluster Amazon DocumentDB, utilisez AWS Management Console l'opération ou AWS CLI . `failover-db-cluster` Pour de plus amples informations, veuillez consulter [Basculement d'Amazon DocumentDB](failover.md). 

Vous ne pouvez pas redémarre votre instance si celle-ci n'est pas à l'état *disponible*. Votre base de données peut être indisponible pour plusieurs raisons, notamment pour cause de modification demandée précédemment ou d'action de créneau de maintenance. Pour de plus amples informations sur les états d'instance, veuillez consulter [Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md). 

------
#### [ Using the AWS Management Console ]

La procédure suivante redémarre l'instance que vous spécifiez à l'aide de la console.

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans la boîte de navigation Clusters, vous verrez la colonne **Cluster Identifier**. Vos instances sont répertoriées sous des clusters, comme dans la capture d'écran ci-dessous.  
![\[Tableau des clusters présentant la liste des clusters sous la colonne Identifiant du cluster, avec les instances imbriquées dans les clusters.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/choose-clusters.png)

1. Cochez la case située à gauche de l'instance que vous souhaitez redémarrer.

1. Choisissez **Actions**, **Reboot (Redémarrer)**, puis **Reboot (Redémarrer)** pour confirmer votre redémarrage.

Le redémarrage de votre instance prend quelques minutes. Vous pouvez uniquement utiliser l'instance lorsqu'elle présente le statut *disponible*. Vous pouvez surveiller le statut de l'instance en utilisant la console ou la AWS CLI. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md). 

------
#### [ Using the AWS CLI ]

Pour redémarrer une instance Amazon DocumentDB, utilisez l'`reboot-db-instance`opération avec le `--db-instance-identifier` paramètre. Ce paramètre spécifie l'identifiant de l'instance à redémarrer.

Le code suivant redémarre l'instance `sample-instance`.

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb reboot-db-instance \
       --db-instance-identifier sample-instance
```
Pour Windows :  

```
aws docdb reboot-db-instance ^
       --db-instance-identifier sample-instance
```
Le résultat de cette opération ressemble à ceci.  

```
{
    "DBInstance": {
        "DBInstanceIdentifier": "sample-instance",
        "DBInstanceClass": "db.r5.large",
        "Engine": "docdb",
        "DBInstanceStatus": "rebooting",
        "Endpoint": {
            "Address": "sample-instance.node.us-east-1.docdb.amazonaws.com",
            "Port": 27017,   
            "HostedZoneId": "ABCDEFGHIJKLM"
        },
        "InstanceCreateTime": "2020-03-27T08:05:56.314Z",
        "PreferredBackupWindow": "02:00-02:30",
        "BackupRetentionPeriod": 1,
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-abcd0123",
                "Status": "active"
            }
        ],
        "AvailabilityZone": "us-east-1c",
        "DBSubnetGroup": {
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default",
            "VpcId": "vpc-abcd0123",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-abcd0123",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-wxyz0123",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1b"
                    },
                    "SubnetStatus": "Active"
                }
            ]
        },
        "PreferredMaintenanceWindow": "sun:06:53-sun:07:23",
        "PendingModifiedValues": {},
        "EngineVersion": "3.6.0",
        "AutoMinorVersionUpgrade": true,
        "PubliclyAccessible": false,
        "DBClusterIdentifier": "sample-cluster",
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:<accountID>:key/sample-key",
        "DbiResourceId": "db-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "CACertificateIdentifier": "rds-ca-2019",
        "PromotionTier": 1,
        "DBInstanceArn": "arn:aws:rds:us-east-1:<accountID>:db:sample-instance",
        "EnabledCloudwatchLogsExports": [
            "profiler"
        ]
    }
}
```

Le redémarrage de votre instance prend quelques minutes. Vous pouvez uniquement utiliser l'instance lorsqu'elle présente le statut *disponible*. Vous pouvez surveiller l'état de l'instance en utilisant la console ou la AWS CLI. Pour de plus amples informations, veuillez consulter [Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md). 

------

# Suppression d'une instance Amazon DocumentDB
<a name="db-instance-delete"></a>

Vous pouvez supprimer votre instance Amazon DocumentDB à l'aide du AWS Management Console ou du. AWS CLI Pour supprimer une instance, l'instance doit être à l'état *available (disponible)*. Vous ne pouvez pas supprimer une instance qui est arrêtée. Si le cluster Amazon DocumentDB qui contient votre instance est arrêté, démarrez d'abord le cluster, attendez qu'elle soit *disponible*, puis supprimez-la. Pour de plus amples informations, veuillez consulter [Arrêt et démarrage d'un cluster Amazon DocumentDB](db-cluster-stop-start.md). 

**Note**  
Amazon DocumentDB stocke toutes vos données dans le volume du cluster. Les données restent dans ce volume de cluster, même si vous supprimez toutes les instances de votre cluster. Si vous avez besoin d'accéder aux données à nouveau, vous pouvez ajouter une instance au cluster à tout moment et reprendre votre activité là où vous l'aviez laissée.

------
#### [ Using the AWS Management Console ]

La procédure suivante supprime une instance Amazon DocumentDB spécifiée à l'aide de la console.

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans la boîte de navigation Clusters, vous verrez la colonne **Cluster Identifier**. Vos instances sont répertoriées sous des clusters, comme dans la capture d'écran ci-dessous.  
![\[Tableau des clusters présentant la liste des clusters sous la colonne Identifiant du cluster, avec les instances imbriquées dans les clusters.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/choose-clusters.png)

1. Cochez la case située à gauche de l'instance que vous souhaitez supprimer.

1. Choisissez **Actions**, puis **Delete (Supprimer)**.

   1. Si vous supprimez la dernière instance de votre cluster :
      + **Create final cluster snapshot? (Créer un instantané final de cluster ?)** — Choisissez **Oui** si vous souhaitez créer un instantané final avant que le cluster ne soit supprimé. Sinon, choisissez **Non**.
      + **Nom du cliché final** : si vous choisissez de créer un instantané final, entrez l'identifiant du nouvel instantané de cluster créé.
      + **Delete <instance-name> instance? (Supprimer l'instance <nom-instance> ?)** — Entrez la phrase **supprimer le cluster entier** dans le champ pour confirmer la suppression.

   1. Si vous ne supprimez pas la dernière instance de votre cluster :
      + **Delete <instance-name> instance? (Supprimer l'instance <nom-instance> ?)** — Entrez la phrase **supprimez-moi** dans le champ pour confirmer la suppression. 

1. Sélectionnez **Delete (Supprimer)** pour supprimer l'instance. 

La suppression de l'instance prend plusieurs minutes. Pour surveiller l'état d'une instance, consultez [Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md). 

------
#### [ Using the AWS CLI ]

La procédure suivante supprime une instance Amazon DocumentDB à l'aide du. AWS CLI

1. **Tout d'abord, déterminez le nombre d'instances présentes dans votre cluster Amazon DocumentDB :** 

   Pour déterminer le nombre d'instances de votre cluster, exécutez la commande `describe-db-clusters`, comme suit.

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

   Le résultat de cette opération ressemble à ceci.

   ```
   [
       [
           "sample-cluster",
           [
               "sample-instance-1",
               "sample-instance-2"
           ]
       ]
   ]
   ```

1. **S'il existe plusieurs instances dans votre cluster Amazon DocumentDB :**

   Pour supprimer une instance Amazon DocumentDB spécifiée, utilisez la `delete-db-instance` commande avec le `--db-instance-identifier` paramètre, comme indiqué ci-dessous. La suppression de l'instance prend plusieurs minutes. Pour surveiller l'état d'une instance, consultez [Surveillance de l'état d'une instance Amazon DocumentDB](monitoring_docdb-instance_status.md). 

   ```
   aws docdb delete-db-instance \
          --db-instance-identifier sample-instance-2
   ```

   Le résultat de cette opération ressemble à ceci.

   ```
   {
       "DBInstance": {
           "DBInstanceIdentifier": "sample-instance-2",
           "DBInstanceClass": "db.r5.large",
           "Engine": "docdb",
           "DBInstanceStatus": "deleting",
           "Endpoint": {
               "Address": "sample-instance-2.node.us-east-1.docdb.amazonaws.com",
               "Port": 27017,
               "HostedZoneId": "ABCDEFGHIJKLM"
           },
           "InstanceCreateTime": "2020-03-27T08:05:56.314Z",
           "PreferredBackupWindow": "02:00-02:30",
           "BackupRetentionPeriod": 1,
           "VpcSecurityGroups": [
               {
                   "VpcSecurityGroupId": "sg-abcd0123",
                   "Status": "active"
               }
           ],
           "AvailabilityZone": "us-east-1c",
           "DBSubnetGroup": {
               "DBSubnetGroupName": "default",
               "DBSubnetGroupDescription": "default",
               "VpcId": "vpc-6242c31a",
               "SubnetGroupStatus": "Complete",
               "Subnets": [
                   {
                       "SubnetIdentifier": "subnet-abcd0123",
                       "SubnetAvailabilityZone": {
                           "Name": "us-east-1a"
                       },
                       "SubnetStatus": "Active"
                   },
                   {
                       "SubnetIdentifier": "subnet-wxyz0123",
                       "SubnetAvailabilityZone": {
                           "Name": "us-east-1b"
                       },
                       "SubnetStatus": "Active"
                   }
               ]
           },
           "PreferredMaintenanceWindow": "sun:06:53-sun:07:23",
           "PendingModifiedValues": {},
           "EngineVersion": "3.6.0",
           "AutoMinorVersionUpgrade": true,
           "PubliclyAccessible": false,
           "DBClusterIdentifier": "sample-cluster",
           "StorageEncrypted": true,
           "KmsKeyId": "arn:aws:kms:us-east-1:<accountID>:key/sample-key",
           "DbiResourceId": "db-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
           "CACertificateIdentifier": "rds-ca-2019",
           "PromotionTier": 1,
           "DBInstanceArn": "arn:aws:rds:us-east-1:<accountID>:db:sample-instance-2",
           "EnabledCloudwatchLogsExports": [
               "profiler"
           ]
       }
   }
   ```

1. **Si l'instance que vous souhaitez supprimer est la dernière instance de votre cluster Amazon DocumentDB :**

   Si vous supprimez la dernière instance d'un cluster Amazon DocumentDB, vous supprimez également ce cluster ainsi que les instantanés automatiques et les sauvegardes continues associés à ce cluster.

   Pour supprimer la dernière instance de votre cluster, vous pouvez supprimer le cluster et éventuellement créer un instantané final. Pour de plus amples informations, veuillez consulter [Suppression d'un cluster Amazon DocumentDB](db-cluster-delete.md). 

------

## Protection contre la suppression
<a name="db-instance-delete-deletion-protection"></a>

La suppression de la dernière instance d'un cluster Amazon DocumentDB entraîne également la suppression du cluster, ainsi que des instantanés automatiques et des sauvegardes continues associés à ce cluster. Amazon DocumentDB applique la protection contre la suppression à un cluster, que vous exécutiez l'opération de suppression à l'aide du ou du AWS Management Console . AWS CLI Si la protection contre la suppression est activée, vous ne pouvez pas supprimer de cluster.

Pour supprimer un cluster pour lequel la protection contre la suppression est activée, vous devez commencer par modifier le cluster et désactiver la protection contre la suppression. Pour de plus amples informations, veuillez consulter [Suppression d'un cluster Amazon DocumentDB](db-cluster-delete.md). 

# Gestion des classes d'instances
<a name="db-instance-classes"></a>

La classe d'instance détermine le calcul et la capacité de mémoire d'une instance Amazon DocumentDB (compatible avec MongoDB). La classe d'instance dont vous avez besoin varie selon vos exigences en mémoire et en puissance de traitement. 

Amazon DocumentDB prend en charge les familles de classes d'instances R4, R5, R6G, R8G, T3 et T4G. Il s'agit de classes d'instance de la génération actuelle optimisées pour les applications exigeantes en mémoire. Pour les spécifications sur ces classes, consultez [Spécifications des classes d'instances](#db-instance-class-specs). 

**Topics**
+ [Déterminer une classe d'instance](#db-instance-class-determining)
+ [Modification de la classe d'une instance](#db-instance-class-changing)
+ [Classes d'instances prises en charge par région](#db-instance-classes-by-region)
+ [Spécifications des classes d'instances](#db-instance-class-specs)

## Déterminer une classe d'instance
<a name="db-instance-class-determining"></a>

Pour déterminer la classe d'une instance, vous pouvez utiliser l'`describe-db-instances` AWS CLI opération AWS Management Console ou.

------
#### [ Using the AWS Management Console ]

Pour déterminer la classe d'instance pour les instances de votre cluster, effectuez les étapes suivantes dans la console.

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

1. Dans le volet de navigation, choisissez **Clusters** pour trouver l'instance qui vous intéresse. 
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans la boîte de navigation Clusters, vous verrez la colonne **Cluster Identifier**. Vos instances sont répertoriées sous des clusters, comme dans la capture d'écran ci-dessous.  
![\[Tableau des clusters indiquant comment une instance est imbriquée sous un cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/choose-clusters.png)

1. Dans la liste des instances, développez le cluster pour trouver les instances qui vous intéressent. Trouvez l'instance que vous souhaitez. Regardez ensuite la colonne **Size** de la ligne de l'instance pour voir sa classe d'instance.

   Dans l'image suivante, la classe d'instance pour `robo3t` est `db.r5.4xlarge`.  
![\[Liste des instances dans le tableau Clusters avec la colonne Taille indiquant le type d'instance.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/instance-class.png)

------
#### [ Using the AWS CLI ]

Pour déterminer la classe d'une instance à l'aide de AWS CLI, utilisez l'`describe-db-instances`opération avec les paramètres suivants.
+ **--db-instance-identifier**— Facultatif. Spécifie l'instance pour laquelle vous voulez déterminer la classe. Si cet élément n'est pas spécifié, `describe-db-instances` renvoie une description de 100 de vos instances au plus.
+ **--query**— Facultatif. Spécifie les membres de l'instance à inclure dans les résultats. Si ce paramètre n'est pas spécifié, tous les membres de l'instance sont renvoyés.

**Example**  
L'exemple suivant permet de trouver le nom et la classe de l'instance`sample-instance-1`.  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-instances \
    --query 'DBInstances[*].[DBInstanceIdentifier,DBInstanceClass]' \
    --db-instance-identifier sample-instance-1
```
Pour Windows :  

```
aws docdb describe-db-instances ^
    --query 'DBInstances[*].[DBInstanceIdentifier,DBInstanceClass]' ^
    --db-instance-identifier sample-instance-1
```
Le résultat de cette opération ressemble à ceci.  

```
[
    [
        "sample-instance-1",
        "db.r5.large"
    ]
```

**Example**  
L'exemple suivant trouve le nom et la classe de l'instance pour un maximum de 100 instances Amazon DocumentDB.  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-instances \
    --query 'DBInstances[*].[DBInstanceIdentifier,DBInstanceClass]' \
    --filter Name=engine,Values=docdb
```
Pour Windows :  

```
aws docdb describe-db-instances ^
    --query 'DBInstances[*].[DBInstanceIdentifier,DBInstanceClass]' ^
    --filter Name=engine,Values=docdb
```
Le résultat de cette opération ressemble à ceci.  

```
[
    [
        "sample-instance-1",
        "db.r5.large"
    ],
    [
        "sample-instance-2",
        "db.r5.large"
    ],
    [
        "sample-instance-3",
        "db.r5.4xlarge"
    ],
    [
        "sample-instance-4",
        "db.r5.4xlarge"
    ]
]
```

Pour de plus amples informations, veuillez consulter [Décrire les instances Amazon DocumentDB](db-instance-view-details.md). 

------

## Modification de la classe d'une instance
<a name="db-instance-class-changing"></a>

Vous pouvez modifier la classe d'instance de votre instance à l'aide du AWS Management Console ou du AWS CLI. Pour de plus amples informations, veuillez consulter [Modification d'une instance Amazon DocumentDB](db-instance-modify.md). 

## Classes d'instances prises en charge par région
<a name="db-instance-classes-by-region"></a>

Amazon DocumentDB prend en charge les classes d'instance suivantes :
+ `R8G`—Dernière génération d'instances optimisées pour la mémoire alimentées par des processeurs AWS Graviton4 basés sur ARM qui offrent des performances jusqu'à 30 % supérieures à celles des instances R6G.
+ `R6G`—Instances optimisées pour la mémoire alimentées par des processeurs AWS Graviton2 basés sur ARM qui offrent des performances jusqu'à 30 % supérieures à celles des instances R5 à un coût inférieur de 5 %.
+ `R6GD`—Instances R6G optimisées pour la mémoire avec stockage local sur disque SSD (Solid State DriveNVMe) basé sur la mémoire non volatile express () pour les données éphémères.
+ `R5`—Instances optimisées pour la mémoire qui offrent des performances jusqu'à 100 % supérieures à celles des instances R4 pour le même coût d'instance.
+ `R4`—Génération précédente d'instances optimisées pour la mémoire.
+ `T4G`—Type d'instance généraliste à faible coût et à faible coût de dernière génération alimenté par des processeurs AWS Graviton2 basés sur ARM qui fournit un niveau de performance CPU de référence, offrant un rapport prix/performances jusqu'à 35 % supérieur à celui des instances T3 et idéal pour exécuter des applications avec une utilisation modérée du processeur qui connaissent des pics d'utilisation temporaires.
+ `T3`—Type d'instance généraliste à faible coût qui fournit un niveau de performance du processeur de référence avec la possibilité d'augmenter l'utilisation du processeur à tout moment et aussi longtemps que nécessaire.

Pour obtenir des spécifications détaillées sur les classes d'instances, veuillez consulter [Spécifications des classes d'instances](#db-instance-class-specs). 

**Note**  
Le stockage optimisé pour les E/S n'est disponible que sur les versions 5.0 et 8.0 du moteur (clusters basés sur des instances).

Une classe d'instance particulière peut être prise en charge ou non dans une région donnée. Le tableau suivant indique quelles classes d'instances sont prises en charge par Amazon DocumentDB dans chaque région.


**Classes d'instances prises en charge par région**  

|  | Classes d'instances | Région | 8 G | R6GD | R6G | R5 | R4 | T4G | T3 | sans serveur | 
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | 
| USA Est (Ohio) | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | 
| USA Est (Virginie du Nord) | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | 
| USA Ouest (Oregon) | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | 
| Afrique (Le Cap) |  |  | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Amérique du Sud (São Paulo) |  | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Asie-Pacifique (Hong Kong) |  |  | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Asie-Pacifique (Hyderabad) |  |  | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Asie-Pacifique (Malaisie) |  |  | Pris en charge |  |  | Pris en charge | Pris en charge |  | 
| Asie-Pacifique (Mumbai) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Asie-Pacifique (Osaka) |  | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge |  | 
| Asie-Pacifique (Séoul) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Asie-Pacifique (Sydney) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Asie-Pacifique (Jakarta) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge |  | 
| Asie-Pacifique (Melbourne) |  |  | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge |  | 
| Asie-Pacifique (Singapour) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Asie-Pacifique (Thaïlande) |  |  | Pris en charge |  |  | Pris en charge | Pris en charge |  | 
| Asie-Pacifique (Tokyo) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Canada (Centre) |  | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Europe (Francfort) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Europe (Zurich) |  | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge |  | 
| Europe (Irlande) | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Pris en charge | 
| Europe (Londres) |  | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Europe (Milan) |  |  | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Europe (Paris) |  | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Europe (Espagne) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Europe (Stockholm) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge |  | 
| Mexique (Centre) |  |  | Pris en charge |  |  | Pris en charge | Pris en charge |  | 
| Moyen-Orient (EAU) |  |  | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Chine (Pékin) |  | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Chine (Ningxia) |  |  | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| Israël (Tel Aviv) |  |  | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| AWS GovCloud (US-Ouest) | Pris en charge | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 
| AWS GovCloud (USA Est) |  | Pris en charge | Pris en charge | Pris en charge |  | Pris en charge | Pris en charge | Pris en charge | 

## Spécifications des classes d'instances
<a name="db-instance-class-specs"></a>

Le tableau suivant fournit des informations détaillées sur les classes d'instances Amazon DocumentDB, notamment les types d'instances pris en charge dans chaque classe. Vous trouverez des explications pour chaque colonne de tableau sous ce dernier.


| Classe d’instance | vCPU1 | Mémoire (GiB) 2 | NVMe Cache hiérarchisé SSD (GiB) 3 | Température maximale de stockage (GiB) 4 | Bande passante de référence/rafale (Gbit/s) 5 | Moteurs de soutien 6 | 
| --- | --- | --- | --- | --- | --- | --- | 
| R8G — Classe d'instance optimisée pour la mémoire de génération actuelle basée sur Graviton4 R8G est la toute dernière famille d'instances (Graviton4), disponible uniquement sur les versions 5.0 et 8.0 du moteur. Les tailles db.r8g.24xlarge et db.r8g.48xlarge ne sont pas encore disponibles. | 
| db.r8g.large | 2 | 16 | - | 30 | 0,937 / 12,5 | 5.0.0 et 8.0.0 | 
| db.r8g.xlarge | 4 | 32 | - | 60 | 1,875 / 12,5 | 5.0.0 et 8.0.0 | 
| db.r8g.2xlarge | 8 | 64 | - | 121 | 3,75 / 15,0 | 5.0.0 et 8.0.0 | 
| db.r8g.4xlarge | 16 | 128 | - | 243 | 7,5 / 15,0 | 5.0.0 et 8.0.0 | 
| db.r8g.8xlarge | 32 | 256 | - | 488 | 15 | 5.0.0 et 8.0.0 | 
| db.r8g.12xlarge | 48 | 384 | - | 732 | 22 | 5.0.0 et 8.0.0 | 
| db.r8g.16xlarge | 64 | 512 | - | 987 | 30 | 5.0.0 et 8.0.0 | 
| R6G — Classe d'instance optimisée pour la mémoire de génération actuelle basée sur Graviton2 | 
| db.r6g.large | 2 | 16 | - | 32 | 0,75/10 | 4.0.0, 5.0.0 et 8.0.0 | 
| db.r6g.xlarge | 4 | 32 | - | 63 | 1,25/10 | 4.0.0, 5.0.0 et 8.0.0 | 
| db.r6g.2xlarge | 8 | 64 | - | 126 | 2,5/10 | 4.0.0, 5.0.0 et 8.0.0 | 
| db.r6g.4xlarge | 16 | 128 | - | 252 | 5,0/ 10 | 4.0.0, 5.0.0 et 8.0.0 | 
| db.r6g.8xlarge | 32 | 256 | - | 504 | 12 | 4.0.0, 5.0.0 et 8.0.0 | 
| db.r6g.12xlarge | 48 | 384 | - | 756 | 20 | 4.0.0, 5.0.0 et 8.0.0 | 
| db.r6g.16xlarge | 64 | 512 | - | 1008 | 25 | 4.0.0, 5.0.0 et 8.0.0 | 
| R6GD — Classe d'instance basée sur Graviton2 NVMe basée sur la génération actuelle | 
| db.r6gd.xlarge | 4 | 32 | 173 | 64 | 1,25/10 | 5.0.0 et 8.0.0 | 
| db.r6gd.2xlarge | 8 | 64 | 346 | 128 | 2,5/10 | 5.0.0 et 8.0.0 | 
| db.r6gd.4xlarge | 16 | 128 | 694 | 256 | 5,0/ 10 | 5.0.0 et 8.0.0 | 
| db.r6gd.8xlarge | 32 | 256 | 1388 | 512 | 12 | 5.0.0 et 8.0.0 | 
| db.r6gd.12xlarge | 48 | 384 | 2082 | 768 | 20 | 5.0.0 et 8.0.0 | 
| db.r6gd.16xlarge | 64 | 512 | 2776 | 1 024 | 25 | 5.0.0 et 8.0.0 | 
| R5 — Classe d'instance optimisée pour la mémoire de la génération précédente | 
| db.r5.large | 2 | 16 | - | 31 | 0,75/10 | 3.6.0, 4.0.0, 5.0.0 et 8.0.0 | 
| db.r5.xlarge | 4 | 32 | - | 62 | 1,25/10 | 3.6.0, 4.0.0, 5.0.0 et 8.0.0 | 
| db.r5.2xlarge | 8 | 64 | - | 124 | 2,5/10 | 3.6.0, 4.0.0, 5.0.0 et 8.0.0 | 
| db.r5.4xlarge | 16 | 128 | - | 249 | 5,0/ 10 | 3.6.0, 4.0.0, 5.0.0 et 8.0.0 | 
| db.r5.8xlarge | 32 | 256 | - | 504 | 10 | 3.6.0, 4.0.0, 5.0.0 et 8.0.0 | 
| db.r5.12xlarge | 48 | 384 | - | 748 | 12 | 3.6.0, 4.0.0, 5.0.0 et 8.0.0 | 
| db.r5.16xlarge | 64 | 512 | - | 1008 | 20 | 3.6.0, 4.0.0, 5.0.0 et 8.0.0 | 
| db.r5.24xlarge | 96 | 768 | - | 1 500 | 25 | 3.6.0, 4.0.0, 5.0.0 et 8.0.0 | 
| R4 — Classe d'instance optimisée pour la mémoire de la génération précédente Les instances R4 ne sont prises en charge que sur la version 3.6 du moteur. Notez qu'Amazon DocumentDB 3.6 atteindra la fin du support standard le 30 mars 2026. Support étendu (payant) est disponible jusqu'en mars 2029. | 
| db.r4.large | 2 | 15,25 | - | 30 | 0,75/10 | 3.6.0 uniquement | 
| db.r4.xlarge | 4 | 30,5 | - | 60 | 1,25/10 | 3.6.0 uniquement | 
| db.r4.2xlarge | 8 | 61 | - | 120 | 2,5/10 | 3.6.0 uniquement | 
| db.r4.4xlarge | 16 | 122 | - | 240 | 5,0 /10 | 3.6.0 uniquement | 
| db.r4.8xlarge | 32 | 244 | - | 480 | 10 | 3.6.0 uniquement | 
| db.r4.16xlarge | 64 | 488 | - | 960 | 25 | 3.6.0 uniquement | 
| T4G — Classes d'instances de performances éclatantes de dernière génération basées sur Graviton2 Les instances de la série T s'exécutent en mode Unlimited CPU burst. L'utilisation en rafale au-delà de la base de référence est facturée en supplément. Non pris en charge pour les clusters mondiaux. | 
| db.t4g.medium | 2 | 4 | - | 8,13 | 0,256/5 | 4.0.0, 5.0.0 et 8.0.0 | 
| T3 — Classes d'instances de performance burstable de la génération précédente | 
| db.t3.medium | 2 | 4 | - | 7,5 | 0,256/5 | 3.6.0, 4.0.0, 5.0.0 et 8.0.0 | 
|  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/db-instance-classes.html)  | 

# Instances basées sur les volumes NVMe
<a name="db-instance-nvme"></a>

NVMeLes instances sauvegardées offrent des performances de requête jusqu'à 7 fois plus rapides pour les applications dont les ensembles de données volumineux dépassent la mémoire d'une instance normale. Ces instances tirent parti du stockage SSD (Solid State DriveNVMe) basé sur la mémoire non volatile locale () disponible sur les instances r6gd pour stocker des données éphémères, réduisant ainsi l'accès au stockage sur le réseau et améliorant la latence et le débit de lecture.

L'espace SSD local est divisé en deux sections :
+ **Cache hiérarchisé** : environ 73 % du SSD local est alloué sous forme de cache de base de données, ce qui permet au système de stocker jusqu'à cinq fois plus de pages de base de données que la mémoire principale seule. Le SSD local fait office de cache de second niveau, tandis que le cache tampon en mémoire existant reste le cache de premier niveau. La requête n'accède au stockage externe que si le cache tampon et le cache SSD ne fonctionnent pas.
+ **Stockage temporaire** : les 27 % restants sont réservés au stockage de fichiers temporaires non persistants, utilisé pour des requêtes complexes impliquant des tris ou des opérations gourmandes en ressources, telles que la création d'index. Sur les instances normales, l'espace temporaire se trouve sur un volume Amazon Elastic Block Store (EBS). Le stockage temporaire hébergé localement sur le SSD réduit jusqu'à deux fois le temps de latence des requêtes impliquant des tris et accélère les opérations gourmandes en ressources, telles que la création d'index.

Les détails concernant le type d'instances NVMe sauvegardées pris en charge et ses spécifications se trouvent dans[Spécifications des classes d'instances](db-instance-classes.md#db-instance-class-specs).

**Topics**
+ [Cas d'utilisation recommandés pour les instances NVMe soutenues par -back](#nvme-use-cases)
+ [Utilisation d'instances NVMe sauvegardées avec Amazon DocumentDB](#using-nvme)
+ [Surveillance des instances NVMe basées sur la surveillance](#monitoring-nvme)

## Cas d'utilisation recommandés pour les instances NVMe soutenues par -back
<a name="nvme-use-cases"></a>

Nous vous recommandons d'utiliser des instances NVMe basées sur -backed dans les scénarios suivants :
+ **Charges de travail intensives en lecture** : si votre charge de travail est gourmande en lecture et que la taille de votre ensemble de données est supérieure à la taille du cache tampon, comme en témoignent des `ReadIOPS` indicateurs faibles `BufferCacheHitRatio` et élevés, les instances NVMe sauvegardées peuvent apporter des avantages en termes de performances.
+ **Charges de travail gourmandes en mises à jour** : si votre charge de travail est gourmande en mises à jour et que la collecte des déchets ne parvient pas à suivre le rythme en raison de la latence de lecture sur le stockage réseau, les instances NVMe sauvegardées peuvent aider à atténuer le problème.

NVMe-les instances sauvegardées peuvent bénéficier de divers cas d'utilisation, notamment :
+ **Applications à l'échelle d'Internet** : les applications telles que le traitement des paiements, la facturation et le commerce électronique assorties d'accords de niveau de service (SLAs) stricts peuvent tirer parti des avantages en termes de performances des instances NVMe soutenues.
+ **Tableaux de bord de création de rapports en temps réel** — Les tableaux de bord qui exécutent des centaines de requêtes pour des mesures ou la collecte de données peuvent bénéficier de la faible latence et du débit élevé des instances soutenues. NVMe
+ **Applications d'intelligence artificielle génératives** : les applications qui utilisent la recherche vectorielle pour trouver les voisins exacts ou les plus proches parmi des millions d'intégrations vectorielles peuvent tirer parti des hautes performances des instances soutenues par des NVMe vecteurs.

## Utilisation d'instances NVMe sauvegardées avec Amazon DocumentDB
<a name="using-nvme"></a>

Pour utiliser des instances d'Amazon DocumentDB basées sur NVMe -backed, procédez comme suit :
+ Créez un cluster Amazon DocumentDB et ajoutez l'une des classes d'instance NVMe soutenues par -backed. Pour de plus amples informations, veuillez consulter [Création d'un cluster Amazon DocumentDB](db-cluster-create.md).
+ Vous pouvez également modifier un cluster Amazon DocumentDB existant pour utiliser l'une des classes d'instance NVMe soutenues par -backed. Pour de plus amples informations, veuillez consulter [Modification d'un cluster Amazon DocumentDB](db-cluster-modify.md).

Pour vérifier la disponibilité des instances NVMe soutenues dans différentes AWS régions, consultez[Classes d'instances prises en charge par région](db-instance-classes.md#db-instance-classes-by-region).

Si vous souhaitez revenir d'une instance basée sur NVMe -backed à une instance normale, modifiez la classe d'instance de base de données de votre instance Amazon DocumentDB en une classe d'instance similaire sans NVMe stockage. Par exemple, si votre classe d'instance actuelle est « db.r6gd.4xlarge », choisissez « db.r6g.4xlarge » pour revenir en arrière. Pour de plus amples informations, veuillez consulter [Modification d'un cluster Amazon DocumentDB](db-cluster-modify.md).

## Surveillance des instances NVMe basées sur la surveillance
<a name="monitoring-nvme"></a>

Outre les métriques d'instance standard disponibles sur Amazon CloudWatch, les instances NVMe soutenues par -backed émettent des métriques supplémentaires spécifiques au stockage SSD NVMe basé sur le stockage, aux IOPS et au débit. 

```
NVMeStorageCacheHitRatio
FreeNVMeStorage
ReadIOPSNVMeStorage
ReadLatencyNVMeStorage
ReadThroughputNVMeStorage
WriteIOPSNVMeStorage
WriteLatencyNVMeStorage
WriteThroughputNVMeStorage
```

Pour plus d'informations sur ces mesures, voir [NVMe-métriques d'instance soutenues](cloud_watch.md#nvme-metrics)

# Gestion des groupes de sous-réseaux Amazon DocumentDB
<a name="document-db-subnet-groups"></a>

Un cloud privé virtuel (VPC) est un réseau virtuel dédié à votre. Compte AWS Il est logiquement isolé des autres réseaux virtuels du AWS Cloud. Vous pouvez lancer vos AWS ressources, telles que les clusters Amazon DocumentDB, dans votre Amazon VPC. Vous pouvez spécifier une plage d'adresses IP pour le VPC, ajouter des sous-réseaux, associer des groupes de sécurité et configurer des tables de routage. 

Un sous-réseau est une plage d'adresses IP dans votre Amazon VPC. Vous pouvez lancer AWS des ressources dans un sous-réseau spécifique. Utilisez un sous-réseau *public* pour les ressources qui doivent être connectées à Internet. Utilisez un sous-réseau *privé* pour les ressources qui ne doivent pas être connectées à Internet. Pour plus d'informations sur les sous-réseaux publics et privés, consultez la section Bases du [VPC et des sous-réseaux](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#vpc-subnet-basics) dans *le guide de l'utilisateur d'Amazon Virtual Private Cloud*. 

Un groupe de sous-réseaux DB est une collection de sous-réseaux que vous créez dans un VPC et que vous spécifiez alors pour vos clusters. Un groupe de sous-réseaux vous permet de spécifier un VPC particulier lors de la création de clusters. Si vous utilisez le groupe de sous-réseaux `default`, ce dernier couvre tous les sous-réseaux dans le VPC.

Chaque groupe de sous-réseaux DB doit avoir des sous-réseaux dans au moins deux zones de disponibilité d'une région donnée. Lorsque vous créez un cluster de base de données dans un VPC, vous devez sélectionner un groupe de sous-réseaux de base de données. Amazon DocumentDB utilise ce groupe de sous-réseaux de base de données et votre zone de disponibilité préférée pour sélectionner un sous-réseau et une adresse IP au sein de ce sous-réseau à associer à votre cluster. En cas de défaillance de l'instance principale, Amazon DocumentDB peut promouvoir une instance de réplique correspondante en tant que nouvelle instance principale. Le service peut ensuite créer une nouvelle instance de réplica à l'aide d'une adresse IP du sous-réseau dans lequel l'ancienne instance principale était située.

Lorsqu'Amazon DocumentDB crée une instance dans un VPC, il attribue une interface réseau à votre cluster en utilisant une adresse IP sélectionnée dans votre groupe de sous-réseaux de base de données. Nous vous recommandons fortement d'utiliser le nom DNS car l'adresse IP sous-jacente peut changer pendant le basculement. Pour de plus amples informations, veuillez consulter [Points de terminaison Amazon DocumentDB](how-it-works.md#how-it-works.endpoints).

Pour plus d'informations sur la création de votre propre VPC et de vos sous-réseaux, consultez la section [Utilisation des sous-réseaux VPCs et des sous-réseaux](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html) dans le guide de l'utilisateur d'*Amazon Virtual Private Cloud*.

**Topics**
+ [Création d'un groupe de sous-réseaux Amazon DocumentDB](document-db-subnet-group-create.md)
+ [Décrire un groupe de sous-réseaux Amazon DocumentDB](document-db-subnet-group-describe.md)
+ [Modification d'un groupe de sous-réseaux Amazon DocumentDB](document-db-subnet-group-modify.md)
+ [Suppression d'un groupe de sous-réseaux Amazon DocumentDB](document-db-subnet-group-delete.md)

# Création d'un groupe de sous-réseaux Amazon DocumentDB
<a name="document-db-subnet-group-create"></a>

Lorsque vous créez un cluster Amazon DocumentDB, vous devez choisir un Amazon VPC et le groupe de sous-réseaux correspondant au sein de cet Amazon VPC pour lancer votre cluster. Les sous-réseaux déterminent la zone de disponibilité et la plage d'adresses IP au sein de la zone de disponibilité que vous souhaitez utiliser pour lancer une instance. 

Un groupe de sous-réseaux est un ensemble nommé de sous-réseaux (ou AZs) qui vous permet de spécifier les zones de disponibilité que vous souhaitez utiliser pour lancer des instances Amazon DocumentDB. Par exemple, dans un cluster comportant trois instances, il est recommandé de provisionner chacune de ces instances séparément AZs, afin d'optimiser la haute disponibilité. Ainsi, si une seule AZ échoue, cela n'affectera qu'une seule instance. 

Actuellement, les instances Amazon DocumentDB peuvent être provisionnées en trois instances au maximum. AZs Même si un groupe de sous-réseaux possède plus de trois sous-réseaux, vous ne pourrez utiliser que trois de ces sous-réseaux pour créer un cluster Amazon DocumentDB. Par conséquent, lorsque vous créez un groupe de sous-réseaux, nous vous recommandons de ne choisir que les trois sous-réseaux dans lesquels vous souhaitez déployer vos instances. 

Par exemple : un cluster est créé et Amazon DocumentDB choisit AZs \$11A, 1B et 1C\$1. Si vous essayez de créer une instance dans la zone de disponibilité \$11D\$1, l'appel d'API échoue. Toutefois, si vous choisissez de créer une instance, sans spécifier l'AZ en question, Amazon DocumentDB choisira une AZ en votre nom. Amazon DocumentDB utilise un algorithme pour équilibrer la charge des instances afin de vous aider AZs à atteindre une haute disponibilité. Si trois instances sont provisionnées, par défaut, elles seront provisionnées sur trois AZs et ne seront pas toutes provisionnées dans une seule zone de disponibilité.

Bonnes pratiques
+ Sauf si vous avez une raison précise, créez toujours un groupe de sous-réseaux avec trois sous-réseaux. Cela garantit que les clusters comportant trois instances ou plus seront en mesure d'atteindre une disponibilité supérieure, car les instances seront provisionnées sur trois AZs instances.
+ Répartissez toujours les instances sur plusieurs AZs pour atteindre une haute disponibilité. Ne placez jamais toutes les instances d'un cluster dans une seule zone de disponibilité.
+ Des événements de basculement pouvant se produire à n'importe quel moment, vous ne devez pas supposer qu'une instance principale ou des instances de réplica seront toujours placées dans une zone de disponibilité spécifique.

## Comment créer un groupe de sous-réseaux
<a name="document-db-subnet-group-how-create"></a>

Vous pouvez utiliser le AWS Management Console ou AWS CLI pour créer un groupe de sous-réseaux Amazon DocumentDB :

------
#### [ Using the AWS Management Console ]

Suivez les étapes ci-dessous pour créer un groupe de sous-réseaux Amazon DocumentDB.

**Pour créer un groupe de sous-réseaux Amazon DocumentDB**

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

1. Dans le panneau de navigation, choisissez **Groupes de sous-réseaux**, puis **Créer**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Sur la page **Create subnet group (Créer un groupe de sous-réseaux)** :

   1. Dans la section **Subnet group details (Informations sur le groupe de sous-réseaux)** :

      1. **Nom** —Entrez un nom significatif pour le groupe de sous-réseaux.

      1. **Description** – Saisissez une description pour le groupe de sous-réseaux.

   1. Dans la section **Add subnets (Ajouter des sous-réseaux)** :

      1. **VPC** —Dans la liste, choisissez un VPC pour ce groupe de sous-réseaux.

      1. Effectuez l’une des actions suivantes :
         + Pour inclure tous les sous-réseaux dans le VPC sélectionné, choisissez **Add all the subnets related to this VPC (Ajouter tous les sous-réseaux associés à ce VPC)**.
         + Pour spécifier des sous-réseaux pour ce groupe de sous-réseaux, effectuez les actions suivantes pour chaque zone de disponibilité dans laquelle vous souhaitez inclure des sous-réseaux. Vous devez inclure au moins deux zones de disponibilité.

           1. **Zone de disponibilité** : dans la liste, choisissez une zone de disponibilité.

           1. **Sous-réseau** —Dans la liste, choisissez un sous-réseau dans la zone de disponibilité choisie pour ce groupe de sous-réseaux.

           1. Sélectionnez **Add subnet (Ajouter le sous-réseau)**.

1. Sélectionnez **Create** (Créer). Lorsque le groupe de sous-réseaux est créé, il est répertorié avec vos autres groupes de sous-réseau.  
![\[Capture d’écran montrant les informations d’un groupe de sous-réseaux.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-subnet-groups-list.png)

------
#### [ Using the AWS CLI ]

Avant de créer un groupe de sous-réseaux à l'aide du AWS CLI, vous devez d'abord déterminer quels sous-réseaux sont disponibles. Exécutez l' AWS CLI opération suivante pour répertorier les zones de disponibilité et leurs sous-réseaux.

**Paramètres :**
+ **--db-subnet-group**—Facultatif. Lorsque vous spécifiez un groupe de sous-réseaux en particulier, ses zones de disponibilité et ses sous-réseaux sont répertoriés. Si vous ne spécifiez pas ce paramètre, les zones de disponibilité et les sous-réseaux de tous vos groupes de sous-réseaux seront répertoriés. Si vous spécifiez le groupe de sous-réseaux `default`, tous les sous-réseaux du VPC sont répertoriés.

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-subnet-groups \
    --db-subnet-group-name default \
    --query 'DBSubnetGroups[*].[DBSubnetGroupName,Subnets[*].[SubnetAvailabilityZone.Name,SubnetIdentifier]]'
```
Pour Windows :  

```
aws docdb describe-db-subnet-groups ^
    --db-subnet-group-name default ^
    --query 'DBSubnetGroups[*].[DBSubnetGroupName,Subnets[*].[SubnetAvailabilityZone.Name,SubnetIdentifier]]'
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
[
    [
        "default",
        [
            [
                "us-east-1a",
                "subnet-4e26d263"
            ],
            [
                "us-east-1c",
                "subnet-afc329f4"
            ],
            [
                "us-east-1e",
                "subnet-b3806e8f"
            ],
            [
                "us-east-1d",
                "subnet-53ab3636"
            ],
            [
                "us-east-1b",
                "subnet-991cb8d0"
            ],
            [
                "us-east-1f",
                "subnet-29ab1025"
            ]
        ]
    ]
]
```
Avec le résultat de l’opération précédente, vous pouvez créer un groupe de sous-réseaux. Le nouveau groupe de sous-réseaux doit inclure des sous-réseaux d'au moins deux zones de disponibilité.  

**Paramètres :**
+ **--db-subnet-group-name** : obligatoire. Nom du groupe de sous-réseaux.
+ **--db-subnet-group-description** : obligatoire. Description du groupe de sous-réseaux.
+ **--subnet-ids** : obligatoire. Liste des sous-réseaux à inclure dans ce groupe de sous-réseaux. Exemple: `subnet-53ab3636`.
+ --Tags **** —Facultatif. Liste de balises (paires clé-valeur) à associer à ce groupe de sous-réseaux.
Le code suivant crée le groupe de sous-réseaux `sample-subnet-group` avec trois sous-réseaux, `subnet-4e26d263`, `subnet-afc329f4` et `subnet-b3806e8f`.  
Pour Linux, macOS ou Unix :  

```
aws docdb create-db-subnet-group \
    --db-subnet-group-name sample-subnet-group \
    --db-subnet-group-description "A sample subnet group" \
    --subnet-ids subnet-4e26d263 subnet-afc329f4 subnet-b3806e8f \
    --tags Key=tag1,Value=One Key=tag2,Value=2
```
Pour Windows :  

```
aws docdb create-db-subnet-group ^
    --db-subnet-group-name sample-subnet-group ^
    --db-subnet-group-description "A sample subnet group" ^
    --subnet-ids subnet-4e26d263 subnet-afc329f4 subnet-b3806e8f ^
    --tags Key=tag1,Value=One Key=tag2,Value=2
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
{
    "DBSubnetGroup": {
        "DBSubnetGroupDescription": "A sample subnet group",
        "DBSubnetGroupName": "sample-subnet-group",
        "Subnets": [
            {
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1a"
                },
                "SubnetIdentifier": "subnet-4e26d263",
                "SubnetStatus": "Active"
            },
            {
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1c"
                },
                "SubnetIdentifier": "subnet-afc329f4",
                "SubnetStatus": "Active"
            },
            {
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1e"
                },
                "SubnetIdentifier": "subnet-b3806e8f",
                "SubnetStatus": "Active"
            }
        ],
        "VpcId": "vpc-91280df6",
        "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123SAMPLE012:subgrp:sample-subnet-group",
        "SubnetGroupStatus": "Complete"
    }
}
```

------

# Décrire un groupe de sous-réseaux Amazon DocumentDB
<a name="document-db-subnet-group-describe"></a>

Vous pouvez utiliser le AWS Management Console ou le AWS CLI pour obtenir les détails d'un groupe de sous-réseaux Amazon DocumentDB.

------
#### [ Using the AWS Management Console ]

La procédure suivante explique comment obtenir les détails d'un groupe de sous-réseaux Amazon DocumentDB.

**Pour trouver les informations d'un groupe de sous-réseaux**

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

1. Dans le panneau de navigation, choisissez **Subnet groups (Groupes de sous-réseaux)**. 
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Pour afficher les informations d'un groupe de sous-réseaux, choisissez le nom du groupe.  
![\[Capture d’écran montrant les informations d’un groupe de sous-réseaux.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-subnet-group-details.png)

------
#### [ Using the AWS CLI ]

Pour trouver les détails d'un groupe de sous-réseaux Amazon DocumentDB, utilisez l'`describe-db-subnet-groups`opération avec le paramètre suivant.

**Paramètre**
+ `--db-subnet=group-name`—Facultatif. Si inclues, les informations du groupe de sous-réseaux nommé sont répertoriées. Si omises, les informations d’un maximum de 100 groupes de sous-réseaux sont répertoriées.

**Example**  
Le code suivant répertorie les informations du groupe de sous-réseaux `sample-subnet-group` que nous avons créé dans la section [Création d'un groupe de sous-réseaux Amazon DocumentDB](document-db-subnet-group-create.md).  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-subnet-groups \
    --db-subnet-group-name sample-subnet-group
```
Pour Windows :  

```
aws docdb describe-db-subnet-groups ^
    --db-subnet-group-name sample-subnet-group
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
{
    "DBSubnetGroup": {
        "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123SAMPLE012:subgrp:sample-subnet-group",
        "VpcId": "vpc-91280df6",
        "SubnetGroupStatus": "Complete",
        "DBSubnetGroupName": "sample-subnet-group",
        "Subnets": [
            {
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1a"
                },
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-4e26d263"
            },
            {
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1c"
                },
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-afc329f4"
            },
            {
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1e"
                },
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-b3806e8f"
            }
        ],
        "DBSubnetGroupDescription": "A sample subnet group"
    }
}
```

------

# Modification d'un groupe de sous-réseaux Amazon DocumentDB
<a name="document-db-subnet-group-modify"></a>

Vous pouvez utiliser le AWS Management Console ou AWS CLI pour modifier la description d'un groupe de sous-réseaux ou pour ajouter ou supprimer des sous-réseaux d'un groupe de sous-réseaux Amazon DocumentDB. Toutefois, vous ne pouvez pas modifier le groupe de sous-réseaux `default`.

------
#### [ Using the AWS Management Console ]

Vous pouvez utiliser le AWS Management Console pour modifier la description d'un groupe de sous-réseaux ou pour ajouter et supprimer des sous-réseaux. Souvenez-vous que lorsque vous avez terminé, vous devez disposer d'au moins deux zones de disponibilité associées à votre groupe de sous-réseaux.

**Pour modifier votre groupe de sous-réseaux**

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

1. Dans le panneau de navigation, choisissez **Subnet groups (Groupes de sous-réseaux)**. Choisissez ensuite le bouton situé à gauche du nom du groupe de sous-réseaux. Souvenez-vous que vous ne pouvez pas modifier le groupe de sous-réseaux `default`.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Choisissez **Actions**, puis **Modify (Modifier)**.

1. **Description** —Pour modifier la description de votre groupe de sous-réseaux, entrez une nouvelle description.

1. Pour modifier les sous-réseaux associés à votre groupe de sous-réseaux, effectuez l’une des actions suivantes dans la section **Add subnets (Ajouter des sous-réseaux)** :
   + Pour supprimer tous les sous-réseaux de ce groupe, choisissez **Remove all (Supprimer tout)**.
   + Pour supprimer des sous-réseaux spécifiques de ce groupe, choisissez **Remove (Supprimer)** pour chaque sous-réseau à supprimer.
   + Pour ajouter tous les sous-réseaux associés à ce VPC, choisissez **Add all the subnets related to this VPC (Ajouter tous les sous-réseaux associés à ce VPC)**.
   + Pour ajouter des sous-réseaux spécifiques à ce groupe, procédez comme suit pour chaque zone de disponibilité à laquelle vous souhaitez ajouter un sous-réseau.

     1. **Zone de disponibilité** : dans la liste, choisissez une nouvelle zone de disponibilité.

     1. **Sous-réseau** —Dans la liste, choisissez un sous-réseau dans la zone de disponibilité choisie pour ce groupe de sous-réseaux.

     1. Sélectionnez **Add subnet (Ajouter le sous-réseau)**.

1. Dans la boîte de dialogue de confirmation :
   + Pour appliquer ces modifications au groupe de sous-réseaux, choisissez **Modify (Modifier)**.
   + Pour ne pas les appliquer, choisissez **Cancel (Annuler)**.

------
#### [ Using the AWS CLI ]

Vous pouvez utiliser le AWS CLI pour modifier la description d'un groupe de sous-réseaux ou pour ajouter et supprimer des sous-réseaux. Souvenez-vous que lorsque vous avez terminé, vous devez disposer d'au moins deux zones de disponibilité associées à votre groupe de sous-réseaux. Vous ne pouvez pas modifier le groupe de sous-réseaux `default`.

**Paramètres :**
+ `--db-subnet-group-name` : obligatoire. Nom du groupe de sous-réseaux Amazon DocumentDB que vous êtes en train de modifier.
+ `--subnet-ids` : obligatoire. Liste de tous les sous-réseaux qui doivent être dans le groupe de sous-réseaux une fois que cette modification est effectuée.
**Important**  
Tous les sous-réseaux qui se trouvent actuellement dans le groupe de sous-réseaux et qui ne sont pas inclus dans cette liste seront supprimés du groupe. Si vous souhaitez conserver les sous-réseaux actuellement présents dans le groupe de sous-réseaux, incluez-les dans cette liste.
+ `--db-subnet-group-description`—Facultatif. La description du groupe de sous-réseaux.

**Example**  
Le code suivant modifie la description et remplace les sous-réseaux existants par les sous-réseaux `subnet-991cb8d0`, `subnet-53ab3636` et `subnet-29ab1025`.  
Pour Linux, macOS ou Unix :  

```
aws docdb modify-db-subnet-group \
    --db-subnet-group-name sample-subnet-group \
    --subnet-ids subnet-991cb8d0 subnet-53ab3636 subnet-29ab1025 \
    --db-subnet-group-description "Modified subnet group"
```
Pour Windows :  

```
aws docdb modify-db-subnet-group ^
    --db-subnet-group-name sample-subnet-group ^
    --subnet-ids subnet-991cb8d0 subnet-53ab3636 subnet-29ab1025 ^
    --db-subnet-group-description "Modified subnet group"
```
La sortie de cette opération ressemble à ceci (format JSON). Notez qu'il s'agit du groupe de sous-réseaux qui a été créé dans la section [Création d'un groupe de sous-réseaux Amazon DocumentDB](document-db-subnet-group-create.md). Cependant, les sous-réseaux du groupe de sous-réseaux sont remplacés par ceux qui sont répertoriés dans l'opération `modify-db-subnet-group`.  

```
{
    "DBSubnetGroup": {
        "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123SAMPLE012:subgrp:sample-subnet-group",
        "DBSubnetGroupDescription": "Modified subnet group",
        "SubnetGroupStatus": "Complete",
        "Subnets": [
            {
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1d"
                },
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-53ab3636"
            },
            {
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1b"
                },
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-991cb8d0"
            },
            {
                "SubnetAvailabilityZone": {
                    "Name": "us-east-1f"
                },
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-29ab1025"
            }
        ],
        "VpcId": "vpc-91280df6",
        "DBSubnetGroupName": "sample-subnet-group"
    }
}
```

------

# Suppression d'un groupe de sous-réseaux Amazon DocumentDB
<a name="document-db-subnet-group-delete"></a>

Vous pouvez utiliser le AWS Management Console ou AWS CLI pour supprimer un groupe de sous-réseaux Amazon DocumentDB. Vous ne pouvez toutefois pas supprimer le groupe de sous-réseaux `default`.

------
#### [ Using the AWS Management Console ]

Vous pouvez utiliser le AWS Management Console pour supprimer un groupe de sous-réseaux. Mais vous ne pouvez pas supprimer le groupe de sous-réseaux `default`.

**Pour supprimer un groupe de sous-réseaux**

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

1. Dans le panneau de navigation, choisissez **Subnet groups (Groupes de sous-réseaux)**. Choisissez ensuite le bouton situé à gauche du nom du groupe de sous-réseaux. Souvenez-vous que vous ne pouvez pas supprimer le groupe de sous-réseaux `default`.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Choisissez **Actions**, puis **Supprimer**.

1. Dans la boîte de dialogue de confirmation :
   + Pour supprimer le groupe de sous-réseaux, choisissez **Delete (Supprimer)**.
   + Pour conserver le groupe de sous-réseaux, choisissez **Cancel (Annuler)**.

------
#### [ Using the AWS CLI ]

Pour supprimer un groupe de sous-réseaux Amazon DocumentDB à l'aide de AWS CLI, utilisez l'`delete-db-subnet-group`opération avec le paramètre suivant.

**Paramètre**
+ `--db-subnet-group-name` : obligatoire. Nom du groupe de sous-réseaux Amazon DocumentDB à supprimer. Souvenez-vous que vous ne pouvez pas supprimer le groupe de sous-réseaux `default`.

**Example**  
Le code suivant permet de supprimer `sample-subnet-group`.  
Pour Linux, macOS ou Unix :  

```
aws docdb delete-db-subnet-group \
    --db-subnet-group-name sample-subnet-group
```
Pour Windows :  

```
aws docdb delete-db-subnet-group ^
    --db-subnet-group-name sample-subnet-group
```
L'opération ne produit aucun résultat.

------

# Amazon DocumentDB Haute disponibilité et réplication
<a name="replication"></a>

Vous pouvez obtenir une haute disponibilité et un dimensionnement de lecture dans Amazon DocumentDB (avec compatibilité avec MongoDB) en utilisant des instances de réplication. Un seul cluster Amazon DocumentDB prend en charge une seule instance principale et jusqu'à 15 instances de réplication. Ces instances peuvent être réparties sur les différentes zones de disponibilité au sein de la région du cluster. L'instance principale accepte le trafic en lecture et en écriture et les instances de réplica acceptent uniquement les demandes en lecture.

Le volume de cluster est composé de plusieurs copies des données du cluster. Toutefois, les données du volume du cluster sont représentées sous la forme d'un volume logique unique pour l'instance principale et pour les répliques Amazon DocumentDB du cluster. Les instances de réplica sont cohérentes à terme. Elles renvoient les mêmes données pour les résultats des requêtes avec un retard de réplica minimal, généralement inférieur à 100 ms après l'écriture d'une mise à jour par l'instance principale. Le retard de réplica varie en fonction de la fréquence de modification de la base de données. Autrement dit, pendant les périodes où une importante quantité d'opérations d'écriture se produit pour la base de données, il se peut que vous constatiez un retard accru du réplica. 

## Dimensionnement en lecture
<a name="replication.read-scaling"></a>

Les répliques Amazon DocumentDB fonctionnent bien pour le dimensionnement des lectures, car elles sont entièrement dédiées aux opérations de lecture sur votre volume de cluster. Les opérations d'écriture sont gérées par l'instance principale. Le volume du cluster est partagé entre toutes les instances de votre cluster. Par conséquent, il n'est pas nécessaire de répliquer et de conserver une copie des données pour chaque réplique Amazon DocumentDB. 

## Haute disponibilité
<a name="replication.high-availability"></a>

Lorsque vous créez un cluster Amazon DocumentDB, en fonction du nombre de zones de disponibilité dans le groupe de sous-réseaux (il doit y en avoir au moins deux), Amazon DocumentDB approvisionne les instances dans les zones de disponibilité. Lorsque vous créez des instances dans le cluster, Amazon DocumentDB distribue automatiquement les instances entre les zones de disponibilité d'un groupe de sous-réseaux afin d'équilibrer le cluster. Cette action évite également que toutes les instances soient situées dans la même zone de disponibilité.

**exemple**  
Pour illustrer ce point, prenons un exemple dans lequel vous créez un cluster doté d'un groupe de sous-réseaux avec trois zones de disponibilité : *AZ1*AZ2**, et *AZ3*.

Une fois la première instance du cluster créée, elle devient l'instance principale et elle est située dans l'une des zones de disponibilité. Dans cet exemple, c'est dans *AZ1*. La deuxième instance créée est une instance de réplique située dans l'une des deux autres zones de disponibilité, par exemple *AZ2*. La troisième instance créée est une instance de réplique située dans la zone de disponibilité restante, *AZ3*. Si vous créez plusieurs instances, elles sont réparties entre les zones de disponibilité afin d'équilibrer le cluster.

Si une défaillance survient dans l'instance principale (AZ1), un basculement est déclenché et l'une des répliques existantes est promue en instance principale. Lorsque l'ancien serveur principal est rétabli, il devient une réplique dans la même zone de disponibilité que celle dans laquelle il a été approvisionné ()AZ1. Lorsque vous provisionnez un cluster à trois instances, Amazon DocumentDB continue de préserver ce cluster à trois instances. Amazon DocumentDB gère automatiquement la détection, le basculement et la restauration des défaillances d'instance sans aucune intervention manuelle.

Lorsqu'Amazon DocumentDB effectue un basculement et récupère une instance, l'instance récupérée reste dans la zone de disponibilité dans laquelle elle a été initialement mise en service. Toutefois, le rôle de l'instance peut changer, l'instance principale devenant instance de réplica. Cette opération permet d'éviter le scénario où une série de basculements entraîne la présence de toutes les instances dans la même zone de disponibilité.

Vous pouvez spécifier des répliques Amazon DocumentDB comme cibles de basculement. En d'autres termes, si l'instance principale échoue, la réplique Amazon DocumentDB spécifiée ou la réplique d'un niveau est promue vers l'instance principale. Il y a une brève interruption, pendant laquelle les demandes de lecture et d'écriture adressées à l'instance principale échouent en renvoyant une exception. Si votre cluster Amazon DocumentDB n'inclut aucune réplique Amazon DocumentDB, lorsque l'instance principale échoue, elle est recréée. La promotion d'une réplique Amazon DocumentDB est beaucoup plus rapide que la recréation de l'instance principale. 

Pour les scénarios de haute disponibilité, nous vous recommandons de créer une ou plusieurs répliques Amazon DocumentDB. Ces répliques doivent appartenir à la même classe d'instance que l'instance principale et se trouver dans des zones de disponibilité différentes pour votre cluster Amazon DocumentDB.

Pour plus d’informations, consultez les ressources suivantes :
+ [Comprendre la tolérance aux pannes des clusters Amazon DocumentDB](db-cluster-fault-tolerance.md)
+ [Basculement d'Amazon DocumentDB](failover.md)
  + [Contrôle de la cible de basculement](failover.md#failover-target_control)

### Haute disponibilité grâce aux clusters mondiaux
<a name="replication.high-availability.global-clusters"></a>

Pour une haute disponibilité sur plusieurs sites Régions AWS, vous pouvez configurer des clusters [globaux Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/global-clusters.html). Chaque cluster mondial couvre plusieurs régions, ce qui permet des lectures globales à faible latence et une reprise après sinistre après des pannes survenant sur un. Région AWS Amazon DocumentDB gère automatiquement la réplication de toutes les données et mises à jour de la région principale vers chacune des régions secondaires.

## Ajout de réplicas
<a name="replication.adding-replicas"></a>

La première instance ajoutée au cluster est l'instance principale. Chaque instance ajoutée après la première instance est une instance de réplica. Un cluster peut comporter jusqu'à 15 instances de réplication en plus de l'instance principale.

Lorsque vous créez un cluster à l'aide du AWS Management Console, une instance principale est automatiquement créée en même temps. Pour créer un réplica en même temps que vous créez le cluster et l'instance principale, choisissez **Créer un réplica dans différentes zones**. Pour plus d'informations, consultez l'étape 4.d dans [Création d'un cluster Amazon DocumentDB](db-cluster-create.md). Pour ajouter d'autres répliques à un cluster Amazon DocumentDB, consultez. [Ajouter une instance Amazon DocumentDB à un cluster](db-instance-add.md)

Lorsque vous utilisez le AWS CLI pour créer votre cluster, vous devez créer explicitement vos instances principales et répliques. Pour plus d'informations, consultez la section « Utilisation du AWS CLI » dans les rubriques suivantes :
+ [Création d'un cluster Amazon DocumentDB](db-cluster-create.md)
+ [Ajouter une instance Amazon DocumentDB à un cluster](db-instance-add.md)

# Basculement d'Amazon DocumentDB
<a name="failover"></a>

Dans certains cas, tels que certains types de maintenance planifiée, ou dans le cas peu probable d'une défaillance d'un nœud principal ou d'une zone de disponibilité, Amazon DocumentDB (compatible avec MongoDB) détecte la panne et remplace le nœud principal. Au cours d'un basculement, le délai d'écriture est réduit. En effet, le rôle du nœud principal est transféré à l'un des réplicas en lecture et il n'est pas nécessaire de créer et d'allouer un nouveau nœud principal. La détection d'un échec ou la promotion d'un réplica vous permettent de recommencer à écrire dans le nouveau nœud principal dès que la promotion est terminée.

Pour que le basculement fonctionne, votre cluster doit comporter au moins deux instances : une instance principale et au moins une instance de réplication.

**Note**  
Cette rubrique s'applique uniquement aux clusters originaux basés sur des instances Amazon DocumentDB. Elle ne s'applique pas aux clusters élastiques ou globaux.

## Contrôle de la cible de basculement
<a name="failover-target_control"></a>

Amazon DocumentDB vous fournit des niveaux de basculement afin de contrôler quelle instance de réplique est promue en instance principale en cas de basculement.

**Niveaux de basculement**  
Chaque instance de réplique est associée à un niveau de basculement (0 à 15). Lorsqu'un basculement survient en raison d'une maintenance ou d'une défaillance matérielle peu probable, l'instance principale bascule vers une réplique ayant la priorité la plus élevée (le niveau numéroté le plus bas). Si plusieurs répliques ont le même niveau de priorité, le niveau principal bascule vers le réplica de ce niveau dont la taille est la plus proche de celle du niveau principal précédent.

En définissant le niveau de basculement pour un groupe de réplicas sélectionnés pour `0` (la priorité la plus haute), vous pouvez vous assurer qu'un basculement promeut l'un des réplicas dans ce groupe. Une manière efficace d'empêcher que des réplicas spécifiques ne soient promus en principal en cas de basculement consiste à leur attribuer un niveau de priorité faible (chiffre élevé). Cela s'avère utile dans les cas où les réplicas spécifiques font l'objet d'une utilisation intensive de la part d'une application et le basculement vers l'un d'entre eux pourrait avoir un impact négatif sur une application critique.

Vous pouvez définir le niveau de basculement d'une instance lorsque vous la créez ou plus tard en la modifiant. Le définition d'un niveau de basculement d'une instance en modifiant cette dernière ne déclenche pas un basculement. Pour plus d'informations, consultez les rubriques suivantes :
+ [Ajouter une instance Amazon DocumentDB à un cluster](db-instance-add.md)
+ [Modification d'une instance Amazon DocumentDB](db-instance-modify.md)

Lorsque vous lancez manuellement un basculement, vous avez deux moyens de contrôler quelle instance de réplica est promue en instance principale : le niveau de basculement comme décrit précédemment, et le paramètre `--target-db-instance-identifier`.

**--`target-db-instance-identifier`**  
Pour le test, vous pouvez forcer un événement de basculement à l'aide de l'opération `failover-db-cluster`. Vous pouvez utiliser le paramètre `--target-db-instance-identifier` pour spécifier le réplica à promouvoir en réplica principal. L'utilisation du paramètre `--target-db-instance-identifier` remplace le niveau de priorité de basculement. Si vous ne spécifiez pas le paramètre `--target-db-instance-identifier`, le basculement principal est conforme au niveau de priorité de basculement.



## Que se passe-t-il lors d'un basculement
<a name="failover-what_happens"></a>

Le basculement est automatiquement géré par Amazon DocumentDB afin que vos applications puissent reprendre les opérations de base de données le plus rapidement possible sans intervention administrative.
+ Si vous avez une instance de réplique Amazon DocumentDB dans la même zone de disponibilité ou dans une autre zone de disponibilité en cas de basculement : Amazon DocumentDB renverse le nom canonique (CNAME) de votre instance pour qu'il pointe vers la réplique saine, qui est à son tour promue pour devenir la nouvelle instance principale. Le basculement complet s'effectue généralement en 30 secondes.
+ Si vous ne possédez pas d'instance de réplique Amazon DocumentDB (par exemple, un cluster d'instances unique) : Amazon DocumentDB tentera de créer une nouvelle instance dans la même zone de disponibilité que l'instance d'origine. Ce remplacement de l'instance d'origine s'effectue de manière optimale et peut échouer si, par exemple, un problème affecte de manière générale la zone de disponibilité.

Votre application devrait tenter une nouvelle connexion à la base de données dans le cas d'une perte de connexion.

## Test du basculement
<a name="failover-testing"></a>

En cas de basculement d'un cluster, l'une des répliques Amazon DocumentDB (instances en lecture seule) du cluster devient l'instance principale (le rédacteur du cluster).

Lorsque l'instance principale échoue, Amazon DocumentDB bascule automatiquement vers une réplique Amazon DocumentDB, s'il en existe une. Vous pouvez forcer un basculement lorsque vous souhaitez simuler un échec d'une instance principale à des fins de test. Chaque instance d'un cluster possède sa propre adresse de point de terminaison. Vous devez donc nettoyer et rétablir toutes les connexions existantes qui utilisent ces adresses de point de terminaison lorsque le basculement est effectué.

Pour forcer un basculement, utilisez l'opération `failover-db-cluster` avec ces paramètres.
+ `--db-cluster-identifier` : obligatoire. Nom du cluster qui doit basculer.
+ `--target-db-instance-identifier`—Facultatif. Le nom de l'instance à promouvoir comme instance principale.

**Example**  
L'opération suivante force un basculement du cluster `sample-cluster`. Il ne précise pas quelle instance doit être créée comme nouvelle instance principale. Amazon DocumentDB choisit donc l'instance en fonction de la priorité du niveau de basculement.  
Pour Linux, macOS ou Unix :  

```
aws docdb failover-db-cluster \
   --db-cluster-identifier sample-cluster
```
Pour Windows :  

```
aws docdb failover-db-cluster ^
   --db-cluster-identifier sample-cluster
```
L'opération suivante force un basculement du cluster `sample-cluster`, en spécifiant quelle `sample-cluster-instance` est à promouvoir en tant que rôle principal. (Notez la valeur `"IsClusterWriter": true` dans la sortie).  
Pour Linux, macOS ou Unix :  

```
aws docdb failover-db-cluster \
   --db-cluster-identifier sample-cluster \
   --target-db-instance-identifier sample-cluster-instance
```
Pour Windows :  

```
aws docdb failover-db-cluster ^
   --db-cluster-identifier sample-cluster ^
   --target-db-instance-identifier sample-cluster-instance
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
{
    "DBCluster": {
        "HostedZoneId": "Z2SUY0A1719RZT",
        "Port": 27017,
        "EngineVersion": "3.6.0",
        "PreferredMaintenanceWindow": "thu:04:05-thu:04:35",
        "BackupRetentionPeriod": 1,
        "ClusterCreateTime": "2018-06-28T18:53:29.455Z",
        "AssociatedRoles": [],
        "DBSubnetGroup": "default",
        "MasterUsername": "master-user",
        "Engine": "docdb",
        "ReadReplicaIdentifiers": [],
        "EarliestRestorableTime": "2018-08-21T00:04:10.546Z",
        "DBClusterIdentifier": "sample-cluster",
        "ReaderEndpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
        "DBClusterMembers": [
            {
                "DBInstanceIdentifier": "sample-cluster-instance",
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1,
                "IsClusterWriter": true
            },
            {
                "DBInstanceIdentifier": "sample-cluster-instance-00",
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1,
                "IsClusterWriter": false
            },
            {
                "DBInstanceIdentifier": "sample-cluster-instance-01",
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1,
                "IsClusterWriter": false
            }
        ],
        "AvailabilityZones": [
            "us-east-1b",
            "us-east-1c",
            "us-east-1a"
        ],
        "DBClusterParameterGroup": "default.docdb3.6",
        "Endpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
        "IAMDatabaseAuthenticationEnabled": false,
        "AllocatedStorage": 1,
        "LatestRestorableTime": "2018-08-22T21:57:33.904Z",
        "PreferredBackupWindow": "00:00-00:30",
        "StorageEncrypted": false,
        "MultiAZ": true,
        "Status": "available",
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-12345678"
            }
        ],
        "DbClusterResourceId": "cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    }
}
```

## Décalage de réplication
<a name="troubleshooting.replication-lag"></a>

Le délai de réplication est généralement de 50 ms ou moins. Les raisons les plus courantes de l'augmentation du délai de réplication sont les suivantes :
+ Un taux d'écriture élevé sur le primaire qui fait que les répliques de lecture prennent du retard par rapport au principal.
+ Conflit sur les répliques en lecture entre les requêtes de longue durée (par exemple, les scans séquentiels volumineux, les requêtes d'agrégation) et la réplication en écriture entrante.
+ Très grand nombre de requêtes simultanées sur les répliques lues.

Pour minimiser le délai de réplication, essayez les techniques de résolution des problèmes suivantes :
+ Si votre taux d'écriture ou votre taux d'utilisation du processeur est élevé, nous vous recommandons d'augmenter le nombre d'instances de votre cluster.
+ Si vos répliques en lecture comportent des requêtes de longue durée et si les documents sont fréquemment mis à jour, pensez à modifier vos requêtes de longue durée ou à les exécuter par rapport à la réplique principale/d'écriture pour éviter tout conflit sur les répliques en lecture.
+ En cas de très grand nombre de requêtes simultanées ou d'utilisation élevée du processeur uniquement sur les répliques en lecture, une autre option consiste à augmenter le nombre de répliques en lecture afin de répartir la charge de travail.
+ Le retard de réplication étant le résultat d'un débit d'écriture élevé et de requêtes de longue durée, nous vous recommandons de résoudre ce problème en utilisant la métrique DBCluster ReplicaLagMaximum CW en combinaison avec l'enregistreur de requêtes lent et `WriteThroughput` les métriques/. `WriteIOPS`

En général, nous recommandons que toutes vos répliques soient du même type d'instance, afin qu'un basculement du cluster n'entraîne pas de dégradation des performances.

Si vous choisissez entre une mise à l'échelle supérieure ou une extension externe (par exemple, six instances plus petites contre trois instances plus grandes), nous vous recommandons généralement d'essayer d'abord de procéder à une mise à l'échelle (instances plus grandes) avant de procéder à une mise à l'échelle externe, car vous obtiendrez un cache tampon plus important par instance de base de données.

De manière proactive, vous devez définir une alarme de retard de réplication et définir son seuil à une valeur que vous considérez comme la limite supérieure du retard (ou « périmé ») de vos données sur les instances de réplication avant que cela ne commence à affecter les fonctionnalités de votre application. En général, nous conseillons de dépasser le seuil de délai de réplication pour plusieurs points de données avant de déclencher une alarme, en raison de charges de travail transitoires.

**Note**  
En outre, nous vous recommandons de définir une autre alarme pour les délais de réplication supérieurs à 10 secondes. Si vous dépassez ce seuil pour plusieurs points de données, nous vous recommandons d'augmenter le volume de vos instances ou de réduire le débit d'écriture sur l'instance principale.

# Gestion des index Amazon DocumentDB
<a name="managing-indexes"></a>

**Topics**
+ [Création d'index Amazon DocumentDB](#index-creation)
+ [Gestion des index Amazon DocumentDB](#maintaining-indexes)

## Création d'index Amazon DocumentDB
<a name="index-creation"></a>

La création d'index dans Amazon DocumentDB nécessite la prise d'un certain nombre de décisions : 
+ Dans quel délai doit-il être terminé ?
+ La collection peut-elle être inaccessible pendant la construction ?
+ Quelle quantité de puissance de calcul d'une instance peut être allouée à la construction ?
+ Quel type d'index faut-il créer ?

Cette section vous aide à répondre à ces questions et fournit les commandes et les exemples de surveillance pour créer un index Amazon DocumentDB sur votre collection de clusters basée sur une instance.

### Consignes
<a name="indexing-guidelines"></a>

Les directives suivantes incluent les limites de base et les compromis de configuration lors de la création de nouveaux index :
+ **Prise en charge des versions d'Amazon DocumentDB** : alors que l'indexation par un seul travailleur est prise en charge sur toutes les versions d'Amazon DocumentDB, l'indexation par plusieurs travailleurs n'est prise en charge que sur les versions 4.0 et 5.0 d'Amazon DocumentDB.
+ Compromis **en termes de performances** : l'augmentation du nombre de travailleurs participant au processus de création de l'index augmente l'utilisation du processeur et augmente les E/S de lecture sur l'instance principale de votre base de données Amazon DocumentDB. Les ressources nécessaires à la création d'un nouvel index ne seront pas disponibles pour votre charge de travail en cours d'exécution.
+ **Clusters élastiques** : l'indexation parallèle n'est pas prise en charge sur les clusters élastiques Amazon DocumentDB.
+ Nombre **maximum de travailleurs** : le nombre maximum de travailleurs que vous pouvez configurer dépend de la taille de votre instance principale dans votre cluster de base de données. C'est la moitié du nombre total de v CPUs sur l'instance principale de votre cluster de base de données. Par exemple, vous pouvez exécuter un maximum de 32 travailleurs sur une instance db.r6g.16xlarge de 64 v. CPUs
**Note**  
Les travailleurs parallèles ne sont pas pris en charge sur les classes d'instance 2xlarge et inférieures.
+ Nombre **minimum de travailleurs** : le nombre minimum de travailleurs que vous pouvez configurer est de un. Le paramètre par défaut pour la création d'index sur des clusters basés sur des instances est de deux travailleurs. Cependant, vous pouvez réduire le nombre de travailleurs à un en utilisant l'option « threads de travail ». Cela exécutera le processus avec un seul travailleur.
+ **Compression d'index** : Amazon DocumentDB ne prend pas en charge la compression d'index. La taille des données pour les index peut être plus importante que lorsque vous utilisez d'autres options.
+ **Indexation de plusieurs collections** : la moitié du v de CPUs l'instance principale de votre cluster de base de données peut être utilisée pour les travailleurs configurés qui créent des index sur plusieurs collections.
+ **Types d'index** : consultez [ce billet de blog](https://aws.amazon.com/blogs/database/how-to-index-on-amazon-documentdb-with-mongodb-compatibility/) pour obtenir une explication complète des types d'index pris en charge sur Amazon DocumentDB.

### Prise en main
<a name="index-build-get-started"></a>

Pour démarrer la création d'un index sur une collection, utilisez la `createIndexes` commande. Par défaut, la commande exécute deux tâches parallèles, ce qui multiplie par deux la vitesse du processus de création d'index.

Par exemple, le processus de commande suivant montre comment créer un index pour le champ « user\$1name » dans un document et augmenter la vitesse du processus d'indexation à quatre travailleurs :

1. Créez des index à l'aide de deux workers parallèles sur le cluster :

   ```
   db.runCommand({"createIndexes":"test","indexes":[{"key": {"user_name":1}, "name":"username_idx"}]})
   ```

1. Pour optimiser la vitesse du processus de création d'index, vous pouvez spécifier le nombre de travailleurs en utilisant l'option « threads de travail » (`"workers":<number>`) dans la `db.runCommand createIndexes` commande.

   Augmentez la vitesse du processus à quatre travailleurs parallèles :

   ```
   db.runCommand({"createIndexes":"test","indexes":[{"key": {"user_name":1}, "name":"username_idx", "workers":4}]})
   ```
**Note**  
Plus le nombre de travailleurs est élevé, plus la création de l'indice progresse rapidement. Cependant, plus le nombre de travailleurs augmente, plus la charge augmente sur le v CPUs et le READ IO de votre instance principale. Assurez-vous que votre cluster est suffisamment provisionné pour faire face à la charge accrue sans dégrader les autres charges de travail.

### État de progression de l'indexation
<a name="index-build-status"></a>

Le processus de création d'index fonctionne en initialisant, en scannant les collections, en triant les clés et, enfin, en insérant des clés au moyen d'un générateur d'index. Le processus comporte jusqu'à six étapes lorsque vous l'exécutez au premier plan, et jusqu'à neuf étapes lorsque vous l'exécutez en arrière-plan. Vous pouvez consulter les indicateurs d'état tels que le pourcentage d'achèvement, le nombre total de blocs de stockage numérisés, les clés triées et les clés insérées étape par étape.

Surveillez la progression du processus d'indexation à l'aide de la `db.currentOp()` commande dans le shell mongo. L'achèvement à 100 % de la dernière étape indique que tous les index ont été créés avec succès :

```
db.currentOp({"command.createIndexes": { $exists : true } })
```

**Note**  
L'affichage de l'état de progression de l'indexation n'est pris en charge que sur Amazon DocumentDB 5.0.

#### Types de construction d'index
<a name="index-build-types"></a>

Les quatre types de constructions d'index sont les suivants :
+ **Premier plan** : la version de l'index de premier plan bloque toutes les autres opérations de base de données jusqu'à ce que l'index soit créé. La version de premier plan d'Amazon DocumentDB comprend cinq étapes.
+ **Premier plan (unique)** — Les versions d'index de premier plan pour un seul document (unique) bloquent d'autres opérations de base de données, comme les versions de premier plan classiques. Contrairement à la version de premier plan de base, la version unique utilise une étape supplémentaire (tri des clés 2) pour rechercher les clés dupliquées. La version de premier plan (unique) comprend six étapes.
+ **Arrière-plan** — La génération de l'index en arrière-plan permet à d'autres opérations de base de données de s'exécuter au premier plan pendant la création de l'index. La construction en arrière-plan d'Amazon DocumentDB comprend huit étapes.
+ **Arrière-plan (unique)** — Les versions d'index d'arrière-plan pour un seul document (unique) permettent à d'autres opérations de base de données de s'exécuter au premier plan pendant la création de l'index. Contrairement à la version d'arrière-plan de base, la version unique utilise une étape supplémentaire (tri des clés 2) pour rechercher les clés dupliquées. La version d'arrière-plan (unique) comprend neuf étapes.

#### Étapes de création de l'index
<a name="index-build-stages"></a>


| Étape | Premier plan | Premier plan (unique) | Contexte | Contexte (unique) | 
| --- | --- | --- | --- | --- | 
|  Initialisation  |  1  |  1  |  1  |  1  | 
|  index de construction : initialisation  |  2  |  2  |  2  |  2  | 
|  index des bâtiments : collection de numérisation  |  3  |  3  |  3  |  3  | 
|  index du bâtiment : clés de tri 1  |  4  |  4  |  4  |  4  | 
|  index du bâtiment : clés de tri 2  |    |  5  |    |  5   | 
|  index de construction : insertion de clés  |  5   |  6  |  5   |  6  | 
|  validation : index de numérisation  |    |    |  6  |  7  | 
|  validation : tri des tuples  |    |    |  7  |  8  | 
|  validation : numérisation de la collection  |    |    |  8  |  9  | 
+ **initialisation** - CreateIndex prépare le générateur d'index. Cette phase doit être très brève.
+ **building index : initialization -** Le générateur d'index se prépare à créer l'index. Cette phase doit être très brève.
+ **index de construction : analyse de la collection** - Le générateur d'index effectue une analyse de collection pour collecter les clés d'index. L'unité de mesure est le « bloc ».
**Note**  
Si plusieurs outils de travail sont configurés pour la création de l'index, ils sont affichés à cette étape. L'étape de « numérisation de la collecte » est la seule étape qui utilise plusieurs travailleurs pendant le processus de création de l'index. Toutes les autres étapes afficheront un seul travailleur.
+ **index de construction : tri des clés 1** - Le générateur d'index trie les clés d'index collectées. L'unité de mesure est « clés ».
+ **index de construction : clés de tri 2** - Le générateur d'index trie les clés d'index collectées qui correspondent à des tuples morts. Cette phase n'existe que pour la création d'index uniques. L'unité de mesure est « clés ».
+ **index de construction : insertion de clés** - Le générateur d'index insère des clés d'index dans le nouvel index. L'unité de mesure est « clés ».
+ **validation : index de numérisation** - CreateIndex analyse l'index pour trouver les clés qui doivent être validées. L'unité de mesure est le « bloc ». 
+ **validation : tri des tuples** - CreateIndex trie le résultat de la phase de numérisation de l'index.
+ **validation : numérisation de la collection** - CreateIndex analyse la collection pour valider les clés d'index trouvées lors des deux phases précédentes. L'unité de mesure est le « bloc ».

#### Exemple de sortie de création d'index
<a name="w2aac33c19b5c13c15"></a>

Dans l'exemple de sortie ci-dessous (création d'index de premier plan), l'état de la création de l'index est affiché. Le champ « msg » résume la progression de la construction en indiquant l'étape et le pourcentage d'achèvement de la construction. Le champ « travailleurs » indique le nombre de travailleurs utilisés au cours de cette étape de la construction de l'indice. Le champ « progression » indique les chiffres réels utilisés pour calculer le pourcentage d'achèvement.

**Note**  
Les champs « currentIndexBuild Nom », « msg » et « progression » ne sont pas pris en charge sur Amazon DocumentDB version 4.0.

```
{
    "inprog" : [{
    … 
        "command": {
            "createIndexes": "test",
            "indexes": [{
                "v": 2,
                "key": {
                    "user_name": 1
                },
                "name": "user_name_1"
            }],
            "lsid": {
                "id": UUID(“094d0fba-8f41-4373-82c3-7c4c7b5ff13b”)
            },
            "$db": "test"
        },
        "currentIndexBuildName": user_name_1,
        "msg": "Index Build: building index number_1, stage 6/6 building index: 656860/1003520 (keys) 65%",
        "workers": 1,
        "progress": {
            "done": 656861,
            "total": 1003520
        },
    … 
    ],
 
    "ok" : 1
}
```

## Gestion des index Amazon DocumentDB
<a name="maintaining-indexes"></a>

**Topics**
+ [Gonflement des index](#db-index-bloat)
+ [Maintenance de l'index en utilisant `reIndex`](#reIndex)

### Gonflement des index
<a name="db-index-bloat"></a>

Amazon DocumentDB utilise le contrôle de concurrence multiversion (MVCC) pour gérer les transactions simultanées. Lorsque des documents sont supprimés ou mis à jour, leurs versions précédentes restent dans les collections et les index en tant que versions « mortes ». Le processus de collecte des déchets permet de récupérer automatiquement de l'espace dans ces versions mortes pour les opérations futures.

Le gonflement des index se produit lorsque les index d'une collection augmentent en raison de l'accumulation d'entrées d'index mortes ou obsolètes ou de la fragmentation des pages. Le pourcentage indiqué représente la quantité d'espace d'index qui peut être utilisée par les futures entrées d'index. Cette surcharge consomme de l'espace à la fois dans le cache tampon et dans le stockage. Si vous souhaitez supprimer le surmenage, vous devez reconstruire les index.

**Example Exemple**  
Exécutez la commande suivante pour déterminer le stockage inutilisé pour votre index :  

```
db.coll.aggregate({$indexStats:{}});
```
Le résultat ressemble à ceci :  

```
{ 
    "name" : "_id_",
    "key" : { 
        "_id" : 1 
    },
    "host" : "devbox-test.localhost.a2z.com:27317",
    "size" : NumberLong(827392),
    "accesses" : {
        "ops" : NumberLong(40000),
        "docsRead" : NumberLong(46049),
        "since" : ISODate("2025-04-03T21:44:51.251Z") 
    },
    "cacheStats" : {
        "blksRead" : NumberLong(264),
        "blksHit" : NumberLong(140190),
        "hitRatio" : 99.8121
    }, 
    "unusedStorageSize" : {
        "unusedSizeBytes" : 409600,
        "unusedSizePercent" : 49.51
    }
}
```

Vous pouvez reconstruire les index sans interruption à l'aide de la `reIndex` commande, qui nécessite une analyse de l'ensemble de la collection. Consultez [Maintenance de l'index en utilisant `reIndex`](#reIndex).

### Maintenance de l'index en utilisant `reIndex`
<a name="reIndex"></a>

`reIndex`est une commande utilisée pour reconstruire un index. Il est généralement utilisé lorsqu'un index est corrompu ou inefficace. Au fil du temps, les index peuvent accumuler de l'espace inutilisé en raison de nombreuses mises à jour, insertions ou suppressions, ce qui entraîne une dégradation des performances. La réindexation permet de supprimer cet espace inutilisé et de rétablir l'efficacité de l'index.

#### `reIndex`directives
<a name="w2aac33c19b7b7b5"></a>
+ `reIndex`n'est pris en charge que sur Amazon DocumentDB 5.0.
+ Amazon DocumentDB prend en charge `reindex` un seul index en arrière-plan, ce qui permet à plusieurs travailleurs de travailler. L'ancien index est utilisable par les requêtes lorsque le `reIndex` processus est en cours d'exécution.
+ Amazon DocumentDB prend en charge l'indexation des rapports de progression via. `currentOp` Vous pouvez voir des étapes de création d'index similaires à celles [Étapes de création de l'index](#index-build-stages) observées lors de la création de l'index. La seule différence est qu'il comporte `reIndex` toujours huit étapes, qu'elles soient uniques ou non. Il n'y a pas d'étape « index de construction : tri des clés 2 ».
+ `reIndex`peut être exécutée simultanément avec n'importe quelle commande, à l'exception des commandes liées à l'index dans la même collection :`createIndexes`,`dropIndexes`, `collMod` et. `renameCollection`
+ `reIndex`n'est actuellement pas pris en charge pour les index textuels, géospatiaux, vectoriels et partiels.

##### `reIndex`construire
<a name="w2aac33c19b7b7b5b5"></a>

Utilisez la commande suivante pour reconstruire votre index :

```
db.runCommand({ reIndex: "collection-name", index: "index-name"})
```

Facultativement, vous pouvez également contrôler le nombre de travailleurs affectés au processus de reconstruction :

```
db.runCommand({ reIndex: "collection-name", index: "index-name", workers: number })
```

# Gestion de la compression de documents au niveau de la collection
<a name="doc-compression"></a>

La compression de documents au niveau des collections Amazon DocumentDB 5.0 vous permet de réduire les coûts de stockage et d'E/S en compressant les documents de vos collections. Vous pouvez activer la compression de documents au niveau de la collection et consulter les mesures de compression selon les besoins en mesurant les gains de stockage grâce à des mesures de compression telles que la taille de stockage des documents compressés et l'état de compression. Amazon DocumentDB 5.0 utilise l'algorithme de LZ4 compression pour compresser les documents.

Amazon DocumentDB prend en charge la compression de documents à partir de la version 5.0. Les fonctions de compression de documents au niveau de la collection sont les suivantes :
+ **Comportement par** défaut : le paramètre de compression par défaut pour les nouvelles collections d'un cluster 5.0 est déterminé par le paramètre du cluster`default_collection_compression`. Ce paramètre est défini sur « désactivé » par défaut. 
+ **Compression des collections existantes** : le paramètre de compression des collections existantes peut être modifié à l'aide de la `collMod` commande.
+ **Modification du seuil de compression — Le seuil** de compression par défaut est de 2 Ko. Cette valeur peut être spécifiée pour les nouvelles collections à l'aide de la `createCollection` commande, et modifiée pour les collections existantes à l'aide de `collMod` la commande.

**Note**  
La compression de documents Amazon DocumentDB n'est pas prise en charge sur les versions 3.6 et 4.0 d'Amazon DocumentDB.

**Topics**
+ [Gestion de la compression des documents](#manage-compression)
+ [Surveillance de la compression des documents](#monitoring-compression)

## Gestion de la compression des documents
<a name="manage-compression"></a>

### Activation de la compression de documents dans une collection
<a name="enabling-collection-compression"></a>

Activez la compression de documents lors de la création d'une collection sur Amazon DocumentDB 5.0 en utilisant `db.createCollection()` la méthode suivante :

```
db.createCollection( sample_collection,{
    storageEngine : {
        documentDB: {
            compression:{enable: <true | false>}
        }
    }
})
```

### Activation de la compression de documents dans un cluster
<a name="enabling-cluster-compression"></a>

La compression de documents peut être activée par défaut pour toutes les nouvelles collections au niveau d'un cluster en définissant le paramètre `default_collection_compression` du cluster sur « activé ». Lorsque ce paramètre est défini sur « activé », les collections nouvellement créées sur le cluster auront la compression activée par défaut avec un seuil de compression de 2 Ko.

### Compression des collections existantes
<a name="compress-existing-collections"></a>

Vous pouvez également modifier les paramètres de compression d'une collection existante à l'aide de l'`collMod`opération et en spécifiant la `storageEngine` configuration suivante. Veuillez noter que les modifications apportées à l'aide de cette commande ne s'appliqueront qu'aux nouveaux inserted/updated documents et que la compression des documents précédemment insérés ne changera pas.

```
db.runCommand({ 
    collMod: "orders", 
    storageEngine: { 
        documentDB: {compression: {enable: <true | false>} }
    }
})
```

### Définition des seuils de compression
<a name="set-compression-threshold"></a>

Par défaut, le seuil de compression pour les collections compressées est de 2 032 octets. Cette valeur de seuil peut être définie dans la `createCollection` commande lors de la création d'une nouvelle collection avec la compression activée : 

```
db.createCollection( sample_collection, {
    storageEngine : {
        documentDB: {
            compression: {
                enable: true,
                threshold: <128 - 8000>
            }
        }
    }
})
```

Vous pouvez également modifier le seuil de compression d'une collection compressée existante à l'aide de l'`collMod`opération et en spécifiant la `storageEngine` configuration suivante :

```
db.runCommand({ 
    collMod: "orders", 
    storageEngine: { 
        documentDB: {
            compression: {
                enable: true,
                threshold: <128 - 8000>
            }
        }
    }
})
```

Notez que le seuil de compression ne peut être défini que sur une valeur comprise entre 128 et 8 000 octets. En outre, l'`enable`option doit être définie sur « true » lors de la spécification du seuil de compression.

## Surveillance de la compression des documents
<a name="monitoring-compression"></a>

Vous pouvez vérifier si une collection est compressée et calculer son taux de compression comme suit.

Consultez les statistiques de compression en exécutant la `db.collection.stats()` commande `db.printCollectionStats()` or depuis le shell mongo. La sortie indique la taille d'origine et la taille compressée que vous pouvez comparer pour analyser les gains de stockage liés à la compression de documents. Dans cet exemple, les statistiques d'une collection nommée « sample\$1collection » sont présentées ci-dessous. Un facteur d'échelle de 1024\$11024 est utilisé ci-dessous pour afficher les `storageSize` valeurs `size` et en Mo.

```
db.sample_collection.stats(1024*1024)
```

Voici un exemple du résultat de la commande ci-dessus :

```
{
    "ns" : "test.sample_collection",
    "count" : 1000000,
    "size" : 3906.3,
    "avgObjSize" : 4096,
    "storageSize" : 1953.1, 
    compression:{"enabled" : true,"threshold" : 2032},
    ...
}
```
+ **taille : taille** d'origine de la collection de documents.
+ **avgObjSize**- La taille moyenne du document avant compression est arrondie à la première décimale. L'unité de mesure est l'octet.
+ **StorageSize** : taille de stockage de la collection après compression. L'unité de mesure est l'octet.
+ **activé** - Indique si la compression est activée ou désactivée.

Pour calculer le taux de compression réel, divisez la taille de la collection par la taille du stockage (Size/StorageSize). Dans l'exemple ci-dessus, le calcul est 3906,3/1953,1, ce qui correspond à un taux de compression de 2:1.

# Gestion de la compression basée sur un dictionnaire dans Amazon DocumentDB 8.0
<a name="dict-compression"></a>

Amazon DocumentDB 8.0 introduit un nouvel algorithme de compression de documents, zstd, comme alternative améliorée à. LZ4 Lorsque vous activez la compression de dictionnaire sur une collection Amazon DocumentDB 8.0 en sélectionnant Zstd comme algorithme de compression, les documents de votre collection sont échantillonnés pour créer un dictionnaire de compression personnalisé. Les documents nouveaux et mis à jour sont compressés à l'aide de ce dictionnaire et de l'algorithme zstd. Cette approche permet généralement d'obtenir des taux de compression plus élevés que les méthodes de compression standard, en particulier pour les collections comportant des schémas de documents cohérents ou des noms de champs répétés. 

Lz4 est un algorithme conçu pour une compression et une décompression rapides. Il est connu pour être léger sur le processeur tout en obtenant une compression notable. Zstd est un algorithme à usage général qui, avec les paramètres par défaut, utilise plus de processeur mais atteint de meilleurs taux de compression que lz4. L'utilisation de dictionnaires améliore encore la compression pour la plupart des documents JSON. Certains avantages de l'algorithme Zstd sont les suivants :
+ Coûts de stockage réduits : des taux de compression plus élevés se traduisent par une réduction de l'utilisation du stockage et des coûts.
+ BaisseI/O: Compressed documents require less I/O, amélioration potentielle des performances.
+ Optimisé pour votre collection : le dictionnaire est spécialement conçu pour les modèles de données de votre collection.

**Note**  
La compression basée sur un dictionnaire n'est pas prise en charge sur les versions 3.6, 4.0 et 5.0 d'Amazon DocumentDB.

## Considérations sur les performances
<a name="perf-considerations"></a>

La compression Zstd implique les compromis suivants : 
+ Stockage ou processeur : la compression Zstd permet d'obtenir de meilleurs taux de compression mais peut utiliser un peu plus de ressources du processeur par rapport à la compression. LZ4 
+ Compression initiale : les nouvelles collections peuvent ne pas atteindre une compression optimale tant que suffisamment de documents ne sont pas insérés pour créer un dictionnaire efficace. Actuellement, un dictionnaire est formé si la collection contient au moins 100 documents.
+ Type de charge de travail : les charges de travail intensives en lecture où l'intégralité des données se trouve dans le cache tampon peuvent connaître une augmentation de la latence et de l'utilisation du processeur en raison de la surcharge de décompression.

La compression Zstd est particulièrement efficace pour les collections contenant de petits documents, des tableaux de documents et des noms de champs répétés.

## Activation de la compression basée sur un dictionnaire
<a name="enabling-zstd"></a>

Pour les nouvelles collections, vous pouvez utiliser la commande ci-dessous pour activer la compression Zstd : 

```
db.createCollection("myCollection", 
    { 
        storageEngine: { 
            documentDB: { 
                compression: {
                    enable: true,
                    algorithm: "zstd"
                } 
            }
        }
    }
 )
```

Vous pouvez également activer ou modifier la compression sur une collection existante : 

```
db.runCommand({ 
    collMod: "myCollection", 
    storageEngine: { 
        documentDB: { 
            compression: {
                enable: true,
                algorithm: "zstd"
            } 
        }
    }
 })
```

Pour activer l'algorithme Zstd dans toutes les collections de votre cluster, vous pouvez modifier le groupe de paramètres du cluster pour sélectionner « zstd » comme valeur pour le paramètre « default\$1collection\$1compression ».

## Démarrage
<a name="getting-started"></a>

Amazon DocumentDB 8.0 est livré avec la compression Zstd activée par défaut. Vous pouvez toujours le désactiver en définissant la valeur de 'default\$1compression' sur disabled dans le groupe de paramètres de votre cluster. Il convient de noter qu'à partir d'Amazon DocumentDB 8.0, « activé » n'est plus un choix valide pour default\$1compression, et vous devez sélectionner entre Zstd et. LZ4 

## Contrôle
<a name="monitoring"></a>

Vous pouvez consulter les informations de compression d'une collection à l'aide de l'une des commandes suivantes :
+ DB.RunCommand (\$1collStats : « MyCollection »\$1) OU
+ db.collection.stats ()

Ces commandes renvoient des statistiques clés que vous pouvez utiliser pour calculer le taux de compression :
+ compression.algorithm : L'algorithme utilisé (« lz4 » ou « zstd »)
+ StorageSize : le stockage réel utilisé par la collection, après compression. Notez que ce nombre inclut la fragmentation (c'est-à-dire l'espace inutilisé dans les pages de base de données)
+ avgObjSize: taille logique moyenne des documents de la collection, décompressés. Notez que si votre collection compte plus de 20 000 documents, ce nombre sera une approximation basée sur un échantillon de 20 000 documents.
+ taille : taille logique de la collection sans compression. Ce nombre est obtenu en multipliant avgObjSize par le nombre total de documents de la collection, donc s'il s' avgObjSize agit d'une approximation, ce nombre le sera également.
+ nombre : nombre de documents dans la collection 

Les CloudWatch mesures suivantes peuvent être utiles lors de l'évaluation de la compression basée sur un dictionnaire :
+ CPUUtilization
+ FreeableMemory
+ VolumeBytesUsed
+ VolumeReadIOPs
+ VolumeWriteIOPs

Métriques CollStats :
+ storageSize
+ size

En outre, il peut être utile de suivre les indicateurs spécifiques à votre application, tels que la latence et le débit par type de requête ou API.

# Gestion des événements Amazon DocumentDB
<a name="managing-events"></a>

Amazon DocumentDB (compatible avec MongoDB) conserve un enregistrement des événements liés à vos clusters, instances, instantanés, groupes de sécurité et groupes de paramètres de cluster. Les informations consignées comprennent la date et l'heure de l'événement, le nom et le type de source de l'événement, ainsi qu'un message associé à l'événement.

**Important**  
Pour certaines fonctionnalités de gestion, Amazon DocumentDB utilise une technologie opérationnelle partagée avec Amazon RDS et Amazon Neptune. Les limites régionales, qui sont régies au niveau de la région, sont partagées entre Amazon DocumentDB, Amazon RDS et Amazon Neptune. Pour de plus amples informations, veuillez consulter [Quotas régionaux](limits.md#limits-regional_quotas).

**Topics**
+ [Affichage des catégories d'événements Amazon DocumentDB](#viewing-event-categories)
+ [Affichage des événements Amazon DocumentDB](#viewing-events)

## Affichage des catégories d'événements Amazon DocumentDB
<a name="viewing-event-categories"></a>

Chaque type de ressource Amazon DocumentDB est associé à des types d'événements spécifiques. Vous pouvez utiliser cette AWS CLI `describe-event-categories` opération pour afficher le mappage entre les types d'événements et les types de ressources Amazon DocumentDB.

**Paramètres**
+ **--source-type**—Facultatif. Utilisez le paramètre `--source-type` pour afficher les catégories d’événement d’un type source en particulier. Les valeurs suivantes sont autorisées :
  + `db-cluster`
  + `db-instance`
  + `db-parameter-group`
  + `db-security-group`
  + `db-cluster-snapshot`
+ **--filters**—Facultatif. Pour afficher les catégories d'événements uniquement pour Amazon DocumentDB, utilisez le filtre. `--filter Name=engine,Values=docdb`

**Example**  
Le code suivant répertorie les catégories d'événement associées à des clusters.  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-event-categories \
    --filter Name=engine,Values=docdb \
    --source-type db-cluster
```
Pour Windows :  

```
aws docdb describe-event-categories ^
    --filter Name=engine,Values=docdb ^
    --source-type db-cluster
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
{
    "EventCategoriesMapList": [
        {
            "EventCategories": [
                "notification",
                "failure",
                "maintenance",
                "failover"
            ],
            "SourceType": "db-cluster"
        }
    ]
}
```
Le code suivant répertorie les catégories d'événements associées à chaque type de source Amazon DocumentDB.  

```
aws docdb describe-event-categories
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
{
    "EventCategoriesMapList": [
        {
            "SourceType": "db-instance",
            "EventCategories": [
                "notification",
                "failure",
                "creation",
                "maintenance",
                "deletion",
                "recovery",
                "restoration",
                "configuration change",
                "read replica",
                "backtrack",
                "low storage",
                "backup",
                "availability",
                "failover"
            ]
        },
        {
            "SourceType": "db-security-group",
            "EventCategories": [
                "configuration change",
                "failure"
            ]
        },
        {
            "SourceType": "db-parameter-group",
            "EventCategories": [
                "configuration change"
            ]
        },
        {
            "SourceType": "db-cluster",
            "EventCategories": [
                "notification",
                "failure",
                "maintenance",
                "failover"
            ]
        },
        {
            "SourceType": "db-cluster-snapshot",
            "EventCategories": [
                "backup"
            ]
        }
    ]
}
```

## Affichage des événements Amazon DocumentDB
<a name="viewing-events"></a>

Vous pouvez récupérer les événements relatifs à vos ressources Amazon DocumentDB via la console Amazon DocumentDB, qui affiche les événements des dernières 24 heures. Vous pouvez également récupérer des événements pour vos ressources Amazon DocumentDB à l'aide de la AWS CLI commande [describe-events](https://docs.aws.amazon.com/cli/latest/reference/docdb/describe-events.html) ou de l'opération d'API Amazon DocumentDB [DescribeEvents](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeEvents.html). Si vous utilisez l'API Amazon DocumentDB AWS CLI ou l'API Amazon DocumentDB pour consulter les événements, vous pouvez récupérer les événements des 14 derniers jours.

------
#### [ Using the AWS Management Console ]

**Pour afficher tous les événements des instances Amazon DocumentDB des dernières 24 heures**

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

1. Dans le volet de navigation, sélectionnez **Events**. Les évènements disponibles s'affichent sous forme de liste.

1. Utilisez la liste **Filtre** pour filtrer les événements par type. Saisissez un terme dans la zone de texte pour affiner vos résultats. Par exemple, la capture d'écran suivante montre le filtrage de tous les événements Amazon DocumentDB pour les événements *instantanés*.  
![\[Capture d'écran de la rubrique affichant les événements de filtrage pour les instantanés.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/events-filtering.png)

------
#### [ Using the AWS CLI ]

**Pour consulter tous les événements des instances Amazon DocumentDB des 7 derniers jours**  
Vous pouvez consulter tous les événements d'instance Amazon DocumentDB des 7 derniers jours en exécutant l' AWS CLI opération [describe-events](https://docs.aws.amazon.com/cli/latest/reference/docdb/describe-events.html) avec le `--duration` paramètre défini sur `10080` (10 080 minutes).

```
aws docdb describe-events --duration 10080
```

**Filtrage des événements Amazon DocumentDB**

Pour voir des événements Amazon DocumentDB spécifiques, utilisez l'`describe-events`opération avec les paramètres suivants.

**Paramètres**
+ **--filter**—Obligatoire pour limiter les valeurs renvoyées aux événements Amazon DocumentDB. **Name=engine,Values=docdb**À utiliser pour filtrer tous les événements pour Amazon DocumentDB uniquement.
+ **--source-identifier**—Facultatif. Identifiant de la source de l'événement pour laquelle les événements sont renvoyés. Si cet argument n'est pas spécifié, les événements de toutes les sources sont inclus dans les résultats.
+ **--source-type**—Facultatif, à moins que `--source-identifier` cela ne soit fourni, puis obligatoire. Si le `--source-identifier` est fourni, le `--source-type` doit approuver le type du `--source-identifier`. Les valeurs suivantes sont autorisées :
  + `db-cluster`
  + `db-instance`
  + `db-parameter-group`
  + `db-security-group`
  + `db-cluster-snapshot`

L'exemple suivant répertorie tous vos événements Amazon DocumentDB.

```
aws docdb describe-events --filters Name=engine,Values=docdb
```

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

```
{
    "Events": [
        {
            "SourceArn": "arn:aws:rds:us-east-1:123SAMPLE012:db:sample-cluster-instance3",
            "Message": "instance created",
            "SourceType": "db-instance",
            "Date": "2018-12-11T21:17:40.023Z",
            "SourceIdentifier": "sample-cluster-instance3",
            "EventCategories": [
                "creation"
            ]
        },
        {
            "SourceArn": "arn:aws:rds:us-east-1:123SAMPLE012:db:docdb-2018-12-11-21-08-23",
            "Message": "instance shutdown",
            "SourceType": "db-instance",
            "Date": "2018-12-11T21:25:01.245Z",
            "SourceIdentifier": "docdb-2018-12-11-21-08-23",
            "EventCategories": [
                "availability"
            ]
        },
        {
            "SourceArn": "arn:aws:rds:us-east-1:123SAMPLE012:db:docdb-2018-12-11-21-08-23",
            "Message": "instance restarted",
            "SourceType": "db-instance",
            "Date": "2018-12-11T21:25:11.441Z",
            "SourceIdentifier": "docdb-2018-12-11-21-08-23",
            "EventCategories": [
                "availability"
            ]
        }
    ]
}
```

------

Pour de plus amples informations, veuillez consulter [Audit des événements Amazon DocumentDB](event-auditing.md).

# Choix des régions et des zones de disponibilité
<a name="regions-and-azs"></a>

Les ressources de cloud computing Amazon sont hébergées dans plusieurs emplacements à travers le monde. Ces emplacements se composent Régions AWS de zones de disponibilité. Chacune *Région AWS*constitue une zone géographique distincte. Chaque région se compose de plusieurs emplacements isolés appelés *zones de disponibilité*. Amazon DocumentDB vous permet de placer des ressources, telles que des instances, et des données dans plusieurs emplacements. Les ressources ne sont pas répliquées à Régions AWS moins que vous ne le fassiez spécifiquement.

Amazon gère des centres de données à la pointe de la technologie et hautement disponibles. Bien qu’elles soient rares, des pannes touchant la disponibilité des instances se trouvant au même emplacement peuvent se produire. Si vous hébergez toutes vos instances dans un seul emplacement touché par une panne de ce type, aucune de vos instances ne sera disponible. Le schéma suivant montre une zone Région AWS comportant trois zones de disponibilité.

![\[Un diagramme d'une région comportant trois zones de disponibilité a, b et c.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/RegionsAndAZs.png)


Il importe de se souvenir que chaque région est totalement indépendante. Toute activité Amazon DocumentDB que vous lancez (par exemple, la création d'instances ou la liste des instances disponibles) s'exécute uniquement dans votre configuration par défaut actuelle. Région AWS Vous pouvez également modifier la région par défaut dans la console, en définissant la variable d'environnement `EC2_REGION`. Ou vous pouvez la remplacer en utilisant le paramètre `--region` dans la AWS CLI. Pour plus d'informations, voir [Configuration des AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) sections spécifiques sur les variables d'environnement et les options de ligne de commande. 

Lorsque vous créez un cluster à l'aide de la console Amazon DocumentDB et que vous choisissez de créer une réplique dans une autre zone de disponibilité, Amazon DocumentDB crée deux instances. Il crée l'instance principale dans une zone de disponibilité et l'instance de réplica dans une autre zone de disponibilité. Le volume de cluster est toujours répliqué sur trois zones de disponibilité.

Pour créer ou utiliser une instance Amazon DocumentDB dans une instance spécifique Région AWS, utilisez le point de terminaison de service régional correspondant. 

## Disponibilité dans les Régions
<a name="regions-and-azs-availability"></a>

Amazon DocumentDB est disponible dans les régions suivantes AWS . 

**Régions prises en charge par Amazon DocumentDB**


| Nom de la région | Région | Zones de disponibilité (calcul) | 
| --- | --- | --- | 
| USA Est (Ohio) | `us-east-2` | 3 | 
| USA Est (Virginie du Nord) | `us-east-1` | 6 | 
| USA Ouest (Oregon) | `us-west-2` | 4 | 
| Afrique (Le Cap) | `af-south-1` | 3 | 
| Amérique du Sud (São Paulo) | `sa-east-1` | 3 | 
| Asie-Pacifique (Hong Kong) | `ap-east-1` | 3 | 
| Asie-Pacifique (Hyderabad) | `ap-south-2` | 3 | 
| Asie-Pacifique (Malaisie) | `ap-southeast-5` | 3 | 
| Asie-Pacifique (Mumbai) | `ap-south-1` | 3 | 
| Asie-Pacifique (Osaka) | `ap-northeast-3` | 3 | 
| Asie-Pacifique (Séoul) | `ap-northeast-2` | 4 | 
| Asie-Pacifique (Singapour) | `ap-southeast-1` | 3 | 
| Asie-Pacifique (Sydney) | `ap-southeast-2` | 3 | 
| Asie-Pacifique (Jakarta) | `ap-southeast-3` | 3 | 
| Asie-Pacifique (Melbourne) | `ap-southeast-4` | 3 | 
| Asie-Pacifique (Thaïlande) | `ap-southeast-7` | 3 | 
| Asie-Pacifique (Tokyo) | `ap-northeast-1` | 3 | 
| Canada (Centre) | `ca-central-1` | 3 | 
| Région Chine (Beijing) | `cn-north-1` | 3 | 
| Chine (Ningxia) | `cn-northwest-1` | 3 | 
| Europe (Francfort) | `eu-central-1` | 3 | 
| Europe (Zurich) | `eu-central-2` | 3 | 
| Europe (Irlande) | `eu-west-1` | 3 | 
| Europe (Londres) | `eu-west-2` | 3 | 
| Europe (Milan) | `eu-south-1` | 3 | 
| Europe (Paris) | `eu-west-3` | 3 | 
| Europe (Espagne) | `eu-south-2` | 3 | 
| Europe (Stockholm) | `eu-north-1` | 3 | 
| Mexique (Centre) | `mx-central-1` | 3 | 
| Moyen-Orient (EAU) | `me-central-1` | 3 | 
| Israël (Tel Aviv) | `il-central-1` | 3 | 
| AWS GovCloud (US-Ouest) | `us-gov-west-1` | 3 | 
| AWS GovCloud (USA Est) | `us-gov-east-1` | 3 | 

Par défaut, le fuseau horaire d'un cluster Amazon DocumentDB est Universal Time Coordinated (UTC).

Pour plus d'informations sur la recherche des points de terminaison de connexion pour les instances et les clusters dans une région donnée, consultez [Comprendre les points de terminaison Amazon DocumentDB](endpoints.md).

# Gestion des groupes de paramètres du cluster Amazon DocumentDB
<a name="cluster_parameter_groups"></a>

Vous pouvez gérer la configuration du moteur Amazon DocumentDB en utilisant les paramètres d'un groupe de paramètres de cluster. Un *groupe de paramètres de cluster* est un ensemble de valeurs de configuration Amazon DocumentDB qui facilitent la gestion des paramètres de vos clusters Amazon DocumentDB. Les groupes de paramètres de cluster servent de conteneurs pour les valeurs de configuration de moteur qui sont appliquées à toutes les instances du cluster. 

Cette section décrit comment créer, afficher et modifier des groupes de paramètres de cluster. Elle explique également comment déterminer quel groupe de paramètres de cluster est associé à un cluster donné.

**Topics**
+ [Décrire les groupes de paramètres de cluster](cluster_parameter_groups-describe.md)
+ [Création de groupes de paramètres de cluster](cluster_parameter_groups-create.md)
+ [Modification des groupes de paramètres du cluster](cluster_parameter_groups-modify.md)
+ [Modification de clusters pour utiliser des groupes de paramètres de cluster personnalisés](cluster_parameter_groups-modify_clusters.md)
+ [Copie de groupes de paramètres de cluster](cluster_parameter_groups-copy.md)
+ [Réinitialisation des groupes de paramètres du cluster](cluster_parameter_groups-reset.md)
+ [Suppression de groupes de paramètres de cluster](cluster_parameter_groups-delete.md)
+ [Référence des paramètres du cluster](cluster_parameter_groups-list_of_parameters.md)

# Décrire les groupes de paramètres du cluster Amazon DocumentDB
<a name="cluster_parameter_groups-describe"></a>

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.

**Topics**
+ [Décrire les détails d'un groupe de paramètres de cluster](#cluster_parameter_groups-describe_details)
+ [Déterminer le groupe de paramètres d'un cluster](#cluster_parameter_groups-determine)
+ [Détermination des clusters et des instances associés à un groupe de paramètres de cluster](#cluster_parameter_groups-count)

## Décrire les détails d'un groupe de paramètres de cluster Amazon DocumentDB
<a name="cluster_parameter_groups-describe_details"></a>

Pour décrire les détails d'un groupe de paramètres de cluster donné, effectuez les étapes suivantes à l'aide du AWS Management Console ou du AWS Command Line Interface (AWS CLI).

------
#### [ Using the AWS Management Console ]

****

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

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

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

1. 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 de plus amples informations, veuillez consulter [Modification des paramètres du cluster Amazon DocumentDB](cluster_parameter_groups-parameters.md).
   + 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 de plus amples informations, veuillez consulter [Gestion des événements Amazon DocumentDB](managing-events.md).
   + 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 de plus amples informations, veuillez consulter [Balisage des ressources Amazon DocumentDB](tagging.md).

------
#### [ 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 `describe-db-cluster-parameters` AWS CLI commande pour afficher les paramètres et leurs détails au sein d'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.

**Example**  
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"
              }
          ]
}
```

**Example**  
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"
              }
          ]
}
```

**Example**  
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
<a name="cluster_parameter_groups-determine"></a>

Pour déterminer quel groupe de paramètres est associé à un cluster particulier, effectuez les étapes suivantes à l'aide du AWS Management Console ou du AWS CLI. 

------
#### [ Using the AWS Management Console ]

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

1. Dans le volet de navigation de gauche, choisissez **Clusters**.

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

1. 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)**.  
![\[Capture d'écran : Affichage du groupe de paramètres d'un cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-determine-parameter-group.png)

------
#### [ Using the AWS CLI ]

Le AWS CLI code suivant détermine le groupe de paramètres qui régit le cluster`sample-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"
       ]
]
```

------

## Détermination des clusters et des instances associés à un groupe de paramètres de cluster Amazon DocumentDB
<a name="cluster_parameter_groups-count"></a>

Pour déterminer le nombre de clusters et d'instances associés à chaque groupe de paramètres, effectuez les étapes suivantes à l'aide du AWS CLI.

------
#### [ Using the AWS CLI ]

Le AWS CLI code suivant détermine le nombre de clusters et d'instances associés`sample-parameter-group`.

Pour Linux, macOS ou Unix :

```
aws docdb describe-db-clusters \
      --query 'DBClusters[*].[DBClusterParameterGroup,DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]' \
      --output json | \
      jq -r 'group_by(.[0]) | map({
         parameter_group_name: .[0][0],
         total_clusters: length,
         total_instances: map(.[2] | length) | add // 0
      }) | .[]'
```

Pour Windows :

```
aws docdb describe-db-clusters ^
      --query 'DBClusters[*].[DBClusterParameterGroup,DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]' ^
      --output json | ^
      jq -r 'group_by(.[0]) | map({
         parameter_group_name: .[0][0],
         total_clusters: length,
         total_instances: map(.[2] | length) | add // 0
      }) | .[]'
```

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

```
{
   "parameter_group_name": "sample-parameter-group",
   "total_clusters": 50,
   "total_instances": 150
}
```

------

# Création de groupes de paramètres de cluster Amazon DocumentDB
<a name="cluster_parameter_groups-create"></a>

Les groupes de paramètres de cluster par défaut tels que `default.docdb5.0` `default.docdb4.0``default.docdb3.6`, ou sont créés lorsque vous créez un cluster avec une nouvelle version du moteur et dans une nouvelle région. Les clusters suivants créés dans cette région et dotés de la même version de moteur héritent du groupe de paramètres de `default` cluster. Une fois créés, les groupes de `default` paramètres ne peuvent pas être supprimés ou renommés. Vous pouvez modifier le comportement du moteur des instances de cluster en créant un groupe de paramètres personnalisé avec des valeurs de paramètres préférées et en l'attachant à votre cluster Amazon DocumentDB. 

La procédure suivante vous guide tout au long de la création d'un groupe de paramètres de cluster personnalisé. Vous pouvez ensuite [modifier les paramètres de ce groupe de paramètres](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-modify.html).

**Note**  
Après la création d'un groupe de paramètres de cluster, patientez au moins 5 minutes avant d'utiliser ce groupe de paramètres de cluster. Cela permet à Amazon DocumentDB de terminer complètement l'`create`action avant que le groupe de paramètres du cluster ne soit utilisé pour un nouveau cluster. Vous pouvez utiliser l'`describe-db-cluster-parameter-groups` AWS CLI opération AWS Management Console ou pour vérifier que votre groupe de paramètres de cluster a été créé. Pour de plus amples informations, veuillez consulter [Décrire les groupes de paramètres du cluster Amazon DocumentDB](cluster_parameter_groups-describe.md).

------
#### [ Using the AWS Management Console ]

**Créer un groupe de paramètres de cluster**

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

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans le panneau **Groupes de paramètres de cluster**, choisissez **Créer**.

1. Dans le panneau **Create cluster parameter group (Créer un groupe de paramètres de cluster)** entrez les éléments suivants :

   1. **Nom du nouveau groupe de paramètres de cluster** : entrez un nom pour le groupe de paramètres de cluster. Par exemple, `sample-parameter-group`. Les groupes de paramètres de cluster sont soumis aux contraintes de dénomination suivantes :
      + Entre 1 et 255 caractères alphanumériques.
      + Le premier caractère doit être une lettre.
      + Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.

   1. **Famille** — Choisissez la version de DocumentDB que vous souhaitez utiliser pour votre cluster.

   1. **Description** — Fournissez une description de ce groupe de paramètres de cluster.

1. Choisissez **Créer** pour créer le groupe de paramètres de cluster. Pour annuler l'opération, choisissez **Annuler**.

1. Une fois que vous avez sélectionné **Créer**, le texte suivant s'affiche en haut de la page pour confirmer que votre groupe de paramètres de cluster a été créé avec succès :

   ```
   Successfully created cluster parameter group 'sample-parameter-group'.
   ```

------
#### [ Using the AWS CLI ]

Pour créer un nouveau groupe de paramètres de cluster pour les clusters Amazon DocumentDB 4.0, utilisez l' AWS CLI `create-db-cluster-parameter-group`opération avec les paramètres suivants :
+ **--db-cluster-parameter-group-name**— Nom du groupe de paramètres de cluster personnalisé. Par exemple, `sample-parameter-group`.
+ **--db-cluster-parameter-group-family**— La famille de groupes de paramètres de cluster utilisée comme modèle pour le groupe de paramètres de cluster personnalisé.
+ **--description**— Description fournie par l'utilisateur pour ce groupe de paramètres de cluster. L'exemple suivant utilise `Custom docdb4.0 parameter group`.

Pour Linux, macOS ou Unix :

**Example**  

```
aws docdb create-db-cluster-parameter-group \
 --db-cluster-parameter-group-name sample-parameter-group \
 --db-parameter-group-family docdb5.0 \
 --description "Custom docdb5.0 parameter group"
```
Pour Windows :  

```
aws docdb create-db-cluster-parameter-group ^
 --db-cluster-parameter-group-name sample-parameter-group ^
 --db-parameter-group-family docdb5.0 ^
 --description "Custom docdb5.0 parameter group"
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupName": "sample-parameter-group",
        "DBParameterGroupFamily": "docdb5.0",
        "Description": "Custom docdb4.0 parameter group",
        "DBClusterParameterGroupArn": "sample-parameter-group-arn"
    }
}
```

------

# Modification des groupes de paramètres du cluster Amazon DocumentDB
<a name="cluster_parameter_groups-modify"></a>

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](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-create.html) ou [copier un groupe de paramètres existant](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-copy.html), 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 CLI `describe-db-cluster-parameters`opération AWS Management Console ou pour vérifier que votre groupe de paramètres de cluster a été modifié. Pour de plus amples informations, veuillez consulter [Décrire les groupes de paramètres de cluster](cluster_parameter_groups-describe.md).

------
#### [ 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](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-copy.html), 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](db-cluster-modify.md).

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

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

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. 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** .

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

   1. 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](cluster_parameter_groups-list_of_parameters.md) 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`.

**Example - 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"
              }
          ]
   }
   ```

1. 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"
      }
   ```

1. Patientez au moins 5 minutes.

1. 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"
              }
          ]
   }
   ```

------

# Modification de clusters Amazon DocumentDB pour utiliser des groupes de paramètres de cluster personnalisés
<a name="cluster_parameter_groups-modify_clusters"></a>

Lorsque vous créez un cluster Amazon DocumentDB, un groupe de `default.docdb4.0` paramètres est automatiquement créé pour ce cluster. Vous ne pouvez pas modifier le groupe de paramètres de cluster `default`. Au lieu de cela, vous pouvez modifier votre cluster Amazon DocumentDB pour y associer un nouveau groupe de paramètres personnalisés. 

Cette section explique comment modifier un cluster Amazon DocumentDB existant pour utiliser un groupe de paramètres de cluster personnalisé à l'aide du AWS Management Console et AWS Command Line Interface ()AWS CLI. 

------
#### [ Using the AWS Management Console ]

**Pour modifier un cluster Amazon DocumentDB afin d'utiliser un nouveau groupe de paramètres de cluster autre que celui par défaut**

1. Avant de commencer, assurez-vous d'avoir créé un cluster Amazon DocumentDB et un groupe de paramètres de cluster. Pour consulter des instructions supplémentaires, veuillez consulter [Création d'un cluster Amazon DocumentDB](db-cluster-create.md) et [Création de groupes de paramètres de cluster Amazon DocumentDB](cluster_parameter_groups-create.md).

1. Après avoir créé votre groupe de paramètres de cluster, ouvrez la console Amazon DocumentDB à l'adresse. [https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) Dans le panneau de navigation, choisissez **Clusters** pour ajouter votre nouveau groupe de paramètres à un cluster.

1. Choisissez le cluster auquel vous souhaitez associer votre groupe de paramètres. Choisissez **Actions**, puis **Modifier** pour modifier votre cluster.

1. Sous **Cluster options (Options de cluster)**, choisissez le nouveau groupe de paramètres auquel vous souhaitez associer votre cluster.

1. Sélectionnez **Continuer** pour afficher un résumé de vos modifications.

1. Après vérification de vos modifications, vous pouvez les appliquer immédiatement ou au cours de la fenêtre de maintenance suivante sous **Scheduling of modifications (Planification des modifications)**.

1. Choisissez **Modify cluster (Modifier le cluster)** pour mettre à jour votre cluster avec votre nouveau groupe de paramètres.

------
#### [ Using the AWS CLI ]

Avant de commencer, assurez-vous d'avoir créé un cluster Amazon DocumentDB et un groupe de paramètres de cluster. Vous pouvez [créer un cluster Amazon DocumentDB](https://docs.aws.amazon.com//documentdb/latest/developerguide/db-cluster-create.html) à l'aide de cette opération. AWS CLI `create-db-cluster` Vous pouvez [créer un groupe de paramètres de cluster](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-create.html) à l'aide de AWS CLI `create-db-cluster-parameter-group` cette opération.

Pour ajouter votre nouveau groupe de paramètres de cluster à votre cluster, utilisez l' AWS CLI `modify-db-cluster`opération avec les paramètres suivants.
+ **-- db-cluster-identifier** — Le nom de votre cluster (par exemple,`sample-cluster`).
+ **-- db-cluster-parameter-group -name** — Le nom du groupe de paramètres auquel vous souhaitez associer votre cluster (par exemple,`sample-parameter-group`).

**Example**  

```
aws docdb modify-db-cluster \
    --db-cluster-identifier sample-cluster \
    --db-cluster-parameter-group-name sample-parameter-group
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
"DBCluster": {
    "AvailabilityZones": [
            "us-west-2c",
            "us-west-2b",
            "us-west-2a"
    ],
    "BackupRetentionPeriod": 1,
    "DBClusterIdentifier": "sample-cluster",
    "DBClusterParameterGroup": "sample-parameter-group",
    "DBSubnetGroup": "default",
   ...
}
```

------

# Copie des groupes de paramètres du cluster Amazon DocumentDB
<a name="cluster_parameter_groups-copy"></a>

Vous pouvez créer une copie d'un groupe de paramètres de cluster dans Amazon DocumentDB à l'aide du AWS Management Console ou du AWS Command Line Interface ()AWS CLI.

------
#### [ Using the AWS Management Console ]

La procédure suivante vous guide tout au long de la création d'un nouveau groupe de paramètres de cluster en effectuant une copie d'un groupe de paramètres de cluster existant.

**Pour copier un groupe de paramètres de cluster**

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

1. Dans le panneau de navigation, choisissez **Groupes de paramètres**.

1. Dans le panneau **Groupes de paramètres de cluster**, sélectionnez le nom du groupe de paramètres de cluster que vous souhaitez copier.

1. Choisissez **Actions**, puis **Copy (Copier)** pour copier ce groupe de paramètres.

1. Sous **Copy options (Options de copie)**, entrez le nom et une description du nouveau groupe de paramètres de cluster. Choisissez ensuite **Copy (Copier)** pour enregistrer vos modifications.

------
#### [ Using the AWS CLI ]

Pour réaliser une copie d'un groupe de paramètres de cluster, utilisez l'opération `copy-db-cluster-parameter-group` avec les paramètres suivants.
+ **--source-db-cluster-parameter-group-identifier** — Obligatoire. Nom ou Amazon Resource Name (ARN) du groupe de paramètres de cluster dont vous voulez réaliser une copie.

  Si les groupes de paramètres du cluster source et cible se trouvent dans le même groupe Région AWS, l'identifiant peut être un nom ou un ARN.

  Si les groupes de paramètres du cluster source et cible sont différents Régions AWS, l'identifiant doit être un ARN.
+ **--target-db-cluster-parameter-group-identifier** — Obligatoire. Le nom ou l'ARN de la copie du groupe de paramètres du cluster.

  Contraintes:
  + Ne peut pas être null ou vide.
  + Doit contenir de 1 à 255 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.
+ **--target-db-cluster-parameter-group-description** — Obligatoire. Un utilisateur a fourni une description pour la copie du groupe de paramètres de cluster.

**Example**  
Le code suivant effectue une copie de `sample-parameter-group`, en appelant la copie `sample-parameter-group-copy`.  
Pour Linux, macOS ou Unix :  

```
aws docdb copy-db-cluster-parameter-group \
    --source-db-cluster-parameter-group-identifier sample-parameter-group \
    --target-db-cluster-parameter-group-identifier sample-parameter-group-copy \
    --target-db-cluster-parameter-group-description "Copy of sample-parameter-group"
```
Pour Windows :  

```
aws docdb copy-db-cluster-parameter-group ^
    --source-db-cluster-parameter-group-identifier sample-parameter-group ^
    --target-db-cluster-parameter-group-identifier sample-parameter-group-copy ^
    --target-db-cluster-parameter-group-description "Copy of sample-parameter-group"
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-parameter-group-copy",
        "DBClusterParameterGroupName": "sample-parameter-group-copy",
        "DBParameterGroupFamily": "docdb4.0",
        "Description": "Copy of sample-parameter-group"
    }
}
```

------

# Réinitialisation des groupes de paramètres du cluster Amazon DocumentDB
<a name="cluster_parameter_groups-reset"></a>

Vous pouvez rétablir certaines ou toutes les valeurs des paramètres d'un groupe de paramètres de cluster Amazon DocumentDB à leurs valeurs par défaut en utilisant le AWS Management Console ou le AWS Command Line Interface (AWS CLI) pour réinitialiser le groupe de paramètres de cluster.

------
#### [ Using the AWS Management Console ]

Procédez comme suit pour réinitialiser certaines ou toutes les valeurs de paramètres d'un groupe de paramètres de cluster à leurs valeurs par défaut.

**Pour réinitialiser les valeurs de paramètres d'un groupe de paramètres de cluster**

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

1. Dans le panneau de navigation sur le côté gauche de la console, choisissez **Groupes de paramètres**.

1. Dans le panneau **Groupes de paramètres de cluster**, choisissez le nom du groupe de paramètres de cluster que vous souhaitez réinitialiser.

1. Choisissez **Actions**, puis **Réinitialiser** pour réinitialiser ce groupe de paramètres.

1. Sur la page **Cluster parameter group reset confirmation (Confirmation de réinitialisation du groupe de paramètres de cluster)** qui s'affiche, confirmez que vous souhaitez réinitialiser tous les paramètres de cluster de ce groupe de paramètres à leurs valeurs par défaut. Choisissez ensuite **Réinitialiser** pour réinitialiser votre groupe de paramètres. Vous pouvez également choisir **Annuler** pour annuler vos modifications.

------
#### [ Using the AWS CLI ]

Pour réinitialiser certaines ou toutes les valeurs des paramètres d'un groupe de paramètres de cluster aux valeurs par défaut, utilisez l'opération `reset-db-cluster-parameter-group` avec les paramètres suivants.
+ **--db-cluster-parameter-group-name** — Obligatoire. Le nom du groupe de paramètres du cluster à réinitialiser.
+ **--parameters**— Facultatif Une liste des `ParameterName` et de la `ApplyMethod` dans le groupe de paramètres de cluster à réinitialiser à leurs valeurs par défaut. Les paramètres statiques doit être définie sur `pending-reboot` pour entrer en vigueur lors du prochain redémarrage de l'instance ou de la demande `reboot-db-instance`. Vous devez appeler `reboot-db-instance` pour chaque instance de votre cluster à laquelle vous souhaitez que la mise à jour des paramètres statiques soit appliquée.

  Ce paramètre et `--reset-all-parameters` s'excluent mutuellement : vous pouvez utiliser l'un ou l'autre, mais pas les deux.
+ **--reset-all-parameters**ou **--no-reset-all-parameters** — Facultatif. Spécifie s'il faut réinitialiser tous les paramètres (`--reset-all-parameters`) ou uniquement certains des paramètres (`--no-reset-all-parameters`) à leurs valeurs par défaut. Le paramètre `--reset-all-parameters` et `--parameters` s'excluent mutuellement : vous pouvez utiliser l'un ou l'autre, mais pas les deux.

  Lorsque vous réinitialisez l'ensemble du groupe, les paramètres dynamiques sont mis à jour immédiatement. Les paramètres statiques doivent être définis sur `pending-reboot` pour entrer en vigueur lors du redémarrage suivant de l'instance ou de la demande `reboot-db-instance`. Vous devez appeler `reboot-db-instance` pour chaque instance de votre cluster à laquelle vous souhaitez que la mise à jour des paramètres statiques soit appliquée.

**Example**  
**Exemple 1 : Réinitialisation de tous les paramètres à leurs valeurs par défaut**  
Le code suivant réinitialise tous les paramètres dans le groupe de paramètres de cluster `sample-parameter-group` à leurs valeurs par défaut.
Pour Linux, macOS ou Unix :  

```
aws docdb reset-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group \
       --reset-all-parameters
```
Pour Windows :  

```
aws docdb reset-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group ^
       --reset-all-parameters
```
**Exemple 2 : Réinitialisation de paramètres spécifiés à leurs valeurs par défaut**  
Le code suivant réinitialise le paramètre `tls` dans le groupe de paramètres de cluster `sample-parameter-group` à sa valeur par défaut.
Pour Linux, macOS ou Unix :  

```
aws docdb reset-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group \
       --no-reset-all-parameters \
       --parameters ParameterName=tls,ApplyMethod=pending-reboot
```
Pour Windows :  

```
aws docdb reset-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group ^
       --no-reset-all-parameters ^
       --parameters ParameterName=tls,ApplyMethod=pending-reboot
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
{
       "DBClusterParameterGroupName": "sample-parameter-group"
   }
```
**Redémarrage d'une instance de cluster**  
Avant qu'une valeur de paramètre statique soit modifiée, l'instance du cluster doit être redémarrée. Redémarrez chaque instance de votre cluster à laquelle vous souhaitez que la mise à jour du paramètre statique soit appliquée.
Pour Linux, macOS ou Unix :  

```
aws docdb reboot-db-instance \
       --db-instance-identifier sample-cluster-instance
```
Pour Windows :  

```
aws docdb reboot-db-instance ^
       --db-instance-identifier sample-cluster-instance
```

------

# Suppression de groupes de paramètres de cluster Amazon DocumentDB
<a name="cluster_parameter_groups-delete"></a>

Vous pouvez supprimer un groupe de paramètres de cluster Amazon DocumentDB personnalisé à l'aide du AWS Management Console ou du AWS Command Line Interface ()AWS CLI. Vous ne pouvez pas supprimer le groupe de paramètres de cluster `default.docdb4.0`.

------
#### [ Using the AWS Management Console ]

**Supprimer un groupe de paramètres de cluster**

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

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans le volet **Groupes de paramètres**, sélectionnez la case d'option à gauche du groupe de paramètres de cluster que vous voulez supprimer.

1. Choisissez **Actions**, puis **Supprimer**.

1. Dans le volet de confirmation **Supprimer** choisissez **Supprimer** pour supprimer le groupe de paramètres de cluster. Pour conserver le groupe de paramètres de cluster, choisissez **Annuler**.

------
#### [ Using the AWS CLI ]

Pour supprimer un groupe de paramètres de cluster, utilisez l'opération `delete-db-cluster-parameter-group` avec le paramètre suivant.
+ **--db-cluster-parameter-group-name** — Obligatoire. Le nom du groupe de paramètres du cluster à supprimer. Il doit s'agir d'un groupe de paramètres de cluster existant. *Vous ne pouvez pas supprimer le groupe de paramètres de cluster `default.docdb4.0`. *

**Example - Suppression d'un groupe de paramètres de cluster**  
Suivez les trois étapes de l'exemple suivant pour la suppression d'un groupe de paramètres de cluster :  

1. Trouver le nom du groupe de paramètres de cluster que vous voulez supprimer.

1. Suppression du groupe de paramètres de cluster spécifié.

1. Vérification de la suppression du groupe de paramètres de cluster.
**1. Trouvez le nom du groupe de paramètres de cluster que vous voulez supprimer.**  
Le code suivant répertorie les noms de tous les groupes de paramètres de cluster.
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-cluster-parameter-groups \
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
Pour Windows :  

```
aws docdb describe-db-cluster-parameter-groups ^
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
Le résultat de l'opération précédente est une liste des noms des groupes de paramètres de cluster similaire à celle ci-après (au format JSON).  

```
[
       [
           "default.docdb4.0"
       ],
       [
           "sample-parameter-group"
       ],
       [
           "sample-parameter-group-copy"
       ]
   ]
```
**2. Supprimer un groupe de paramètres de cluster spécifique.**  
Le code suivant supprime le groupe de paramètres de cluster `sample-parameter-group-copy`.
Pour Linux, macOS ou Unix :  

```
aws docdb delete-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group-copy
```
Pour Windows :  

```
aws docdb delete-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group-copy
```
Il n'existe aucun résultat pour cette opération.  
**3. Vérifiez que le groupe de paramètres de cluster a été supprimé.**  
Le code suivant répertorie les noms de tous les groupes de paramètres de cluster restants.
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-cluster-parameter-groups \
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
Pour Windows :  

```
aws docdb describe-db-cluster-parameter-groups ^
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
Le résultat de l'opération précédente est une liste des groupes de paramètres de cluster similaire à celle ci-après (au format JSON). Le groupe de paramètres de cluster que vous venez de supprimer ne doit pas figurer dans la liste.  
La sortie de cette opération ressemble à ceci (format JSON).  

```
[
       [
           "default.docdb4.0"
       ],
       [
           "sample-parameter-group"
       ]
   ]
```

------

# Référence des paramètres du cluster Amazon DocumentDB
<a name="cluster_parameter_groups-list_of_parameters"></a>

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 (Appliquer immédiatement)*. 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. Vous pouvez redémarrer une instance à l'aide de la console Amazon DocumentDB ou en appelant explicitement. `reboot-db-instance`

Le tableau suivant indique les paramètres qui s'appliquent à toutes les instances d'un cluster Amazon DocumentDB. 


**Paramètres au niveau du cluster Amazon DocumentDB**  

| Paramètre | Valeur par défaut | Valeurs valides | Adaptabilité | Type d’application | Type de données | Description | 
| --- | --- | --- | --- | --- | --- | --- | 
| audit\$1logs | désactivées | activé, désactivé, ddl, dml\$1read, dml\$1write, tout, aucun | Oui | Répartition dynamique | String | Définit si les journaux CloudWatch d'audit Amazon sont activés. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| change\$1stream\$1log\$1retention\$1duration | 10800 | 3600-604800 | Oui | Répartition dynamique | Entier | Définit la durée (en secondes) pendant laquelle le journal du flux de modifications est conservé et peut être consommé.  | 
| default\$1collection\$1compression | désactivées | activé, désactivé (Amazon DocumentDB 5.0)/zstd, lz4, aucun (Amazon Document 5.0) DB8 | Oui | Répartition dynamique | String | Définit le paramètre de compression par défaut pour les nouvelles collections d'un cluster [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| profiler | désactivées | activé, désactivé | Oui | Répartition dynamique | String | Active le profilage pour les opérations lentes. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| profiler\$1sampling\$1rate | 1.0 | 0.0-1.0 | Oui | Répartition dynamique | Float | Définit la fréquence d'échantillonnage pour les opérations consignées. | 
| profiler\$1threshold\$1ms | 100 | 50-2147483646 | Oui | Répartition dynamique | Entier | Définit le seuil pour profiler. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| planner\$1version | 3.0 | 1,0, 2,0, 3,0 | Oui | Répartition dynamique | Float | Définit la version du planificateur de requêtes à utiliser pour les requêtes.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| tls | activé | activé, désactivé, fips-140-3, tls1.2\$1, tls1.3\$1 | Oui | Statique | String | Définit si des connexions utilisant le protocole TLS sont requises. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| ttl\$1monitor | activé | activé, désactivé | Oui | Répartition dynamique | String | Définit si la surveillance de durée de vie (TTL) est activée pour le cluster. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 

# Modification des paramètres du cluster Amazon DocumentDB
<a name="cluster_parameter_groups-parameters"></a>

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
<a name="cluster_parameter_groups-describe_details_parameters"></a>

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 à https://console.aws.amazon.com l'adresse /docdb.](https://console.aws.amazon.com/docdb)

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

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

1. 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.  
![\[Capture d'écran : Noms et valeurs de paramètres.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-determine-parameter-value.png)

------
#### [ 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`.

**Example**  
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
<a name="cluster_parameter_groups-modify_parameters"></a>

Vous pouvez modifier les paramètres d'un groupe de paramètres à l'aide du AWS Management Console ou 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 à https://console.aws.amazon.com l'adresse /docdb.](https://console.aws.amazon.com/docdb)

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

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

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

1. 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](cluster_parameter_groups-list_of_parameters.md).

1. 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"
           }
       ]
   }
   ```

1. **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"
   }
   ```

1. **Patientez au moins 5 minutes.**

1. **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"
           }
       ]
   }
   ```

------

# Comprendre les points de terminaison Amazon DocumentDB
<a name="endpoints"></a>

Vous pouvez utiliser les points de terminaison Amazon DocumentDB (compatibles avec MongoDB) pour vous connecter à un cluster ou à une instance. Amazon DocumentDB possède trois types de points de terminaison différents, chacun ayant son propre objectif. 

**Topics**
+ [Trouver les points de terminaison d'un cluster](db-cluster-endpoints-find.md)
+ [Trouver le point de terminaison d'une instance](db-instance-endpoint-find.md)
+ [Connexion aux points de terminaison](endpoints-connecting.md)

**Point de terminaison de cluster**  
Un point de terminaison de cluster est un point de terminaison d'un cluster Amazon DocumentDB qui se connecte à l'instance principale actuelle du cluster. Chaque cluster Amazon DocumentDB possède un point de terminaison de cluster unique et une instance principale. En cas de basculement, le point de terminaison du cluster est remappé vers la nouvelle instance principale.

**Point de terminaison du lecteur**  
Un point de terminaison de lecteur est un point de terminaison d'un cluster Amazon DocumentDB qui se connecte à l'une des répliques disponibles pour ce cluster. Chaque cluster Amazon DocumentDB possède un point de terminaison lecteur. S'il existe plusieurs répliques, le point de terminaison du lecteur dirige chaque demande de connexion vers l'une des répliques Amazon DocumentDB.

**Point de terminaison d'instance**  
Un point de terminaison d'une instance est un point de terminaison qui se connecte à cette instance spécifique. Chaque instance d'un cluster, qu'il s'agisse d'une instance principale ou d'une instance de réplica, a son propre point de terminaison d'instance unique. Il est préférable de ne pas utiliser les points de terminaison d'instance dans votre application. En effet, ils peuvent modifier les rôles en cas de basculement, ce qui oblige à modifier le code dans votre application.

# Trouver les points de terminaison d'un cluster
<a name="db-cluster-endpoints-find"></a>

Vous pouvez trouver le point de terminaison du cluster et le point de terminaison du lecteur d'un cluster à l'aide de la console Amazon DocumentDB ou. AWS CLI

------
#### [ Using the AWS Management Console ]

**Pour rechercher les points de terminaison d'un cluster à l'aide de la console :**

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

1. Dans le panneau de navigation, choisissez **Clusters**.

1. Dans la liste des clusters, choisissez le nom du cluster qui vous intéresse.

1. Sur la page des détails du cluster, sélectionnez l'onglet **Configuration**. Dans la section **Configurations et état**, vous trouverez le **point de terminaison du cluster** et le point de **terminaison du lecteur**.  
![\[Section des configurations et de l'état présentant les points de terminaison du cluster et du lecteur.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cluster-endpoints.png)

1. Pour vous connecter à ce cluster, sélectionnez l'onglet **Connectivité et sécurité**. Recherchez la chaîne de connexion pour le `mongo` shell et la chaîne de connexion qui peut être utilisée dans le code de l'application pour vous connecter à votre cluster.  
![\[Section Connect affichant une chaîne pour se connecter à l'instance avec le shell mongo et une chaîne pour se connecter au cluster avec une application.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/cluster-connection-strings.png)

------
#### [ Using the AWS CLI ]

Pour rechercher les points de terminaison du cluster et du lecteur de votre cluster à l'aide de AWS CLI, exécutez la `describe-db-clusters` commande avec ces paramètres.

**Paramètres**
+ **--db-cluster-identifier**—Facultatif. Spécifiez le cluster auquel renvoyer des points de terminaison. Si cet argument n'est pas spécifié, le nombre de points de terminaison renvoyés peut atteindre 100 de vos clusters.
+ **--query**—Facultatif. Spécifiez les champs à afficher. Utile en réduisant la quantité de données que vous devez afficher pour trouver les points de terminaison. Si cela est omis, toutes les informations sur un cluster sont renvoyées.
+ **--region**—Facultatif. Utilisez le paramètre `--region` pour spécifier la région à laquelle vous souhaitez appliquer la commande. S'il n'est pas spécifié, votre région par défaut est utilisée.

**Example**  
L'exemple suivant renvoie le `DBClusterIdentifier`, le point de terminaison (point de terminaison du cluster) et le `ReaderEndpoint` pour `sample-cluster`.  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-clusters \
   --region us-east-1 \
   --db-cluster-identifier sample-cluster \
   --query 'DBClusters[*].[DBClusterIdentifier,Port,Endpoint,ReaderEndpoint]'
```
Pour Windows :  

```
aws docdb describe-db-clusters ^
   --region us-east-1 ^
   --db-cluster-identifier sample-cluster ^
   --query 'DBClusters[*].[DBClusterIdentifier,Port,Endpoint,ReaderEndpoint]'
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
[
  [
     "sample-cluster",
     27017,
     "sample-cluster.cluster-corlsfccjozr.us-east-1.docdb.amazonaws.com",
     "sample-cluster.cluster-ro-corlsfccjozr.us-east-1.docdb.amazonaws.com"
  ]
]
```

Maintenant que vous disposez du point de terminaison du cluster, vous pouvez vous connecter au cluster à l'aide de `mongo` ou `mongodb`. Pour de plus amples informations, veuillez consulter [Connexion aux points de terminaison](endpoints-connecting.md).

------

# Trouver le point de terminaison d'une instance
<a name="db-instance-endpoint-find"></a>

Vous pouvez trouver le point de terminaison d'une instance à l'aide de la console Amazon DocumentDB ou du. AWS CLI

------
#### [ Using the AWS Management Console ]

**Recherche d'un point de terminaison d'une instance à l'aide de la console**

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

1. Dans le panneau de navigation, choisissez **Clusters**.
**Astuce**  
Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans la boîte de navigation Clusters, vous verrez la colonne **Cluster Identifier**. Vos instances sont répertoriées sous des clusters, comme dans la capture d'écran ci-dessous.  
![\[Tableau des clusters présentant la liste des clusters sous la colonne Identifiant du cluster, avec les instances imbriquées dans les clusters.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/choose-clusters.png)

1. Cochez la case située à gauche de l'instance qui vous intéresse.

1. Faites défiler jusqu'à la rubrique **Détails**, puis localisez le point de terminaison de l'instance.  
![\[Capture d'écran de la console affichant la page des détails avec le point de terminaison de l'instance en surbrillance.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-instance-endpoint.png)

1. Pour vous connecter à cette instance, faites défiler jusqu'à la rubrique **Connecter**. Localisez la chaîne de connexion pour le shell `mongo` et une chaîne de connexion qui peuvent être utilisées dans votre code d'application pour vous connecter à votre instance.  
![\[Capture d'écran de la console montrant la section Connect avec le shell mongo et les chaînes de connexion à l'application surlignées.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/instance-connection-strings.png)

------
#### [ Using the AWS CLI ]

Pour rechercher le point de terminaison de l'instance à l'aide de AWS CLI, exécutez la commande suivante avec ces arguments.

**Arguments**
+ **--db-instance-identifier**—Facultatif. Spécifie l'instance à laquelle renvoyer le point de terminaison. Si cet argument n'est pas spécifié, le nombre de points de terminaison renvoyé peut atteindre 100 de vos instances.
+ **--query**—Facultatif. Spécifiez les champs à afficher. Utile en réduisant la quantité de données que vous devez afficher pour trouver les points de terminaison. Si cela est omis, toutes les informations sur une instance sont renvoyées. Le champ `Endpoint` possède trois membres, son inclusion dans la requête comme dans l'exemple suivant renvoie donc les trois membres. Si vous êtes intéressé uniquement par certains des membres `Endpoint`, remplacez `Endpoint` dans la requête par les membres qui vous intéressent, comme dans le deuxième exemple.
+ **--region**—Facultatif. Utilisez le paramètre `--region` pour spécifier la région à laquelle vous souhaitez appliquer la commande. S'il n'est pas spécifié, votre région par défaut est utilisée.

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-instances \
    --region us-east-1 \
    --db-instance-identifier sample-cluster-instance \
    --query 'DBInstances[*].[DBInstanceIdentifier,Endpoint]'
```
Pour Windows :  

```
aws docdb describe-db-instances ^
    --region us-east-1 ^
    --db-instance-identifier sample-cluster-instance ^
    --query 'DBInstances[*].[DBInstanceIdentifier,Endpoint]'
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
[
    [
        "sample-cluster-instance",
        {
            "Port": 27017,
            "Address": "sample-cluster-instance.corcjozrlsfc.us-east-1.docdb.amazonaws.com",
            "HostedZoneId": "Z2R2ITUGPM61AM"
        }
    ]
]
```
En réduisant les résultats pour éliminer la `HostedZoneId` du point de terminaison, vous pouvez modifier votre requête en spécifiant `Endpoint.Port` et `Endpoint.Address`.  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-instances \
    --region us-east-1 \
    --db-instance-identifier sample-cluster-instance \
    --query 'DBInstances[*].[DBInstanceIdentifier,Endpoint.Port,Endpoint.Address]'
```
Pour Windows :  

```
aws docdb describe-db-instances ^
    --region us-east-1 ^
    --db-instance-identifier sample-cluster-instance ^
    --query 'DBInstances[*].[DBInstanceIdentifier,Endpoint.Port,Endpoint.Address]'
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
[
    [
        "sample-cluster-instance",
        27017,
        "sample-cluster-instance.corcjozrlsfc.us-east-1.docdb.amazonaws.com"
    ]
]
```

Maintenant que vous disposez du point de terminaison de l'instance, vous pouvez vous connecter à l'instance à l'aide de `mongo` ou `mongodb`. Pour de plus amples informations, veuillez consulter [Connexion aux points de terminaison](endpoints-connecting.md).

------

# Connexion aux points de terminaison
<a name="endpoints-connecting"></a>

Lorsque vous avez votre point de terminaison, cluster ou instance, vous pouvez vous y connecter à l'aide du shell `mongo` ou d'une chaîne de connexion.

## Connexion à l'aide de la coque Mongo
<a name="endpoints-connecting-mongo"></a>

Utilisez la structure suivante pour construire la chaîne dont vous avez besoin pour vous connecter à votre cluster ou instance à l'aide du shell `mongo` :

```
mongo \
    --ssl \
    --host Endpoint:Port \
    --sslCAFile global-bundle.pem \
    --username UserName \
    --password Password
```

**Exemples de shell `mongo`**  
Connexion à un cluster :

```
mongo \
    --ssl \
    --host sample-cluster.corcjozrlsfc.us-east-1.docdb.amazonaws.com:27017 \
    --sslCAFile global-bundle.pem \
    --username UserName \
    --password Password
```

Connexion à une instance :

```
mongo \
    --ssl \
    --host sample-cluster-instance.corcjozrlsfc.us-east-1.docdb.amazonaws.com:27017 \
    --sslCAFile global-bundle.pem \
    --username UserName \
    --password Password
```

## Connexion à l'aide d'une chaîne de connexion
<a name="endpoints-connecting-mongodb"></a>

Utilisez la structure suivante pour construire la chaîne de connexion dont vous avez besoin pour vous connecter à votre cluster ou instance.

```
mongodb://UserName:Password@endpoint:port?replicaSet=rs0&ssl_ca_certs=global-bundle.pem 
```

**Exemples de chaînes de connexion**  
Connexion à un cluster :

```
mongodb://UserName:Password@sample-cluster.cluster-corlsfccjozr.us-east-1.docdb.amazonaws.com:27017?replicaSet=rs0&ssl_ca_certs=global-bundle.pem 
```

Connexion à une instance :

```
mongodb://UserName:Password@sample-cluster-instance.cluster-corlsfccjozr.us-east-1.docdb.amazonaws.com:27017?replicaSet=rs0&ssl_ca_certs=global-bundle.pem 
```

 

# Comprendre les noms de ressources Amazon DocumentDB Amazon () ARNs
<a name="documentdb-arns"></a>

Les ressources que vous créez dans AWS sont toutes identifiées de manière unique par un Amazon Resource Name (ARN). Pour certaines opérations Amazon DocumentDB (compatibles avec MongoDB), vous devez identifier de manière unique une ressource Amazon DocumentDB en spécifiant son ARN. Par exemple, lorsque vous ajoutez une balise à une ressource, vous devez fournir l'ARN de la ressource. 

**Topics**
+ [Construction d’un ARN](#documentdb-arns-constructing)
+ [Recherche d'un ARN](#documentdb-arns-find)

## Création d'un ARN pour une ressource Amazon DocumentDB
<a name="documentdb-arns-constructing"></a>

Vous pouvez créer un ARN pour une ressource Amazon DocumentDB en utilisant la syntaxe suivante. Amazon DocumentDB partage le format d'Amazon Relational Database Service (Amazon RDS). ARNs Amazon DocumentDB ARNs contient `rds` et non. `docdb`

`arn:aws:rds:region:account_number:resource_type:resource_id`


| Nom de la région | Région | Zones de disponibilité (calcul) | 
| --- | --- | --- | 
| USA Est (Ohio) | `us-east-2` | 3 | 
| USA Est (Virginie du Nord) | `us-east-1` | 6 | 
| USA Ouest (Oregon) | `us-west-2` | 4 | 
| Afrique (Le Cap) | `af-south-1` | 3 | 
| Amérique du Sud (São Paulo) | `sa-east-1` | 3 | 
| Asie-Pacifique (Hong Kong) | `ap-east-1` | 3 | 
| Asie-Pacifique (Hyderabad) | `ap-south-2` | 3 | 
| Asie-Pacifique (Malaisie) | `ap-southeast-5` | 3 | 
| Asie-Pacifique (Mumbai) | `ap-south-1` | 3 | 
| Asie-Pacifique (Osaka) | `ap-northeast-3` | 3 | 
| Asie-Pacifique (Séoul) | `ap-northeast-2` | 4 | 
| Asie-Pacifique (Singapour) | `ap-southeast-1` | 3 | 
| Asie-Pacifique (Sydney) | `ap-southeast-2` | 3 | 
| Asie-Pacifique (Jakarta) | `ap-southeast-3` | 3 | 
| Asie-Pacifique (Melbourne) | `ap-southeast-4` | 3 | 
| Asie-Pacifique (Thaïlande) | `ap-southeast-7` | 3 | 
| Asie-Pacifique (Tokyo) | `ap-northeast-1` | 3 | 
| Canada (Centre) | `ca-central-1` | 3 | 
| Région Chine (Beijing) | `cn-north-1` | 3 | 
| Chine (Ningxia) | `cn-northwest-1` | 3 | 
| Europe (Francfort) | `eu-central-1` | 3 | 
| Europe (Zurich) | `eu-central-2` | 3 | 
| Europe (Irlande) | `eu-west-1` | 3 | 
| Europe (Londres) | `eu-west-2` | 3 | 
| Europe (Milan) | `eu-south-1` | 3 | 
| Europe (Paris) | `eu-west-3` | 3 | 
| Europe (Espagne) | `eu-south-2` | 3 | 
| Europe (Stockholm) | `eu-north-1` | 3 | 
| Mexique (Centre) | `mx-central-1` | 3 | 
| Moyen-Orient (EAU) | `me-central-1` | 3 | 
| Israël (Tel Aviv) | `il-central-1` | 3 | 
| AWS GovCloud (US-Ouest) | `us-gov-west-1` | 3 | 
| AWS GovCloud (USA Est) | `us-gov-east-1` | 3 | 

**Note**  
L'architecture Amazon DocumentDB sépare le stockage et le calcul. Pour la couche de stockage, Amazon DocumentDB réplique six copies de vos données dans trois zones de AWS disponibilité (). AZs Le AZs tableau ci-dessus indique le nombre AZs que vous pouvez utiliser dans une région donnée pour provisionner des instances de calcul. Par exemple, si vous lancez un cluster Amazon DocumentDB dans ap-northeast-1, votre stockage sera répliqué de six manières sur trois, mais vos instances de calcul ne seront disponibles que dans deux. AZs AZs

Le tableau suivant indique le format que vous devez utiliser lors de la création d'un ARN pour une ressource Amazon DocumentDB spécifique. Amazon DocumentDB partage le format d'Amazon RDS. ARNs Amazon DocumentDB ARNs contient `rds` et non. `docdb`


| Type de ressource | Format ARN/Exemple | 
| --- | --- | 
|  Instance (`db`)  |  `arn:aws:rds:region:account_number:db:resource_id` <pre>arn:aws:rds:us-east-1:1234567890:db:sample-db-instance</pre>  | 
|  Cluster (`cluster`)  |  `arn:aws:rds:region:account_number:cluster:resource_id` <pre>arn:aws:rds:us-east-1:1234567890:cluster:sample-db-cluster</pre>  | 
|  Groupe de paramètres du cluster (`cluster-pg`)  |  `arn:aws:rds:region:account_number:cluster-pg:resource_id` <pre>arn:aws:rds:us-east-1:1234567890:cluster-pg:sample-db-cluster-parameter-group</pre>  | 
|  Groupe de sécurité (`secgrp`)  |  `arn:aws:rds:region:account_number:secgrp:resource_id` <pre>arn:aws:rds:us-east-1:1234567890:secgrp:sample-public-secgrp</pre>  | 
|  Instantané du cluster (`cluster-snapshot`)  |  `arn:aws:rds:region:account_number:cluster-snapshot:resource_id` <pre>arn:aws:rds:us-east-1:1234567890:cluster-snapshot:sample-db-cluster-snapshot</pre>  | 
|  Groupe de sous-réseaux (`subgrp`)  |  `arn:aws:rds:region:account_number:subgrp:resource_id` <pre>arn:aws:rds:us-east-1:1234567890:subgrp:sample-subnet-10</pre>  | 

## Trouver l'ARN d'une ressource Amazon DocumentDB
<a name="documentdb-arns-find"></a>

Vous pouvez trouver l'ARN d'une ressource Amazon DocumentDB en utilisant le AWS Management Console ou le. AWS CLI

------
#### [ Using the AWS Management Console ]

Pour trouver un ARN à l'aide de la console, accédez à la ressource pour laquelle vous souhaitez obtenir un ARN, puis consultez les détails de cette ressource. 

Par exemple, vous pouvez obtenir l'ARN d'un cluster en sélectionnant l'onglet **Configuration** sur la page de détails du cluster. L'ARN se trouve dans la section **Configurations et état**, comme indiqué dans la capture d'écran suivante.

![\[Capture d'écran de la console présentant un ARN dans la rubrique configurations et état du volet des détails.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/documentdb-arn.png)


------
#### [ Using the AWS CLI ]

Pour obtenir un ARN en utilisant le AWS CLI pour une ressource Amazon DocumentDB particulière, utilisez l'`describe`opération pour cette ressource. Le tableau suivant indique chaque AWS CLI opération et la propriété ARN utilisée avec l'opération pour obtenir un ARN. 


| AWS CLI Commande | Propriété d'ARN | 
| --- | --- | 
|  `describe-db-instances`  |  `DBInstanceArn`  | 
|  `describe-db-clusters`  |  `DBClusterArn`  | 
|  `describe-db-parameter-groups`  |  `DBParameterGroupArn`  | 
|  `describe-db-cluster-parameter-groups`  |  `DBClusterParameterGroupArn`  | 
|  `describe-db-security-groups`  |  `DBSecurityGroupArn`  | 
|  `describe-db-snapshots`  |  `DBSnapshotArn`  | 
|  `describe-db-cluster-snapshots`  |  `DBClusterSnapshotArn`  | 
|  `describe-db-subnet-groups`  |  `DBSubnetGroupArn`  | 

**Example - Recherche de l'ARN d'un cluster**  
L' AWS CLI opération suivante permet de trouver l'ARN du cluster`sample-cluster`.  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-clusters \
    --db-cluster-identifier sample-cluster \
    --query 'DBClusters[*].DBClusterArn'
```
Pour Windows :  

```
aws docdb describe-db-clusters ^
    --db-cluster-identifier sample-cluster \
    --query 'DBClusters[*].DBClusterArn'
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
[
    "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster"
]
```

**Example - Recherche ARNs de plusieurs groupes de paramètres**  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-cluster-parameter-groups \
   --query 'DBClusterParameterGroups[*].DBClusterParameterGroupArn'
```
Pour Windows :  

```
aws docdb describe-db-cluster-parameter-groups ^
   --query 'DBClusterParameterGroups[*].DBClusterParameterGroupArn'
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
[
    "arn:aws:rds:us-east-1:123456789012:cluster-pg:custom3-6-param-grp",
    "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6",
    "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.docdb3.6"
]
```

------

# Balisage des ressources Amazon DocumentDB
<a name="tagging"></a>

Vous pouvez utiliser les balises Amazon DocumentDB (compatibles avec MongoDB) pour ajouter des métadonnées à vos ressources Amazon DocumentDB. Ces balises peuvent être utilisées avec des politiques Gestion des identités et des accès AWS (IAM) pour gérer l'accès aux ressources Amazon DocumentDB et pour contrôler les actions qui peuvent être appliquées aux ressources. Vous pouvez également utiliser ces balises pour suivre les coûts en regroupant les dépenses pour des ressources balisées de la même façon.

Vous pouvez baliser les ressources Amazon DocumentDB suivantes :
+ Clusters
+ instances
+ Instantanés
+ Instantanés de cluster
+ Groupes de paramètres
+ Groupes de paramètres de cluster
+ Groupes de sécurité
+ Groupes de sous-réseaux

## Présentation des balises de ressources Amazon DocumentDB
<a name="tagging-overview"></a>

Une balise Amazon DocumentDB est une paire nom-valeur que vous définissez et associez à une ressource Amazon DocumentDB. Le nom s'appelle la *clé*. Fournir une valeur pour la clé est facultatif. Vous pouvez utiliser des balises pour attribuer des informations arbitraires à une ressource Amazon DocumentDB. Vous pouvez utiliser une clé de balise, par exemple, pour définir une catégorie, et la valeur de balise peut être un élément de cette catégorie. Par exemple, vous pouvez définir une clé de balise `project` et une valeur de balise de`Salix`, indiquant que la ressource Amazon DocumentDB est affectée au projet Salix. Vous pouvez également utiliser des balises pour désigner les ressources Amazon DocumentDB comme étant utilisées à des fins de test ou de production à l'aide d'une clé telle que `environment=test` ou. `environment=production` Nous vous recommandons d'utiliser un ensemble cohérent de clés de balise pour faciliter le suivi des métadonnées associées aux ressources Amazon DocumentDB.

Vous pouvez utiliser des balises pour organiser votre AWS facture afin de refléter votre propre structure de coûts. Pour ce faire, inscrivez-vous pour recevoir votre Compte AWS facture avec les valeurs clés du tag incluses. Ensuite, pour voir le coût de vos ressources combinées, organisez vos informations de facturation en fonction des ressources possédant les mêmes valeurs de clé de balise. Par exemple, vous pouvez baliser plusieurs ressources avec un nom d'application spécifique, puis organiser vos informations de facturation pour afficher le coût total de cette application dans plusieurs services. Pour plus d'informations, veuillez consulter la rubrique [Utilisation des balises de répartition des coûts](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) dans le *AWS Guide de l'utilisateur pour la gestion des coûts et de la facturation*. 

Chaque ressource Amazon DocumentDB possède un ensemble de balises, qui contient toutes les balises attribuées à cette ressource. Un ensemble de balises peut contenir jusqu'à dix balises ou n'en contenir aucune. Si vous ajoutez une balise à une ressource Amazon DocumentDB qui possède la même clé qu'une balise existante sur la ressource, la nouvelle valeur remplace l'ancienne valeur.

AWS n'applique aucune signification sémantique à vos balises ; les balises sont interprétées strictement comme des chaînes de caractères. Amazon DocumentDB peut définir des balises sur une instance ou sur d'autres ressources Amazon DocumentDB, en fonction des paramètres que vous utilisez lors de la création de la ressource. Par exemple, Amazon DocumentDB peut ajouter une balise indiquant qu'une instance est destinée à la production ou aux tests.

Vous pouvez ajouter une balise à un instantané, toutefois, votre facture ne reflètera pas ce groupement.

Vous pouvez utiliser le AWS Management Console ou le AWS CLI pour ajouter, répertorier et supprimer des balises sur les ressources Amazon DocumentDB. Lorsque vous utilisez le AWS CLI, vous devez fournir le nom de ressource Amazon (ARN) de la ressource avec laquelle vous souhaitez travailler. Pour plus d'informations sur Amazon DocumentDB ARNs, consultez. [Comprendre les noms de ressources Amazon DocumentDB Amazon () ARNs](documentdb-arns.md)

## Contraintes liées aux balises
<a name="tagging-constraints"></a>

Les contraintes suivantes s'appliquent aux balises Amazon DocumentDB :
+ Nombre maximum de balises par ressource : 10
+ Longueur de **Key** maximale - 128 caractères Unicode.
+ Longueur de **valeur** maximale - 256 caractères Unicode.
+ Caractères valables pour **Clé** et **Valeur** - lettres majuscules et minuscules UTF-8, chiffres, espace et les caractères suivants : `_ . : / = + -` et `@` (Java regex : `"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"`)
+ Les clés et valeurs de balise sont sensibles à la casse.
+ Le préfixe `aws:` ne peut pas être utilisé pour les valeurs ou clés de balise ; il est réservé à AWS.

## Ajout et mise à jour de balises sur une ressource Amazon DocumentDB
<a name="tagging-add"></a>

Vous pouvez ajouter jusqu'à 10 balises à une ressource en utilisant le AWS Management Console ou le AWS CLI.

------
#### [ Using the AWS Management Console ]

Le processus d'ajout d'une balise à une ressource est semblable, quelle que soit la ressource à laquelle vous ajoutez la balise. Dans cet exemple, vous ajoutez une balise à un cluster.

**Ajouter ou mettre à jour des balises à un cluster à l'aide de la console**

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

1. Dans le volet de navigation, choisissez **clusters**.

1. Choisissez le nom du cluster auquel vous souhaitez ajouter des balises.

1. Faites défiler jusqu'à la section **Balises**, puis choisissez **Modifier**.

1. Pour chaque balise que vous souhaitez ajouter à cette ressource, procédez comme suit :

   1. Pour ajouter une nouvelle balise, saisissez le nom de la balise dans la case **Clé**. Pour modifier la valeur d'une balise, recherchez le nom de la balise dans la colonne **Clé**.

   1. Pour doter la balise d'une valeur nouvelle ou mise à jour, saisissez une valeur pour la balise dans la case **Valeur**.

   1. Pour ajouter davantage de balises, choisissez **Ajouter**. Lorsque vous avez terminé, choisissez **Sauvegarder**.

------
#### [ Using the AWS CLI ]

Le processus d'ajout d'une balise à une ressource est semblable, quelle que soit la ressource à laquelle vous ajoutez la balise. Dans cet exemple, vous ajoutez trois balises à un cluster. La deuxième balise, `key2`, n'a pas de valeur.

Utilisez l' AWS CLI opération `add-tags-to-resource` avec ces paramètres.

**Paramètres**
+ **--resource-name**: l'ARN de la ressource Amazon DocumentDB à laquelle vous souhaitez ajouter des balises.
+ **--tags**—Répertoriez les balises (paire clé-valeur) que vous souhaitez ajouter à cette ressource au format. `Key=key-name,Value=tag-value`

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb add-tags-to-resource \
    --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster \
    --tags Key=key1,Value=value1 Key=key2 Key=key3,Value=value3
```
Pour Windows :  

```
aws docdb add-tags-to-resource ^
    --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster \
    --tags Key=key1,Value=value1 Key=key2 Key=key3,Value=value3
```

L'opération `add-tags-to-resource` ne produit aucun résultat. Pour consulter les résultats de l'opération, utilisez l'opération `list-tags-for-resource`.

------

## Répertorier des balises sur une ressource Amazon DocumentDB
<a name="tagging-list"></a>

Vous pouvez utiliser le AWS Management Console ou le AWS CLI pour obtenir la liste des balises d'une ressource Amazon DocumentDB.

------
#### [ Using the AWS Management Console ]

Le processus pour établir une liste de balises pour une ressource est semblable, quelle que soit la ressource à laquelle vous ajoutez la balise. Dans cet exemple, vous établissez la liste des balises pour un cluster.

**Établir la liste des balises pour un cluster à l'aide de la console**

1. [Ouvrez la console Amazon DocumentDB à https://console.aws.amazon.com l'adresse /docdb.](https://console.aws.amazon.com/docdb)

1. Dans le volet de navigation, choisissez **clusters**.

1. Choisissez le nom du cluster pour lequel vous souhaitez établir la liste des balises.

1. Pour afficher la liste des balises pour cette ressource, faites défiler vers le bas jusqu'à la section **Balises**.

------
#### [ Using the AWS CLI ]

Le processus pour établir une liste de balises pour une ressource est semblable, quelle que soit la ressource pour laquelle vous établissez la liste des balises. Dans cet exemple, vous établissez la liste des balises pour un cluster.

Utilisez l' AWS CLI opération `list-tags-for-resource` avec ces paramètres.

**Paramètres**
+ **--resource-name** : obligatoire. L'ARN de la ressource Amazon DocumentDB pour laquelle vous souhaitez répertorier les balises.

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb list-tags-for-resource \
    --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster
```
Pour Windows :  

```
aws docdb list-tags-for-resource ^
    --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster
```

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

```
{
    "TagList": [
        {
            "Key": "key1",
            "Value": "value1"
        },
        {
            "Key": "key2",
            "Value": ""
        },
        {
            "Key": "key3",
            "Value": "value3"
        }
    ]
}
```

------

## Supprimer des balises d'une ressource Amazon DocumentDB
<a name="tagging-remove"></a>

Vous pouvez utiliser le AWS Management Console ou le AWS CLI pour supprimer des balises des ressources Amazon DocumentDB.

------
#### [ Using the AWS Management Console ]

Le processus de suppression de balises dans une ressource est semblable, quelle que soit la ressource dans laquelle vous voulez supprimer la balise. Dans cet exemple, vous supprimez des balises dans un cluster.

**Pour supprimer les balises d'un cluster à l'aide de la console**

1. [Ouvrez la console Amazon DocumentDB à https://console.aws.amazon.com l'adresse /docdb.](https://console.aws.amazon.com/docdb)

1. Dans le volet de navigation, choisissez **clusters**.

1. Choisissez le nom du cluster pour lequel vous souhaitez supprimer des balises.

1. Faites défiler jusqu'à la section **Balises**, puis choisissez **Modifier**.

1. Si vous souhaitez supprimer toutes les balises de cette ressource, choisissez **Tout supprimer**. Dans le cas contraire, pour chaque balise que vous souhaitez supprimer dans cette ressource, procédez comme suit :

   1. Recherchez le nom de la balise dans la colonne **Clé**.

   1. Choisissez **Supprimer** sur la même ligne que la clé de la balise.

   1. Lorsque vous avez terminé, choisissez **Save (Sauvegarder)**.

------
#### [ Using the AWS CLI ]

Le processus de suppression d'une balise dans une ressource est semblable, quelle que soit la ressource dans laquelle vous voulez supprimer la balise. Dans cet exemple, vous supprimez une balise dans un cluster.

Utilisez l' AWS CLI opération `remove-tags-from-resource` avec ces paramètres.
+ **--resource-name** : obligatoire. L'ARN de la ressource Amazon DocumentDB dont vous souhaitez supprimer les balises.
+ **--tag-keys** : obligatoire. Liste des clés des balises que vous voulez supprimer dans cette ressource.

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb remove-tags-from-resource \
    --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster \
    --tag-keys key1 key3
```
Pour Windows :  

```
aws docdb remove-tags-from-resource ^
    --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster \
    --tag-keys key1 key3
```

L'opération `removed-tags-from-resource` ne produit aucun résultat. Pour consulter les résultats de l'opération, utilisez l'opération `list-tags-for-resource`.

------

# Gestion d'Amazon DocumentDB
<a name="db-instance-maintain"></a>

Amazon DocumentDB effectue régulièrement la maintenance des ressources Amazon DocumentDB. La maintenance implique le plus souvent des mises à jour du moteur de base de données (maintenance de cluster) ou du système d'exploitation sous-jacent de l'instance (maintenance de l'instance). Les mises à jour du moteur de base de données sont des correctifs obligatoires et incluent des correctifs de sécurité, des corrections de bogues et des améliorations du moteur de base de données. Bien que la plupart des correctifs du système d'exploitation soient facultatifs, si vous ne les appliquez pas pendant un certain temps, ils peuvent être nécessaires et appliqués automatiquement pour maintenir votre niveau de sécurité. Nous vous recommandons donc d'appliquer les mises à jour du système d'exploitation à vos instances Amazon DocumentDB dès qu'elles sont disponibles. 

Les correctifs du moteur de base de données nécessitent que vous mettiez vos clusters Amazon DocumentDB hors ligne pendant une courte période. Une fois disponibles, ces correctifs sont automatiquement programmés pour s'appliquer lors d'une prochaine période de maintenance planifiée de votre cluster Amazon DocumentDB.

La maintenance du cluster et celle des instances ont leurs propres fenêtres de maintenance. Les modifications de cluster et d'instance que vous avez choisi de ne pas appliquer immédiatement sont également appliquées pendant la fenêtre de maintenance. Par défaut, lorsque vous créez un cluster, Amazon DocumentDB attribue une fenêtre de maintenance à la fois au cluster et à chaque instance individuelle. Vous pouvez choisir la fenêtre de maintenance lors de la création d'un cluster ou d'une instance. Vous pouvez également modifier les fenêtres de maintenance à tout moment en fonction de vos planifications ou pratiques métier. Il est généralement conseillé de choisir des fenêtres de maintenance qui limitent l'impact de la maintenance sur votre application (par exemple, le soir ou le week-end).

**Topics**
+ [Notifications relatives aux correctifs du moteur Amazon DocumentDB](#patch-notifications)
+ [Affichage des actions de maintenance Amazon DocumentDB en attente](#view-pending-maintenance)
+ [Mises à jour du moteur Amazon DocumentDB](#db-instance-updates-apply)
+ [Mises à jour initiées par](#user-initiated-updates)
+ [Gestion de vos fenêtres de maintenance Amazon DocumentDB](#maintenance-window)
+ [Mises à jour du système d'exploitation Amazon DocumentDB](#os-system-updates)

## Notifications relatives aux correctifs du moteur Amazon DocumentDB
<a name="patch-notifications"></a>

Vous recevrez des notifications de maintenance pour les correctifs de moteur de base de données requis par le biais d'événements de santé dans le Tableau de bord Health (AHD) de la AWS console et par e-mail. Lorsqu'un correctif de maintenance du moteur Amazon DocumentDB est disponible dans une AWS région donnée, tous les comptes utilisateurs Amazon DocumentDB concernés de la région reçoivent un AHD et une notification par e-mail pour chaque version d'Amazon DocumentDB affectée par le correctif. Vous pouvez consulter ces notifications dans la section **Modifications planifiées** de l'AHD dans la AWS console. La notification contiendra des détails sur le calendrier de disponibilité des correctifs, le calendrier d'application automatique, la liste des clusters concernés et les notes de mise à jour. Cette notification sera également envoyée par e-mail à l'adresse e-mail de l'utilisateur root du AWS compte.

![\[La console Amazon DocumentDB affiche l'onglet Modifications planifiées pour les mises à niveau des correctifs du moteur.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/scheduled-changes.png)


Une fois que vous aurez reçu cette notification, vous pourrez choisir d'appliquer automatiquement ces correctifs de moteur à vos clusters Amazon DocumentDB avant la date d'application automatique prévue. Vous pouvez également attendre que les correctifs du moteur soient appliqués automatiquement lors d'une prochaine fenêtre de maintenance (option par défaut).

**Note**  
Le **statut** de la notification dans l'AHD sera défini sur « En cours » jusqu'à ce qu'un nouveau correctif du moteur Amazon DocumentDB contenant une nouvelle version du correctif soit publié.  
Une fois le correctif du moteur appliqué à votre cluster Amazon DocumentDB, la version du correctif du moteur du cluster sera mise à jour pour refléter la version indiquée dans la notification. Vous pouvez exécuter la `db.runCommand({getEngineVersion: 1})` commande pour vérifier cette mise à jour.

AWS Health s'intègre également à Amazon EventBridge , qui utilise des événements pour créer des applications évolutives axées sur les événements et s'intègre à plus de 20 cibles AWS Lambda, dont Amazon Simple Queue Service (SQS), entre autres. Vous pouvez utiliser le code `AWS_DOCDB_DB_PATCH_UPGRADE_MAINTENANCE_SCHEDULED` d'événement pour configurer Amazon EventBridge avant que les correctifs du moteur ne soient disponibles. Vous pouvez le configurer EventBridge pour répondre à l'événement et exécuter automatiquement des actions telles que la capture des informations relatives à l'événement, le lancement d'événements supplémentaires, l'envoi de notifications via des canaux supplémentaires tels que les notifications push au AWS Console Mobile Application, et la prise de mesures correctives ou autres lorsqu'un correctif du moteur Amazon DocumentDB est disponible dans votre région. 

Dans les rares cas où Amazon DocumentDB annule un correctif moteur, vous recevrez une notification AHD ainsi qu'un e-mail vous informant de l'annulation. Par conséquent, vous pouvez utiliser le code `AWS_DOCDB_DB_PATCH_UPGRADE_MAINTENANCE_CANCELLED` d'événement pour configurer Amazon EventBridge afin qu'il réponde à cet événement. Consultez le *guide de EventBridge l'utilisateur Amazon* pour en savoir plus sur l'utilisation [ EventBridge des règles Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rules.html).

## Affichage des actions de maintenance Amazon DocumentDB en attente
<a name="view-pending-maintenance"></a>

Vous pouvez voir si une mise à jour de maintenance est disponible pour votre cluster en utilisant le AWS Management Console ou le AWS CLI.

Si une mise à jour est disponible, vous pouvez procéder de l’une des manières suivantes :
+ Reportez une action de maintenance actuellement planifiée pour la prochaine fenêtre de maintenance (pour les correctifs du système d'exploitation uniquement).
+ Appliquer immédiatement les actions de maintenance.
+ Planifier le début des actions de maintenance au cours de votre prochaine fenêtre de maintenance.

**Note**  
Si vous ne prenez aucune mesure, les actions de maintenance requises, telles que les correctifs du moteur, seront appliquées automatiquement lors d'une prochaine fenêtre de maintenance planifiée.

Le réglage de la fenêtre de maintenance détermine quand les opérations en attente démarrent, mais il ne limite pas la durée d'exécution totale de ces opérations.

------
#### [ Using the AWS Management Console ]

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

1. Dans le panneau de navigation, choisissez **Clusters**.

1. Si une mise à jour est disponible, elle est indiquée par le mot **Available**, **Required** ou **Next Window** dans la colonne **Maintenance** du cluster sur la console Amazon DocumentDB, comme indiqué ici :  
![\[La console Amazon DocumentDB affiche la colonne Maintenance pour les clusters.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/db-cluster-maintenance-updates-status.png)

1. Pour effectuer une action, choisissez le cluster pour afficher ses détails, puis choisissez **Maintenance et sauvegardes**. Les éléments de **maintenance en attente** apparaissent.  
![\[La console Amazon DocumentDB affiche la fenêtre de maintenance du cluster.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/cluster-maint-3.png)

------
#### [ Using the AWS CLI ]

Utilisez l' AWS CLI opération suivante pour déterminer les actions de maintenance en attente. Le résultats obtenu ici n'indique aucune action de maintenance en attente.

```
aws docdb describe-pending-maintenance-actions
```

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

```
{
    "PendingMaintenanceActions": []
}
```

------

## Mises à jour du moteur Amazon DocumentDB
<a name="db-instance-updates-apply"></a>

Avec Amazon DocumentDB, vous pouvez choisir à quel moment appliquer les opérations de maintenance. Vous pouvez décider quand Amazon DocumentDB applique les mises à jour à l'aide du AWS Management Console ou. AWS CLI

Utilisez les procédures décrites dans cette rubrique pour mettre immédiatement à niveau ou planifier une mise à niveau pour votre cluster.

------
#### [ Using the AWS Management Console ]

Vous pouvez utiliser la console pour gérer les mises à jour de vos clusters Amazon DocumentDB.

**Pour gérer une mise à jour pour un cluster**

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

1. Dans le panneau de navigation, choisissez **Clusters**.

1. Dans la liste des clusters, choisissez le bouton en regard du nom du cluster auquel vous voulez appliquer l'opération de maintenance.

1. Dans le menu **Actions**, choisissez l'une des options suivantes :
   + **Mettre à niveau maintenant** pour exécuter immédiatement les tâches de maintenance en attente.
   + **Mettre à niveau lors du créneau suivant** pour exécuter les tâches de maintenance en attente pendant le créneau de maintenance suivant du cluster.

   Vous pouvez également cliquer sur **Appliquer maintenant** ou sur **Appliquer dans la fenêtre de maintenance suivante** dans la section Maintenance en attente de l'onglet **Maintenance et sauvegardes** du cluster (voir **Utilisation du AWS Management Console** dans la section précédente).
**Note**  
S'il n'y a aucune tâche de maintenance en attente, toutes les options précédentes sont inactives.

------
#### [ Using the AWS CLI ]

Pour appliquer une mise à jour en attente à un cluster, utilisez l'`apply-pending-maintenance-action` AWS CLI opération.

**Parameters**
+ **--resource-identifier**—Le nom de ressource Amazon (ARN) Amazon DocumentDB de la ressource à laquelle s'applique l'action de maintenance en attente.
+ **--apply-action**: action de maintenance en attente à appliquer à cette ressource.

  Valeurs valables : `system-update` et `db-upgrade`.
+ **--opt-in-type**—Une valeur qui spécifie le type de demande d'opt-in ou qui annule une demande d'opt-in. Un type demande de confirmation de l'acceptation de type `immediate` ne peut pas être annulée.

  Valeurs valides :
  + `immediate`—Appliquez immédiatement l'action de maintenance.
  + `next-maintenance`—Appliquez l'action de maintenance lors de la fenêtre de maintenance suivante pour la ressource.
  + `undo-opt-in`—Annulez toutes les demandes d'`next-maintenance`opt-in existantes.

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb apply-pending-maintenance-action \
    --resource-identifier arn:aws:rds:us-east-1:123456789012:db:docdb \
    --apply-action system-update \
    --opt-in-type immediate
```
Pour Windows :  

```
aws docdb apply-pending-maintenance-action ^
    --resource-identifier arn:aws:rds:us-east-1:123456789012:db:docdb ^
    --apply-action system-update ^
    --opt-in-type immediate
```

Pour renvoyer une liste des ressources dont au moins une mise à jour est en attente, utilisez la `describe-pending-maintenance-actions` AWS CLI commande. 

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-pending-maintenance-actions \
    --resource-identifier arn:aws:rds:us-east-1:001234567890:db:docdb
```
Pour Windows :  

```
aws docdb describe-pending-maintenance-actions ^
    --resource-identifier arn:aws:rds:us-east-1:001234567890:db:docdb
```
La sortie de cette opération ressemble à ceci (format JSON).  

```
{
    "PendingMaintenanceActions": [
        {
            "ResourceIdentifier": "arn:aws:rds:us-east-1:001234567890:cluster:sample-cluster",
            "PendingMaintenanceActionDetails": [
                {
                    "Action": "system-update",
                    "CurrentApplyDate": "2019-01-11T03:01:00Z",
                    "Description": "db-version-upgrade",
                    "ForcedApplyDate": "2019-01-18T03:01:00Z",
                    "AutoAppliedAfterDate": "2019-01-11T03:01:00Z"
                }
            ]
        }
    ]
}
```

Vous pouvez également renvoyer une liste de ressources pour un cluster en spécifiant le `--filters` paramètre de l'`describe-pending-maintenance-actions` AWS CLI opération. Le format de l'opération `--filters` est `Name=filter-name,Values=resource-id,...`.

`db-cluster-id`est la valeur acceptable pour le `Name` paramètre du filtre. Cette valeur accepte une liste d'identifiants de cluster ou ARNs. La liste renvoyée inclut uniquement les actions de maintenance en attente pour les clusters identifiés par ces identifiants ou ARNs.

L'exemple suivant renvoie les actions de maintenance en attente pour les clusters `sample-cluster1` et `sample-cluster2`.

**Example**  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-pending-maintenance-actions \
   --filters Name=db-cluster-id,Values=sample-cluster1,sample-cluster2
```
Pour Windows :  

```
aws docdb describe-pending-maintenance-actions ^
   --filters Name=db-cluster-id,Values=sample-cluster1,sample-cluster2
```

------

### Appliquer les dates
<a name="db-instance-updates-apply-date"></a>

Chaque action de maintenance a une date d'application que vous pouvez trouver lors de la description des actions de maintenance en attente. Lorsque vous lisez le résultat des actions de maintenance en attente à partir du AWS CLI, trois dates sont répertoriées. Ces valeurs de date indiquent `null` lorsque la maintenance est facultative. Les valeurs sont renseignées une fois que l'action de maintenance correspondante est planifiée ou appliquée.
+ **CurrentApplyDate**: date à laquelle l'action de maintenance sera appliquée soit immédiatement, soit lors de la fenêtre de maintenance suivante. 
+ **ForcedApplyDate**—La date à laquelle la maintenance sera automatiquement appliquée, indépendamment de votre fenêtre de maintenance.
+ **AutoAppliedAfterDate**: date après laquelle la maintenance sera appliquée pendant la fenêtre de maintenance du cluster.

## Mises à jour initiées par
<a name="user-initiated-updates"></a>

En tant qu'utilisateur d'Amazon DocumentDB, vous pouvez initier des mises à jour de vos clusters ou instances. Par exemple, vous pouvez modifier la classe d'une instance en une classe avec plus ou moins de mémoire, ou vous pouvez modifier le groupe de paramètres d'un cluster. Amazon DocumentDB considère ces modifications différemment des mises à jour initiées par Amazon DocumentDB. Pour plus d'informations sur la modification d'un cluster ou d'une instance, consultez ce qui suit :
+ [Modification d'un cluster Amazon DocumentDB](db-cluster-modify.md)
+ [Modification d'une instance Amazon DocumentDB](db-instance-modify.md)

Pour voir une liste des modifications en attente lancées par l'utilisateur, exécutez la commande suivante.

**Example**  
**Pour voir les modifications en attente lancées par l'utilisateur pour vos instances**  
Pour Linux, macOS ou Unix :  

```
aws docdb describe-db-instances \
    --query 'DBInstances[*].[DBClusterIdentifier,DBInstanceIdentifier,PendingModifiedValues]'
```
Pour Windows :  

```
aws docdb describe-db-instances ^
    --query 'DBInstances[*].[DBClusterIdentifier,DBInstanceIdentifier,PendingModifiedValues]'
```
La sortie de cette opération ressemble à ceci (format JSON).  
Dans ce cas, `sample-cluster-instance` a un changement en attente vers une classe d'instance `db.r5.xlarge`, alors que `sample-cluster-instance-2` n'a pas de changements en attente.  

```
[
    [
        "sample-cluster",
        "sample-cluster-instance",
        {
            "DBInstanceClass": "db.r5.xlarge"
        }
    ],
    [
        "sample-cluster",
        "sample-cluster-instance-2",
        {}
    ]
]
```

## Gestion de vos fenêtres de maintenance Amazon DocumentDB
<a name="maintenance-window"></a>

Chaque instance et chaque cluster est associé à un créneau de maintenance hebdomadaire au cours duquel toutes les modifications en attente sont appliquées. La fenêtre de maintenance est une occasion de contrôler le moment où les modifications et les correctifs logiciels ont lieu, qu'ils aient fait l'objet d'une demande ou qu'ils soient obligatoires. Si un événement de maintenance est planifié pour une semaine donnée, il est déclenché pendant le créneau de maintenance de 30 minutes que vous identifiez. La plupart des événements de maintenance se terminent également au cours du créneau de maintenance de 30 minutes, mais des événements de maintenance plus importants peuvent prendre plus de 30 minutes.

Ce créneau de maintenance de 30 minutes est sélectionné de manière aléatoire sur un bloc horaire de 8 heures par région. Si vous ne spécifiez pas de fenêtre de maintenance préférée lorsque vous créez l'instance ou le cluster, Amazon DocumentDB attribue une fenêtre de maintenance de 30 minutes un jour de la semaine sélectionné au hasard.

Le tableau suivant répertorie pour les différentes régions les blocs de temps à partir desquels les créneaux de maintenance par défaut sont alloués.


| Nom de la région | Région | Bloc horaire UTC | 
| --- | --- | --- | 
| USA Est (Ohio) | us-east-2 | 3 h 00-11 h 00 | 
| USA Est (Virginie du Nord) | us-east-1 | 3 h 00-11 h 00 | 
| USA Ouest (Oregon) | us-west-2 | 6 h 00-14 h 00 | 
| Afrique (Le Cap) | af-south-1 | 03 H 00 — 11 H 00 | 
| Asie-Pacifique (Hong Kong) | ap-east-1 | 6 h 00-14 h 00 | 
| Asie-Pacifique (Hyderabad) | ap-south-2 | 6 H 30 — 14 H 30 | 
| Asie-Pacifique (Malaisie) | ap-southeast-5 | 13 h 00-21 h 00 | 
| Asie-Pacifique (Mumbai) | ap-south-1 | 6 h 00-14 h 00 | 
| Asie-Pacifique (Osaka) | ap-northeast-3 | 12h00-20h00 | 
| Asie-Pacifique (Séoul) | ap-northeast-2 | 13 h 00-21 h 00 | 
| Asie-Pacifique (Singapour) | ap-southeast-1 | 14h00-22h00 | 
| Asie-Pacifique (Sydney) | ap-southeast-2 | 12h00-20h00 | 
| Asie-Pacifique (Jakarta) | ap-southeast-3 | 08h00-16h00 | 
| Asie-Pacifique (Melbourne) | ap-southeast-4 | 11:00-19:00 | 
| Asie-Pacifique (Thaïlande) | ap-southeast-7 | 15h00-23h00 | 
| Asie-Pacifique (Tokyo) | ap-northeast-1 | 13 h 00-21 h 00 | 
| Canada (Centre) | ca-central-1 | 3 h 00-11 h 00 | 
| Chine (Beijing) | cn-north-1 | 6 h 00-14 h 00 | 
| Chine (Ningxia) | cn-northwest-1 | 6 h 00-14 h 00 | 
| Europe (Francfort) | eu-central-1 | 21 h 00 - 5 h 00 | 
| Europe (Zurich) | eu-central-2 | 02h00-10h00 | 
| Europe (Irlande) | eu-west-1 | 22 h 00-6 h 00 | 
| Europe (Londres) | eu-west-2 | 22 h 00-6 h 00 | 
| Europe (Milan) | eu-south-1 | 02h00-10h00 | 
| Europe (Paris) | eu-west-3 | 23:59-07:29 | 
| Europe (Espagne) | eu-south-2 | 02H00 — 10H00 | 
| Europe (Stockholm) | eu-north-1 | 04 H 00 — 12 H 00 | 
| Mexique (Centre) | mx-central-1 | 3 h 00-11 h 00 | 
| Moyen-Orient (EAU) | me-central-1 | 05 H 00 — 13 H 00 | 
| Amérique du Sud (São Paulo) | sa-east-1 | 00:00-08:00 | 
| Israël (Tel Aviv) | il-central-1 | 04h00-12h00 | 
| AWS GovCloud (USA Est) | us-gov-east-1 | 17:00-01:00 | 
| AWS GovCloud (US-Ouest) | us-gov-west-1 | 6 h 00-14 h 00 | 

### Modification de vos fenêtres de maintenance Amazon DocumentDB
<a name="maintenance-windows"></a>

Le créneau de maintenance doit intervenir au moment où l'utilisation est la plus faible, il peut donc s'avérer nécessaire de le modifier de temps en temps. Votre cluster ou instance est indisponible pendant cette période uniquement si des modifications système (telles qu'une opération de stockage évolutif ou un changement de classe d'instance) sont appliquées et nécessitent une interruption de service. Ensuite, il n'est pas disponible uniquement pendant le délai minimum requis pour apporter les modifications nécessaires.

Pour les mises à niveau du moteur de base de données, Amazon DocumentDB utilise la fenêtre de maintenance préférée du cluster et non la fenêtre de maintenance pour les instances individuelles.

**Pour modifier la fenêtre de maintenance**
+ Pour un cluster, veuillez consulter [Modification d'un cluster Amazon DocumentDB](db-cluster-modify.md).
+ Pour une instance, veuillez consulter [Modification d'une instance Amazon DocumentDB](db-instance-modify.md).

## Mises à jour du système d'exploitation Amazon DocumentDB
<a name="os-system-updates"></a>

Les instances des clusters Amazon DocumentDB nécessitent parfois des mises à jour du système d'exploitation. Amazon DocumentDB met à niveau le système d'exploitation vers une version plus récente afin d'améliorer les performances de la base de données et le niveau de sécurité global des clients. Les mises à jour du système d'exploitation ne modifient pas la version du moteur de cluster ni la classe d'instance d'une instance Amazon DocumentDB.

Nous vous recommandons de mettre à jour d'abord les instances du lecteur dans un cluster, puis l'instance du rédacteur afin d'optimiser la disponibilité de votre cluster. Nous ne recommandons pas de mettre à jour les instances du lecteur et du rédacteur en même temps, car vous risquez de subir des temps d'arrêt plus longs en cas de basculement.

La plupart des mises à jour du système d'exploitation pour Amazon DocumentDB sont facultatives et ne sont pas soumises à une date précise pour leur application. Toutefois, si vous n'appliquez pas ces mises à jour pendant un certain temps, elles peuvent éventuellement devenir nécessaires et appliquées automatiquement pendant la période de maintenance de votre instance. Cela permet de maintenir le niveau de sécurité de votre base de données. Pour éviter toute interruption imprévue, nous vous recommandons d'appliquer les mises à jour du système d'exploitation à vos instances Amazon DocumentDB dès qu'elles sont disponibles et de définir le créneau de maintenance de votre instance au moment qui vous convient, en fonction des besoins de votre entreprise. 

Pour être averti de la disponibilité d'une nouvelle mise à jour facultative, vous pouvez vous inscrire à RDS-EVENT-0230 dans la catégorie des événements d'application de correctifs de sécurité. Pour plus d'informations sur l'abonnement aux événements Amazon DocumentDB, [consultez la section Abonnement aux événements Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-subscriptions.subscribe.html).

Si votre instance est une instance principale, attendez-vous à un basculement de cette dernière lors d'une maintenance sur votre cluster ou votre instance. Pour améliorer votre disponibilité, nous vous recommandons d'utiliser plusieurs instances pour vos clusters Amazon DocumentDB. Pour de plus amples informations, veuillez consulter [Basculement d'Amazon DocumentDB](failover.md).

**Note**  
Pour certaines fonctionnalités de gestion, Amazon DocumentDB utilise une technologie opérationnelle partagée avec Amazon Relational Database Service (Amazon RDS).

**Important**  
Votre instance Amazon DocumentDB sera mise hors ligne lors de la mise à niveau du système d'exploitation. Vous pouvez minimiser les temps d'arrêt du cluster en utilisant un cluster multi-instances. Si vous ne possédez pas de cluster multi-instances, vous pouvez choisir d'en créer un temporairement en ajoutant des instances secondaires pour effectuer cette maintenance, puis en supprimant les instances de lecteur supplémentaires une fois la maintenance terminée (les frais habituels pour l'instance secondaire s'appliqueront). 

**Note**  
Vous devrez peut-être appliquer toutes les mises à jour facultatives et obligatoires afin de respecter diverses obligations de conformité. Nous vous recommandons d'appliquer régulièrement toutes les mises à jour mises à disposition par Amazon DocumentDB pendant vos fenêtres de maintenance.

Vous pouvez utiliser le AWS Management Console ou le AWS CLI pour déterminer si une mise à jour est disponible.

------
#### [ Using the AWS Management Console ]

Pour déterminer si une mise à jour est disponible à l'aide de AWS Management Console :

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

1. Dans le volet de navigation, choisissez **Clusters**, puis sélectionnez l'instance.

1. Choisissez **Maintenance**.

1. Dans la section **Maintenance en attente**, recherchez la mise à jour du système d'exploitation.

![\[La console Amazon DocumentDB affiche la colonne Maintenance pour les clusters.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/maintenance-available-1.png)


Vous pouvez sélectionner la mise à jour du système d'exploitation et cliquer sur **Appliquer maintenant** ou sur **Appliquer à la fenêtre de maintenance suivante** dans la section **Maintenance en attente**. Si la valeur de maintenance correspond à la **fenêtre suivante**, reportez les éléments de maintenance en choisissant **Différer** la mise à niveau. Vous ne pouvez pas reporter une action de maintenance en cours.

Vous pouvez également choisir l'instance dans une liste de clusters en cliquant sur **Clusters** dans le volet de navigation et en sélectionnant **Appliquer maintenant** ou **Appliquer à la prochaine fenêtre de maintenance** dans le menu **Actions**. 

------
#### [ Using the AWS CLI ]

Pour déterminer si une mise à jour est disponible à l'aide du AWS CLI, appelez la `describe-pending-maintenance-actions` commande suivante :

```
aws docdb describe-pending-maintenance-actions
```

```
{
  "ResourceIdentifier": "arn:aws:docdb:us-east-1:123456789012:db:mydb2",
  "PendingMaintenanceActionDetails": [
    {
      "Action": "system-update",
      "Description": "New Operating System update is available"
    }
  ]
}
```

------

Les mises à jour du système d'exploitation sont spécifiques aux versions du moteur Amazon DocumentDB et aux classes d'instances. Par conséquent, les instances Amazon DocumentDB reçoivent ou nécessitent des mises à jour à des moments différents. Lorsqu'une mise à jour du système d'exploitation est disponible pour votre instance en fonction de la version du moteur et de la classe d'instance, la mise à jour apparaît dans la console. Il peut également être consulté en exécutant la AWS CLI `describe-pending-maintenance-actions` commande ou en appelant l'opération `DescribePendingMaintenanceActions` API.

Si vous n'utilisez pas la dernière version du correctif de cluster de votre moteur Amazon DocumentDB, il est possible que la mise à jour du système d'exploitation ne figure pas dans la liste des maintenances disponibles. Pour visualiser et gérer la mise à jour du système d'exploitation, vous devez d'abord effectuer une mise à niveau vers la dernière version du correctif du moteur.

# Comprendre les rôles liés aux services
<a name="service-linked-roles"></a>

Amazon DocumentDB (compatible avec MongoDB) utilise des rôles liés à un service Gestion des identités et des accès AWS (IAM). Un [rôle lié à un service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role) est un type unique de rôle IAM directement lié à Amazon DocumentDB. Les rôles liés à un service sont prédéfinis par Amazon DocumentDB et incluent toutes les autorisations dont le service a besoin pour appeler AWS d'autres services en votre nom.

Un rôle lié à un service facilite l'utilisation d'Amazon DocumentDB, car vous n'avez pas à ajouter manuellement les autorisations nécessaires. Amazon DocumentDB définit les autorisations associées à ses rôles liés aux services et, sauf indication contraire, seul Amazon DocumentDB peut assumer ses rôles. Les autorisations définies comprennent la politique d’approbation et la politique d’autorisation. De plus, cette politique d’autorisation ne peut pas être attachée à une autre entité IAM.

Vous pouvez supprimer les rôles uniquement après la suppression préalable de leurs ressources connexes. Cela protège vos ressources Amazon DocumentDB car vous ne pouvez pas supprimer par inadvertance l'autorisation d'accès aux ressources.

Pour plus d’informations sur les autres services qui prennent en charge les rôles liés à un service, consultez [Services AWS qui fonctionnent avec IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) et recherchez les services avec un **Oui ** dans la colonne **Rôle lié à un service**. Choisissez un **Oui** ayant un lien permettant de consulter les détails du rôle pour ce service.

## Autorisations de rôle liées au service Amazon DocumentDB
<a name="service-linked-role-permissions"></a>

Amazon DocumentDB (compatible avec MongoDB) utilise le rôle lié à un service nommé RDS **AWSServiceRoleForpour permettre à** Amazon DocumentDB d'appeler des services au nom de vos clusters. AWS 

Le rôle lié à un service AWSService RoleFor RDS fait confiance aux services suivants pour assumer le rôle :
+ `docdb.amazonaws.com`

La politique d'autorisation des rôles permet à Amazon DocumentDB d'effectuer les actions suivantes sur les ressources spécifiées :
+ Actions sur `ec2` :
  + `AssignPrivateIpAddresses`
  + `AuthorizeSecurityGroupIngress`
  + `CreateNetworkInterface`
  + `CreateSecurityGroup`
  + `DeleteNetworkInterface`
  + `DeleteSecurityGroup`
  + `DescribeAvailabilityZones`
  + `DescribeInternetGateways`
  + `DescribeSecurityGroups`
  + `DescribeSubnets`
  + `DescribeVpcAttribute`
  + `DescribeVpcs`
  + `ModifyNetworkInterfaceAttribute`
  + `RevokeSecurityGroupIngress`
  + `UnassignPrivateIpAddresses`
+ Actions sur `sns` :
  + `ListTopic`
  + `Publish`
+ Actions sur `cloudwatch` :
  + `PutMetricData`
  + `GetMetricData`
  + `CreateLogStream`
  + `PullLogEvents`
  + `DescribeLogStreams`
  + `CreateLogGroup`

**Note**  
Vous devez configurer les autorisations de manière à permettre à une entité IAM (comme un utilisateur, un groupe ou un rôle) de créer, modifier ou supprimer un rôle lié à un service. Il se peut que vous rencontriez le message d'erreur suivant :  
**Impossible de créer la ressource. Vérifiez que vous détenez l’autorisation de créer un rôle lié au service. Dans le cas contraire, attendez et réessayez ultérieurement.**  
Si vous voyez cette erreur, vérifiez que vous avez respecté les autorisations activées suivantes :  

```
{
    "Action": "iam:CreateServiceLinkedRole",
    "Effect": "Allow",
    "Resource": "arn:aws:iam::*:role/aws-service-role/rds.amazonaws.com/AWSServiceRoleForRDS",
    "Condition": {
        "StringLike": {
            "iam:AWSServiceName":"rds.amazonaws.com"
        }
    }
}
```

Pour en savoir plus, consultez [Service-Linked Role Permissions (autorisations du rôle lié à un service)](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#service-linked-role-permissions) dans le *Guide de l’utilisateur IAM*.

## Création d'un rôle lié à un service Amazon DocumentDB
<a name="service-linked-roles-create"></a>

Vous n’avez pas besoin de créer manuellement un rôle lié à un service. Lorsque vous créez un cluster, Amazon DocumentDB crée le rôle lié à un service pour vous. 

Si vous supprimez ce rôle lié à un service et que vous devez ensuite le recréer, vous pouvez utiliser la même procédure pour recréer le rôle dans votre compte. Lorsque vous créez un cluster, Amazon DocumentDB crée à nouveau le rôle lié à un service pour vous. 

## Modification d'un rôle lié à un service Amazon DocumentDB
<a name="service-linked-roles-edit"></a>

Amazon DocumentDB ne vous permet pas de modifier le rôle lié au service AWSService RoleFor RDS. Après avoir créé un rôle lié à un service, vous ne pouvez pas changer le nom du rôle, car plusieurs entités peuvent faire référence à ce rôle. Vous pouvez toutefois modifier la description du rôle à l'aide d'IAM. Pour en savoir plus, consultez [Modification d’un rôle lié à un service](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#edit-service-linked-role) dans le *Guide de l’utilisateur IAM*.

## Suppression d'un rôle lié à un service Amazon DocumentDB
<a name="service-linked-roles-delete"></a>

Si vous n’avez plus besoin d’utiliser une fonctionnalité ou un service qui nécessite un rôle lié à un service, nous vous recommandons de supprimer ce rôle. De cette façon, vous n’avez aucune entité inutilisée qui n’est pas surveillée ou gérée activement. Cependant, vous devez supprimer tous les clusters avant de pouvoir supprimer le rôle lié à un service.

### Nettoyage d'un rôle lié à un service Amazon DocumentDB
<a name="service-linked-roles-clean-up"></a>

Avant de pouvoir utiliser IAM pour supprimer un rôle lié à un service, vous devez d’abord vérifier qu’aucune session n’est active pour le rôle et supprimer toutes les ressources utilisées par le rôle.

**Pour vérifier si une session est active pour le rôle lié à un service dans la console**

1. Connectez-vous à la console IAM AWS Management Console et ouvrez-la à [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) l'adresse.

1. Dans le volet de navigation de la console IAM, choisissez **Rôles**, puis choisissez le nom (et non la case à cocher) du rôle **AWSServiceRoleForRDS.**

1. Sur la page **Récapitulatif** du rôle sélectionné, choisissez l'onglet **Access Advisor**.

1. Dans l'onglet **Access Advisor**, consultez l'activité récente pour le rôle lié à un service.
**Note**  
Si vous ne savez pas si Amazon DocumentDB utilise le rôle AWSService RoleFor RDS, vous pouvez essayer de le supprimer. Si le service utilise le rôle, la suppression échoue et vous avez accès aux régions dans lesquelles le rôle est utilisé. Si le rôle est utilisé, vous devez attendre que la session se termine avant de pouvoir le supprimer. Vous ne pouvez pas révoquer la session d’un rôle lié à un service. 

Si vous souhaitez supprimer le rôle AWSService RoleFor RDS, vous devez d'abord supprimer *toutes* vos instances et clusters. Pour plus d'informations sur la suppression des instances et des clusters, consultez les rubriques suivantes :
+ [Suppression d'une instance Amazon DocumentDB](db-instance-delete.md)
+ [Suppression d'un cluster Amazon DocumentDB](db-cluster-delete.md)

## Régions prises en charge pour les rôles liés à un service Amazon DocumentDB
<a name="slr-regions"></a>

Amazon DocumentDB prend en charge l'utilisation de rôles liés à un service dans toutes les régions où le service est disponible. Pour de plus amples informations, veuillez consulter [https://docs.aws.amazon.com/documentdb/latest/developerguide/regions-and-azs.html#regions-and-azs-availability](https://docs.aws.amazon.com/documentdb/latest/developerguide/regions-and-azs.html#regions-and-azs-availability).

 

# Utilisation de flux de modifications avec Amazon DocumentDB
<a name="change_streams"></a>

La fonctionnalité de flux de modifications d'Amazon DocumentDB (compatible avec MongoDB) fournit une séquence chronologique des événements de modification qui se produisent dans les collections de votre cluster. Vous pouvez lire des événements à partir d'un flux de modifications afin d'implémenter de nombreux cas d'utilisation différents, notamment les suivants :
+ Notification de modification
+ Recherche en texte intégral avec Amazon OpenSearch Service (OpenSearch Service)
+ Analyses avec Amazon Redshift

Les applications peuvent utiliser les flux de modifications pour souscrire à tous les changements de données dans des collections individuelles. Les événements de flux de modifications sont ordonnés au fur et à mesure qu'ils se produisent sur le cluster et sont stockés pendant trois heures (par défaut) après l'enregistrement de l'événement. La période de conservation peut être prolongée jusqu'à 7 jours en utilisant le `change_stream_log_retention_duration` paramètre. Pour modifier la période de conservation du flux de modifications, consultez la section [Modification de la durée de conservation du journal du flux de modifications](https://docs.aws.amazon.com/documentdb/latest/developerguide/change_streams.html#change_streams-modifying_log_retention).

**Topics**
+ [Opérations prises en charge](#change_streams-supported_ops)
+ [Facturation](#change_streams-billing)
+ [Limitations](#change_streams-limitations)
+ [Activer les flux de changement](#change_streams-enabling)
+ [Exemple : utilisation de flux de modifications avec Python](#change_streams-using_example)
+ [Recherche de documents complets](#change_streams-lookup)
+ [Reprise d'un flux de modifications](#change_streams-resuming)
+ [Reprise d'un flux de modifications avec `startAtOperationTime`](#change_streams-startAtOperation)
+ [Reprise d'un flux de modifications avec `postBatchResumeToken`](#change_streams-postBatchResumeToken)
+ [Transactions dans les flux de changement](#change_streams-transactions)
+ [Modification de la durée de conservation du journal du flux de modifications](#change_streams-modifying_log_retention)
+ [Utilisation des flux de modifications sur les instances secondaires](#change-streams-secondary-instances)

## Opérations prises en charge
<a name="change_streams-supported_ops"></a>

Amazon DocumentDB prend en charge les opérations suivantes pour les flux de modifications :
+ Tous les événements de modification sont pris en charge dans MongoDB `db.watch()` et `client.watch()` dans `db.collection.watch()` l'API.
+ Recherche complète de documents pour les mises à jour.
+ Étapes d'agrégation : `$match` `$project``$redact`,, `$addFields` et`$replaceRoot`.
+ Reprise d'un flux de modifications à partir d'un jeton de CV
+ Reprise d'un flux de modifications à partir d'un horodatage en utilisant `startAtOperation` (applicable à Amazon DocumentDB 4.0\$1)

## Facturation
<a name="change_streams-billing"></a>

La fonctionnalité des flux de modifications d'Amazon DocumentDB est désactivée par défaut et n'entraîne aucun frais supplémentaire tant qu'elle n'est pas activée. L'utilisation de flux de modifications dans un cluster entraîne des coûts de lecture, d'écriture IOs et de stockage supplémentaires. Vous pouvez utiliser l'opération `modifyChangeStreams` API pour activer cette fonctionnalité pour votre cluster. Pour plus d'informations sur la tarification, consultez la tarification [d'Amazon DocumentDB.](https://aws.amazon.com/documentdb/pricing/) 

## Limitations
<a name="change_streams-limitations"></a>

Les flux de modifications présentent les limites suivantes dans Amazon DocumentDB :
+ Sur Amazon DocumentDB 3.6 et Amazon DocumentDB 4.0, les flux de modifications ne peuvent être ouverts qu'à partir d'une connexion à l'instance principale d'un cluster Amazon DocumentDB. La lecture à partir de flux de modifications sur une instance de réplique n'est pas prise en charge sur Amazon DocumentDB 3.6 et Amazon DocumentDB 4.0. Lorsque vous appelez l'opération d'API `watch()`, vous devez spécifier une préférence de lecture `primary` pour vous assurer que toutes les lectures sont dirigées vers l'instance principale (veuillez consulter la section [Exemple](#change_streams-using_example)). 
+ Sur Amazon DocumentDB 5.0, les flux de modifications peuvent être ouverts à la fois depuis l'instance principale et les instances secondaires, y compris les clusters globaux. Vous pouvez spécifier une préférence de lecture secondaire pour rediriger les flux de modifications vers des instances secondaires. Consultez [Utilisation des flux de modifications sur les instances secondaires](#change-streams-secondary-instances) les meilleures pratiques et les limites supplémentaires.
+ Les événements écrits dans un flux de modifications pour une collection sont disponibles pendant 7 jours maximum (la valeur par défaut est de 3 heures). Les données du flux de modifications sont supprimées après la fenêtre de durée de conservation du journal, même si aucune nouvelle modification n'est survenue. 
+ Une opération d'écriture longue en cours d'exécution sur une collection comme `updateMany` ou `deleteMany` peut bloquer temporairement l'écriture des événements de flux de modifications jusqu'à ce que l'opération d'écriture longue en cours d'exécution soit terminée.
+ Amazon DocumentDB ne prend pas en charge le journal des opérations MongoDB (). `oplog`
+ Avec Amazon DocumentDB, vous devez activer explicitement les flux de modifications sur une collection donnée.
+ Si la taille totale d'un événement de flux de modifications (y compris les données de modification et le document complet, le cas échéant) est supérieure à `16 MB`, le client rencontre un échec de lecture sur les flux de modification.
+ Le pilote Ruby n'est actuellement pas pris en charge lors de l'utilisation `db.watch()` et `client.watch()` avec Amazon DocumentDB 3.6.
+ La sortie de la `updateDescription` commande dans les flux de modification est différente dans Amazon DocumentDB par rapport à MongoDB lorsque la valeur mise à jour du champ est identique à la valeur précédente :
  + Amazon DocumentDB ne renvoie aucun champ dans la `updateDescription` sortie si le champ fourni est spécifié dans la `$set` commande et que sa valeur cible est déjà égale à la valeur source.
  + MongoDB renvoie le champ dans la sortie, même si la valeur spécifiée est égale à la valeur actuelle.

## Activer les flux de changement
<a name="change_streams-enabling"></a>

Vous pouvez activer les flux de modifications Amazon DocumentDB pour toutes les collections d'une base de données donnée, ou uniquement pour certaines collections. Voici des exemples de la façon d'activer les flux de changement pour différents cas d'utilisation en utilisant le shell mongo. Les chaînes vides sont traitées comme des caractères génériques lors de la spécification des noms de base de données et de collections.

```
//Enable change streams for the collection "foo" in database "bar"
db.adminCommand({modifyChangeStreams: 1,
    database: "bar",
    collection: "foo", 
    enable: true});
```

```
//Disable change streams on collection "foo" in database "bar"
db.adminCommand({modifyChangeStreams: 1,
    database: "bar",
    collection: "foo", 
    enable: false});
```

```
//Enable change streams for all collections in database "bar"
db.adminCommand({modifyChangeStreams: 1,
    database: "bar",
    collection: "", 
    enable: true});
```

```
//Enable change streams for all collections in all databases in a cluster
db.adminCommand({modifyChangeStreams: 1,
    database: "",
    collection: "", 
    enable: true});
```

Les flux de modifications seront activés pour une collection si l'un des éléments suivants est vrai :
+ La base de données et la collection sont explicitement activées.
+ La base de données contenant la collection est activée. 
+ Toutes les bases de données sont activées.

Le fait de supprimer une collection d'une base de données ne désactive pas les flux de modification pour cette collection si la base de données parent a également activé les flux de modification ou si toutes les bases de données du cluster sont activées. Si une nouvelle collection est créée avec le même nom que la collection supprimée, les flux de modifications seront activés pour cette collection.

Vous pouvez répertorier tous les flux de modifications activés de votre cluster à l'aide de l'étape du pipeline d'agrégation `$listChangeStreams`. Toutes les étapes d'agrégation prises en charge par Amazon DocumentDB peuvent être utilisées dans le pipeline pour un traitement supplémentaire. Si une collection précédemment activée a été désactivée, elle n'apparaît pas dans la sortie `$listChangeStreams`.

```
//List all databases and collections with change streams enabled
cursor = new DBCommandCursor(db,
    db.runCommand(
        {aggregate: 1,
        pipeline: [{$listChangeStreams: 1}], 
        cursor:{}}));
```

```
//List of all databases and collections with change streams enabled 
{ "database" : "test", "collection" : "foo" } 
{ "database" : "bar", "collection" : "" }
{ "database" : "", "collection" : "" }
```

```
//Determine if the database “bar” or collection “bar.foo” have change streams enabled
cursor = new DBCommandCursor(db,
  db.runCommand(
      {aggregate: 1,
       pipeline: [{$listChangeStreams: 1},
                  {$match: {$or: [{database: "bar", collection: "foo"},
                                  {database: "bar", collection: ""},
                                  {database: "", collection: ""}]}}
                 ],
      cursor:{}}));
```

## Exemple : utilisation de flux de modifications avec Python
<a name="change_streams-using_example"></a>

Voici un exemple d'utilisation d'un flux de modifications Amazon DocumentDB avec Python au niveau de la collection.

```
import os
import sys
from pymongo import MongoClient, ReadPreference
      
username = "DocumentDBusername"
password = <Insert your password> 

clusterendpoint = "DocumentDBClusterEndpoint”
client = MongoClient(clusterendpoint, username=username, password=password, tls='true', tlsCAFile='global-bundle.pem')

db = client['bar']
 
#While ‘Primary’ is the default read preference, here we give an example of
#how to specify the required read preference when reading the change streams
coll = db.get_collection('foo', read_preference=ReadPreference.PRIMARY)
#Create a stream object
stream = coll.watch()
#Write a new document to the collection to generate a change event
coll.insert_one({'x': 1})
#Read the next change event from the stream (if any)
print(stream.try_next())

"""
Expected Output:
{'_id': {'_data': '015daf94f600000002010000000200009025'},
'clusterTime': Timestamp(1571788022, 2),
'documentKey': {'_id': ObjectId('5daf94f6ea258751778163d6')},
'fullDocument': {'_id': ObjectId('5daf94f6ea258751778163d6'), 'x': 1},
'ns': {'coll': 'foo', 'db': 'bar'},
'operationType': 'insert'}
"""

#A subsequent attempt to read the next change event returns nothing, as there are no new changes
print(stream.try_next())

"""
Expected Output:
None
""" 
 
#Generate a new change event by updating a document
result = coll.update_one({'x': 1}, {'$set': {'x': 2}})
print(stream.try_next())

"""
Expected Output:
{'_id': {'_data': '015daf99d400000001010000000100009025'},
'clusterTime': Timestamp(1571789268, 1),
'documentKey': {'_id': ObjectId('5daf9502ea258751778163d7')},
'ns': {'coll': 'foo', 'db': 'bar'},
'operationType': 'update',
'updateDescription': {'removedFields': [], 'updatedFields': {'x': 2}}}
"""
```

Voici un exemple d'utilisation d'un flux de modifications Amazon DocumentDB avec Python au niveau de la base de données. 

```
import os
import sys
from pymongo import MongoClient

username = "DocumentDBusername"
password = <Insert your password>
clusterendpoint = "DocumentDBClusterEndpoint”
client = MongoClient(clusterendpoint, username=username, password=password, tls='true', tlsCAFile='global-bundle.pem')

db = client['bar']
#Create a stream object
stream = db.watch()
coll = db.get_collection('foo')
#Write a new document to the collection foo to generate a change event
coll.insert_one({'x': 1})
 
#Read the next change event from the stream (if any)
print(stream.try_next())

"""
Expected Output:
{'_id': {'_data': '015daf94f600000002010000000200009025'},
'clusterTime': Timestamp(1571788022, 2),
'documentKey': {'_id': ObjectId('5daf94f6ea258751778163d6')},
'fullDocument': {'_id': ObjectId('5daf94f6ea258751778163d6'), 'x': 1},
'ns': {'coll': 'foo', 'db': 'bar'},
'operationType': 'insert'}
"""
#A subsequent attempt to read the next change event returns nothing, as there are no new changes
print(stream.try_next())

"""
Expected Output:
None
""" 
 
coll = db.get_collection('foo1')

#Write a new document to another collection to generate a change event
coll.insert_one({'x': 1})
print(stream.try_next())

"""
Expected Output: Since the change stream cursor was the database level you can see change events from different collections in the same database
{'_id': {'_data': '015daf94f600000002010000000200009025'},
'clusterTime': Timestamp(1571788022, 2),
'documentKey': {'_id': ObjectId('5daf94f6ea258751778163d6')},
'fullDocument': {'_id': ObjectId('5daf94f6ea258751778163d6'), 'x': 1},
'ns': {'coll': 'foo1', 'db': 'bar'},
'operationType': 'insert'}
"""
```

## Recherche de documents complets
<a name="change_streams-lookup"></a>

L'événement de modification de mise à jour n'inclut pas le document complet, mais uniquement la modification qui a été effectuée. Si votre cas d'utilisation nécessite le document complet affecté par une mise à jour, vous pouvez activer la recherche complète de documents lors de l'ouverture du flux. 

Le document `fullDocument` d'un événement de flux de modification de mise à jour représente la version la plus récente du document mis à jour au moment de la recherche de document. Si des modifications se sont produites entre l'opération de mise à jour et la recherche `fullDocument`, le document `fullDocument` peut ne pas représenter l'état du document au moment de la mise à jour.

Pour créer un objet de flux avec la recherche de mise à jour activée, utilisez cet exemple :

```
stream = coll.watch(full_document='updateLookup')
 
#Generate a new change event by updating a document
result = coll.update_one({'x': 2}, {'$set': {'x': 3}})

stream.try_next()
```

La sortie de l'objet stream ressemblera à ceci :

```
{'_id': {'_data': '015daf9b7c00000001010000000100009025'},
'clusterTime': Timestamp(1571789692, 1),
'documentKey': {'_id': ObjectId('5daf9502ea258751778163d7')},
'fullDocument': {'_id': ObjectId('5daf9502ea258751778163d7'), 'x': 3},
'ns': {'coll': 'foo', 'db': 'bar'},
'operationType': 'update',
'updateDescription': {'removedFields': [], 'updatedFields': {'x': 3}}}
```

## Reprise d'un flux de modifications
<a name="change_streams-resuming"></a>

Vous pouvez reprendre un flux de modifications ultérieurement à l'aide d'un jeton de reprise, qui est égal au champ `_id`du dernier document d'événement de modification récupéré.

```
import os
import sys
from pymongo import MongoClient

username = "DocumentDBusername"
password = <Insert your password> 
clusterendpoint = "DocumentDBClusterEndpoint”
client = MongoClient(clusterendpoint, username=username, password=password, tls='true', tlsCAFile='global-bundle.pem', retryWrites='false')

db = client['bar']
coll = db.get_collection('foo')
#Create a stream object
stream = db.watch()
coll.update_one({'x': 1}, {'$set': {'x': 4}})
event = stream.try_next()
token = event['_id']
print(token)

"""
Output: This is the resume token that we will later us to resume the change stream
{'_data': '015daf9c5b00000001010000000100009025'}
"""
#Python provides a nice shortcut for getting a stream’s resume token
print(stream.resume_token)

"""
Output
{'_data': '015daf9c5b00000001010000000100009025'}
"""
#Generate a new change event by updating a document
result = coll.update_one({'x': 4}, {'$set': {'x': 5}})
#Generate another change event by inserting a document
result = coll.insert_one({'y': 5})
#Open a stream starting after the selected resume token
stream = db.watch(full_document='updateLookup', resume_after=token)
#Our first change event is the update with the specified _id
print(stream.try_next())

"""
#Output: Since we are resuming the change stream from the resume token, we will see all events after the first update operation. In our case, the change stream will resume from the update operation {x:5}

{'_id': {'_data': '015f7e8f0c000000060100000006000fe038'}, 
'operationType': 'update', 
'clusterTime': Timestamp(1602129676, 6), 
'ns': {'db': 'bar', 'coll': 'foo'}, 
'documentKey': {'_id': ObjectId('5f7e8f0ac423bafbfd9adba2')}, 
'fullDocument': {'_id': ObjectId('5f7e8f0ac423bafbfd9adba2'), 'x': 5}, 
'updateDescription': {'updatedFields': {'x': 5}, 'removedFields': []}}
"""
#Followed by the insert
print(stream.try_next())

"""
#Output:
{'_id': {'_data': '015f7e8f0c000000070100000007000fe038'}, 
'operationType': 'insert', 
'clusterTime': Timestamp(1602129676, 7), 
'ns': {'db': 'bar', 'coll': 'foo'}, 
'documentKey': {'_id': ObjectId('5f7e8f0cbf8c233ed577eb94')}, 
'fullDocument': {'_id': ObjectId('5f7e8f0cbf8c233ed577eb94'), 'y': 5}}
"""
```

## Reprise d'un flux de modifications avec `startAtOperationTime`
<a name="change_streams-startAtOperation"></a>

Vous pouvez reprendre un flux de modifications ultérieurement à partir d'un horodatage spécifique en utilisant`startAtOperationTime`.

**Note**  
La possibilité d'utilisation `startAtOperationTime` est disponible dans Amazon DocumentDB 4.0\$1. Lors de son utilisation`startAtOperationTime`, le curseur du flux de modifications renvoie uniquement les modifications survenues à ou après l'horodatage spécifié. Les `resumeAfter` commandes `startAtOperationTime` et s'excluent mutuellement et ne peuvent donc pas être utilisées ensemble.

```
import os
import sys
from pymongo import MongoClient

username = "DocumentDBusername"
password = <Insert your password> 
clusterendpoint = "DocumentDBClusterEndpoint”
client = MongoClient(clusterendpoint, username=username, password=password, tls='true', tlsCAFile='rds-root-ca-2020.pem',retryWrites='false')
db = client['bar']
coll = db.get_collection('foo')
#Create a stream object
stream = db.watch()
coll.update_one({'x': 1}, {'$set': {'x': 4}})
event = stream.try_next()
timestamp = event['clusterTime']
print(timestamp)
"""
Output
Timestamp(1602129114, 4)
"""
#Generate a new change event by updating a document
result = coll.update_one({'x': 4}, {'$set': {'x': 5}})
result = coll.insert_one({'y': 5})
#Generate another change event by inserting a document
#Open a stream starting after specified time stamp

stream = db.watch(start_at_operation_time=timestamp)
print(stream.try_next())

"""
#Output: Since we are resuming the change stream at the time stamp of our first update operation (x:4), the change stream cursor will point to that event
{'_id': {'_data': '015f7e941a000000030100000003000fe038'}, 
'operationType': 'update', 
'clusterTime': Timestamp(1602130970, 3), 
'ns': {'db': 'bar', 'coll': 'foo'}, 
'documentKey': {'_id': ObjectId('5f7e9417c423bafbfd9adbb1')}, 
'updateDescription': {'updatedFields': {'x': 4}, 'removedFields': []}}
"""

print(stream.try_next())
"""
#Output: The second event will be the subsequent update operation (x:5)
{'_id': {'_data': '015f7e9502000000050100000005000fe038'}, 
'operationType': 'update', 
'clusterTime': Timestamp(1602131202, 5),
'ns': {'db': 'bar', 'coll': 'foo'}, 
'documentKey': {'_id': ObjectId('5f7e94ffc423bafbfd9adbb2')}, 
'updateDescription': {'updatedFields': {'x': 5}, 'removedFields': []}}
"""

print(stream.try_next())

"""
#Output: And finally the last event will be the insert operation (y:5)
{'_id': {'_data': '015f7e9502000000060100000006000fe038'}, 
'operationType': 'insert', 
'clusterTime': Timestamp(1602131202, 6), 
'ns': {'db': 'bar', 'coll': 'foo'}, 
'documentKey': {'_id': ObjectId('5f7e95025c4a569e0f6dde92')}, 
'fullDocument': {'_id': ObjectId('5f7e95025c4a569e0f6dde92'), 'y': 5}}
"""
```

## Reprise d'un flux de modifications avec `postBatchResumeToken`
<a name="change_streams-postBatchResumeToken"></a>

Le flux de modifications Amazon DocumentDB renvoie désormais un champ supplémentaire appelé. `postBatchResumeToken` Ce champ est renvoyé par la `$changestream` commande et la `getMore` commande.

Exemple de `$changestream` commande en Python :

```
db.command({"aggregate": "sales", "pipeline": [{ "$changeStream": {}}], "cursor": {"batchSize": 1}})
```

Sortie attendue :

```
cursor" : {
   "firstBatch" : [ ],
   "postBatchResumeToken" : {"_data" : "0167c8cbe60000000004"},
   "id" : NumberLong("9660788144470"),
   "ns" : "test.sales"
}
```

Exemple de `getMore` commande en Python :

```
db.command({"getMore": NumberLong(<cursor id>), "collection": "sales", "batchSize": 1 })
```

Sortie attendue

```
cursor" : {
   "nextBatch" : [ ],
   "postBatchResumeToken" : {"_data" : "0167c8cbe60000000004"},
   "id" : NumberLong("9660788144470"),
   "ns" : "test.sales"
}
```

Le `postBatchResumeToken` champ peut être utilisé pour ouvrir de nouveaux curseurs de flux de modifications dans le `resumeAfter` champ, de la même manière que le jeton de CV est utilisé.

Ouvrez un stream en commençant après la sélection `postBatchResumeToken` :

```
post_batch_resume_token = output['cursor']['postBatchResumeToken']
stream = db.watch(full_document='updateLookup', resume_after=post_batch_resume_token)
```

Contrairement à un jeton de CV normal qui correspond toujours à une entrée du journal des opérations (oplog) reflétant un événement réel, `postBatchResumeToken` correspond à une entrée oplog scannée par le flux de modifications sur le serveur, qui n'est pas nécessairement une modification correspondante.

Toute tentative de reprise avec un ancien jeton de CV normal obligera la base de données à scanner toutes les entrées du journal entre l'horodatage spécifié et l'heure actuelle. Cela peut générer de nombreuses requêtes en interne, chaque sous-requête étant analysée pendant une courte période. Cela provoquera un pic d'utilisation du processeur et dégradera les performances de la base de données. Reprendre avec le dernier permet d'éviter de scanner les `postBatchResumeToken` entrées d'oplog qui ne correspondent pas.

## Transactions dans les flux de changement
<a name="change_streams-transactions"></a>

Les événements du flux de modifications ne contiendront pas d'événements provenant de transactions and/or abandonnées non validées. Par exemple, si vous démarrez une transaction avec une `INSERT` opération et une `UPDATE` opération, et si votre `INSERT` opération réussit, mais qu'elle échoue, la transaction sera annulée. `UPDATE` Cette transaction ayant été annulée, votre flux de modifications ne contiendra aucun événement lié à cette transaction.

## Modification de la durée de conservation du journal du flux de modifications
<a name="change_streams-modifying_log_retention"></a>

Vous pouvez modifier la durée de conservation du journal des flux de modifications pour qu'elle soit comprise entre 1 heure et 7 jours à l'aide du AWS Management Console ou du AWS CLI.

------
#### [ Using the AWS Management Console ]

**Pour modifier la durée de conservation du journal du flux de modifications**

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

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/fr_fr/documentdb/latest/developerguide/images/docdb-menu-icon.png)) dans le coin supérieur gauche de la page.

1. Dans le volet **Parameter groups (Groupes de paramètres)**, choisissez le groupe de paramètres de cluster associé à votre cluster. Pour identifier le groupe de paramètres de cluster associé à votre cluster, veuillez consulter [Déterminer le groupe de paramètres d'un cluster Amazon DocumentDB](cluster_parameter_groups-describe.md#cluster_parameter_groups-determine). 

1. La page qui s’affiche contient les paramètres et leurs détails correspondants pour votre groupe de paramètres de cluster. Sélectionnez le paramètre `change_stream_log_retention_duration`.

1. En haut à droite de la page, choisissez **Edit (Modifier)** pour modifier la valeur du paramètre. Le `change_stream_log_retention_duration` paramètre peut être modifié pour être compris entre 1 heure et 7 jours.

1. 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 le paramètre `change_stream_log_retention_duration` de votre 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. Pour identifier le groupe de paramètres de cluster associé à votre cluster, veuillez consulter [Déterminer le groupe de paramètres d'un cluster Amazon DocumentDB](cluster_parameter_groups-describe.md#cluster_parameter_groups-determine). 
+ **--parameters** — Obligatoire. Paramètre que vous modifiez. Chaque saisie de paramètre doit inclure ce qui suit : 
  + **ParameterName**— Le nom du paramètre que vous êtes en train de modifier. Dans ce cas, il s’agit de `change_stream_log_retention_duration` 
  + **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`. 

1. Pour modifier les valeurs du paramètre `change_stream_log_retention_duration`, exécutez la commande suivante et remplacez `parameter-value` par la valeur que vous souhaitez attribuer au paramètre. 

   Pour Linux, macOS ou Unix :

   ```
   aws docdb modify-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group \
       --parameters "ParameterName=change_stream_log_retention_duration,ParameterValue=<parameter-value>,ApplyMethod=immediate"
   ```

   Pour Windows :

   ```
   aws docdb modify-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group ^
       --parameters "ParameterName=change_stream_log_retention_duration,ParameterValue=<parameter-value>,ApplyMethod=immediate"
   ```

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

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

1. Patientez au moins 5 minutes.

1. Répertoriez les valeurs de paramètre de `sample-parameter-group` pour vous assurer que vos modifications ont été prises en compte. 

   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": "12345",
               "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": "immediate"
           }
       ]
   }
   ```

------

**Note**  
La conservation des journaux du flux de modifications ne supprime pas les journaux antérieurs à la `change_stream_log_retention_duration` valeur configurée tant que la taille du journal n'est pas supérieure à (>) 51 200 Mo.

## Utilisation des flux de modifications sur les instances secondaires
<a name="change-streams-secondary-instances"></a>

Pour commencer à utiliser le flux de modifications sur les instances secondaires, ouvrez le curseur du flux de modifications `readPreference` en le désignant comme secondaire.

Vous pouvez ouvrir un curseur de flux de modifications pour surveiller les événements de modification concernant une collection spécifique ou toutes les collections d'un cluster ou d'une base de données. Vous pouvez ouvrir un curseur de flux de modifications sur n'importe quelle instance Amazon DocumentDB et récupérer les documents du flux de modifications à partir des instances de rédacteur et de lecteur. Vous pouvez partager des jetons de flux de modifications (tels que `resumeToken` ou`startOperationTime`) entre différents curseurs de flux de modifications ouverts sur une instance de rédacteur et de lecteur.

**Exemple**

```
import os
import sys
from pymongo import MongoClient, ReadPreference
      
username = "DocumentDBusername"
password = <Your password> 

clusterendpoint = "DocumentDBClusterEndpoint"

client = MongoClient(clusterendpoint, username=username, password=password, tls='true', tlsCAFile='global-bundle.pem')

db = client['bar']
 
# Make sure to use SECONDARY to redirect cursor reads from secondary instances
coll = db.get_collection('foo', read_preference=ReadPreference.SECONDARY)

# Create a stream object on RO. The token needs to generated from PRIMARY.
stream = coll.watch(resumeAfter=token)

for event in stream:
   print(event)
```

**Directives et limites relatives aux flux de modifications sur les instances secondaires**
+ Les événements du flux de modifications doivent être répliqués de l'instance principale vers les instances secondaires. Vous pouvez surveiller le décalage par rapport à la `DBInstanceReplicaLag` métrique sur Amazon CloudWatch.
+ Les horodatages des instances secondaires peuvent ne pas toujours être synchronisés avec ceux de l'instance principale. Dans ce cas, attendez-vous à des retards sur l'horodatage de l'instance secondaire afin qu'elle puisse rattraper son retard. Il est recommandé d'utiliser `startAtOperationTime` ou de `resumeToken` démarrer la montre sur l'instance secondaire.
+ Le débit des instances secondaires peut être inférieur à celui de l'instance principale si la taille de votre document est importante, c'est le cas`fullDocumentLookup`, et si la charge de travail d'écriture simultanée est élevée sur l'instance principale. Il est recommandé de surveiller le taux de réussite de votre cache tampon sur le cache secondaire et de vous assurer que le taux de réussite du cache tampon est élevé.

# Utilisation du classement dans Amazon DocumentDB 8.0
<a name="collation"></a>

Amazon DocumentDB 8.0 prend désormais en charge le classement. Le classement vous permet de configurer des règles spécifiques à la langue pour la comparaison de chaînes. Avec le classement, vous pouvez définir des règles pour les comparaisons distinguant majuscules et minuscules, ou spécifier un paramètre régional de langue. Le classement peut être configuré au niveau de la collection ou au niveau de l'index dans DocumentDB 8.0. Lorsque vous utilisez le classement dans DocumentDB, un document de classement est créé en interne avec les paramètres suivants. 

```
{
locale: string,
caseLevel: boolean,
caseFirst: string,
strength: int,
numericOrdering: boolean,
alternate: string,
maxVariable: string,
backwards: boolean,
normalization: boolean
}
```

## Limitations
<a name="collation-limitations"></a>

Le classement présente les limites suivantes dans Amazon DocumentDB :
+ Le classement est compatible avec le planificateur v3 disponible dans Amazon DocumentDB 8.0. Le passage à plannerv2 ou plannerv1 peut entraîner des comportements incohérents, notamment des erreurs « Index introuvable ».
+ En raison des différences inhérentes aux bibliothèques, si une collection mongodb avec classement est exportée, vous devrez mettre à jour les fichiers de métadonnées .bson et modifier sa version de 57.1 à 60.2 avant la migration.
+ Dans de rares cas, vos paramètres de classement peuvent dépasser la limite interne du nombre de caractères, provoquant l'erreur ci-dessous. « Erreur : le document de classement possède des attributs autres que ceux pris en charge par défaut. Veuillez réduire le nombre d'options. » Dans ce cas, essayez de réduire le nombre d'options que vous fournissez dans le document de classement ou essayez d'utiliser des valeurs par défaut dans la mesure du possible.

# Utilisation de vues dans Amazon DocumentDB 8.0
<a name="views"></a>
+ Amazon DocumentDB 8.0 prend désormais en charge les vues. Les vues fonctionnent comme des collections virtuelles qui présentent des données basées sur des opérations d'agrégation spécifiées. Lorsque vous créez une vue, vous définissez une requête qui transforme les données d'une ou de plusieurs collections sources. Amazon DocumentDB 8.0 exécute cette requête à chaque accès à la vue, sans consommer de ressources de stockage supplémentaires. Contrairement aux collections standard, les vues d'Amazon DocumentDB 8.0 ne stockent pas de documents sur disque, ce qui en fait une solution efficace pour présenter des données transformées ou filtrées aux applications. Pour créer une vue dans Amazon DocumentDB, vous pouvez utiliser la commande CreateView ou la méthode d'assistance DB.createView () : 

  ```
  db.createView("viewName","sourceCollection",
  [
      { $match: { status: "active" } },
      { $project: { _id: 1, name: 1, email: 1 } }
  ]
  )
  ```

  Cela crée une vue nommée « ViewName » basée sur « SourceCollection » qui inclut uniquement les documents actifs et les projets, uniquement les champs \$1id, name et email. Les vues dans Amazon DocumentDB sont en lecture seule. Les opérations d'écriture sur les vues renverront une erreur. Pour des performances optimales avec de grands ensembles de données, vous pouvez structurer vos pipelines de vues afin d'optimiser l'efficacité. Pour les pipelines d'agrégation complexes, il est recommandé d'utiliser l'étape \$1match comme première étape ou au début du pipeline afin de réduire le nombre de documents que les étapes suivantes doivent traiter, améliorant ainsi les performances des requêtes. 

## Bonnes pratiques
<a name="views-bestpractices"></a>

Certaines des meilleures pratiques à suivre avec Views sont répertoriées ci-dessous.
+ Filtrer tôt : utilisez les étapes \$1match dès le début de la visualisation des pipelines afin de réduire la quantité de données traitées.
+ Évitez les agrégations complexes : pour les vues fréquemment consultées comportant des agrégations complexes, pensez à créer une collection distincte avec des résultats précalculés qui sont mis à jour périodiquement.
+ Planification de l'index : assurez-vous que les champs utilisés dans les pipelines de vues, en particulier dans les opérations \$1match et \$1sort, sont correctement indexés dans la collection source.
+ Optimisation des requêtes : utilisez la commande explain pour comprendre comment vos requêtes de vue sont exécutées et optimisez-les en conséquence.
+ Alternatives pour les vues : étant donné les différences fonctionnelles entre les vues Amazon DocumentDB et MongoDB, envisagez d'utiliser des collections régulières avec des mises à jour planifiées comme alternative aux vues lorsque vous rencontrez des limites.

## Compatibilité avec les opérateurs d'agrégateurs
<a name="views-aggregators"></a>

Amazon DocumentDB prend en charge de nombreux opérateurs d'agrégation dans les définitions de vues tout en continuant à étendre la compatibilité. Lorsque vous utilisez des vues, concentrez-vous sur les opérateurs pris en charge suivants :
+ \$1match pour filtrer les documents
+ \$1project pour la sélection et la transformation des champs
+ \$1addFields pour ajouter des champs calculés
+ \$1sort pour les résultats de commande
+ \$1limit et \$1skip pour la pagination

Certains opérateurs spécialisés tels que \$1currentOp, \$1replaceRoot et \$1GeoNear fonctionnent actuellement sur des requêtes d'agrégation directe plutôt que sur des définitions de vues.

## Tirer parti des index et des vues
<a name="views-indexes"></a>

Les vues dans Amazon DocumentDB 8.0 utilisent les index de la collection sous-jacente. Par conséquent, vous ne pouvez pas créer, supprimer ou reconstruire des index directement sur une vue. Cependant, des index bien conçus sur la collection source peuvent améliorer de manière significative les performances des requêtes de vue. Voici quelques étapes pour optimiser les performances des requêtes sur les vues :
+ Assurez-vous que les index appropriés existent sur les champs de collection source utilisés dans le pipeline de la vue, en particulier dans les opérations \$1match et \$1sort
+ Utilisez la méthode explain () pour analyser les plans d'exécution des requêtes et vérifier l'utilisation de l'index. Par exemple, `db.viewName.find({...}).explain() `

# Utilisation AWS Lambda avec les flux de modifications
<a name="using-lambda"></a>

Amazon DocumentDB est intégré AWS Lambda afin que vous puissiez utiliser les fonctions Lambda pour traiter les enregistrements dans un flux de modifications. Le mappage des sources d'événements Lambda est une ressource qui peut être utilisée pour appeler des fonctions Lambda afin de traiter les événements Amazon DocumentDB qui n'invoquent pas directement Lambda. Avec Amazon DocumentDB change stream comme source d'événements, vous pouvez créer des applications pilotées par les événements qui répondent aux modifications de vos données. Par exemple, vous pouvez utiliser les fonctions Lambda pour traiter de nouveaux documents, suivre les mises à jour de documents existants ou enregistrer les documents supprimés.

Vous pouvez configurer un mappage de source d'événements pour envoyer des enregistrements depuis votre flux de modifications Amazon DocumentDB vers une fonction Lambda. Les événements peuvent être envoyés un par un ou groupés pour une efficacité accrue et seront traités dans l'ordre. Vous pouvez configurer le comportement de traitement par lots de votre mappage de sources d'événements en fonction d'une durée de fenêtre temporelle spécifique (0 à 300 secondes) ou d'un nombre d'enregistrements par lots (limite maximale de 10 000 enregistrements). Vous pouvez créer plusieurs mappages de sources d'événements pour traiter les mêmes données avec plusieurs fonctions Lambda, ou pour traiter des éléments distincts provenant de plusieurs flux avec une seule fonction.

Si votre fonction renvoie une erreur, Lambda réessaie le lot jusqu'à ce qu'il soit traité avec succès. Si les événements du flux de modifications ont expiré, Lambda désactivera le mappage des sources d'événements. Dans ce cas, vous pouvez créer un nouveau mappage des sources d'événements et le configurer avec la position de départ de votre choix. Les mappages de sources d’événements Lambda traitent les événements au moins une fois en raison de la nature distribuée de ses pollers. Par conséquent, votre fonction Lambda peut recevoir des événements dupliqués dans de rares situations. Suivez les meilleures pratiques d'utilisation des AWS Lambda fonctions et créez des fonctions idempotentes pour éviter les problèmes liés aux événements dupliqués. Pour plus d'informations, consultez la section [Utilisation AWS Lambda console avec Amazon DocumentDB](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) dans le manuel du *AWS Lambda développeur*.

Afin de respecter les bonnes pratiques en matière de performances, la fonction Lambda doit être de courte durée. Pour éviter d'introduire des retards de traitement inutiles, elle ne doit pas non plus exécuter de logique complexe. Pour un flux à haute vitesse en particulier, il est préférable de déclencher des flux de travail asynchrones avec des fonctions de post-traitement par étapes plutôt que des Lambdas synchrones de longue durée. Pour plus d'informations AWS Lambda, consultez le [guide du AWS Lambda développeur](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). 

## Limites
<a name="lambda-limitations"></a>

Les limites suivantes sont à prendre en compte lors de l'utilisation d'Amazon DocumentDB et : AWS Lambda
+ AWS Lambda est actuellement pris en charge uniquement sur Amazon DocumentDB 4.0 et 5.0.
+ AWS Lambda n'est actuellement pas pris en charge sur les clusters élastiques ou les clusters globaux.
+ AWS Lambda la taille de la charge utile ne peut pas dépasser 6 Mo. *Pour plus d'informations sur les tailles de lots Lambda, consultez la section « Comportement du traitement par lots » dans la section [Mappages des sources d'événements Lambda](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching) du Guide du développeur.AWS Lambda *