Prérequis Étape 1 : Création d'un cluster élastique Étape 2 : Connectez-vous à votre cluster élastique Étape 3 : Partagez votre collection, insérez et interrogez des données Étape 4 : Explorez

Commencez avec les clusters élastiques Amazon DocumentDB

Cette section de mise en route explique comment créer et interroger votre premier cluster élastique.

Il existe de nombreuses manières de se connecter et de démarrer avec Amazon DocumentDB. La procédure suivante est le moyen le plus rapide, le plus simple et le plus simple pour les utilisateurs de commencer à utiliser notre puissante base de données de documents. Ce guide permet AWS CloudShellde connecter et d'interroger votre cluster Amazon DocumentDB directement depuis le. AWS Management Console Les nouveaux clients éligibles au niveau AWS gratuit peuvent utiliser Amazon DocumentDB CloudShell gratuitement. Si votre AWS CloudShell environnement ou votre cluster élastique Amazon DocumentDB utilise des ressources au-delà du niveau gratuit, les AWS tarifs normaux vous sont facturés pour ces ressources. Ce guide vous permettra de démarrer avec Amazon DocumentDB en moins de 5 minutes.

Rubriques

Prérequis
Étape 1 : Création d'un cluster élastique
Étape 2 : Connectez-vous à votre cluster élastique
Étape 3 : Partagez votre collection, insérez et interrogez des données
Étape 4 : Explorez

Prérequis

Avant de créer votre premier cluster Amazon DocumentDB, vous devez effectuer les opérations suivantes :

Créez un compte Amazon Web Services (AWS)

Avant de pouvoir commencer à utiliser Amazon DocumentDB, vous devez disposer d'un compte Amazon Web Services (AWS). Le AWS compte est gratuit. Vous payez uniquement les services et les ressources que vous utilisez.

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

Pour vous inscrire à un Compte AWS

Ouvrez l'https://portal.aws.amazon.com/billing/inscription.
Suivez les instructions en ligne.

Dans le cadre de la procédure d’inscription, vous recevrez un appel téléphonique 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 AWSest 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.

Configurez les autorisations AWS Identity and Access Management (IAM) nécessaires.

L'accès à la gestion des ressources Amazon DocumentDB telles que les clusters, les instances et les groupes de paramètres de cluster nécessite des informations d'identification AWS pouvant être utilisées pour authentifier vos demandes. Pour de plus amples informations, veuillez consulter Identity and Access Management pour Amazon DocumentDB.

Dans la barre de recherche du AWS Management Console, tapez IAM et sélectionnez IAM dans le menu déroulant.
Une fois dans la console IAM, sélectionnez Utilisateurs dans le volet de navigation.
Sélectionnez votre nom d'utilisateur.
Cliquez sur Add permissions (Ajouter des autorisations).
Sélectionnez Joindre directement les politiques.
Tapez AmazonDocDBElasticFullAccess dans la barre de recherche et sélectionnez-la une fois qu'elle apparaît dans les résultats de recherche.
Cliquez sur Next (Suivant).
Cliquez sur Add permissions (Ajouter des autorisations).

Note

Votre AWS compte inclut un VPC par défaut dans chaque région. Si vous choisissez d'utiliser un Amazon VPC, suivez les étapes décrites dans la rubrique Créer un Amazon VPC du Guide de l'utilisateur Amazon VPC.

Étape 1 : Création d'un cluster élastique

Dans cette section, nous expliquons comment créer un tout nouveau cluster élastique, en utilisant AWS Management Console ou AWS CLI en suivant les instructions suivantes.

Using the AWS Management Console

Pour créer une configuration de cluster élastique à l'aide de AWS Management Console :

Connectez-vous à la AWS Management Console console Amazon DocumentDB et ouvrez-la à https://console.aws.amazon.com l'adresse /docdb.
Sur la console de gestion Amazon DocumentDB, sous Clusters, choisissez Create.
Sur la page Créer un cluster Amazon DocumentDB, dans la section Type de cluster, sélectionnez Elastic cluster.
Dans la section Configuration, configurez les éléments suivants :
1. Dans le champ Nom du cluster, entrez un identifiant de cluster unique (conformément aux exigences de dénomination situées sous le champ).
2. Dans le champ Nombre de partitions, entrez le nombre de partitions que vous souhaitez ajouter à votre cluster. Le nombre maximum de partitions par cluster est de 32.
  
  Note
  Deux nœuds seront déployés pour chaque partition. Les deux nœuds auront la même capacité de partition.
3. Dans le champ Nombre d'instances de partition, choisissez le nombre d'instances de répliques que vous souhaitez associer à chaque partition. Le nombre maximum d'instances de partition est de 16, par incréments de 1. Toutes les instances de réplica ont la même capacité de partition que celle définie dans le champ suivant. À des fins de test, la valeur par défaut de 2 devrait suffire.
  
  Note
  Le nombre d'instances de répliques s'applique à tous les fragments du cluster élastique. Une valeur de 1 pour le nombre d'instances de partition signifie qu'il existe une instance d'écriture et que toutes les instances supplémentaires sont des répliques qui peuvent être utilisées pour les lectures et pour améliorer la disponibilité. À des fins de test, la valeur par défaut de 2 devrait suffire.
4. Dans le champ Capacité de partition, choisissez le nombre de partitions virtuelles CPUs (vCPUs) que vous souhaitez associer à chaque instance de partition. Le nombre maximum de v CPUs par instance de partition est de 64. Les valeurs autorisées sont 2, 4, 8, 16, 32, 64. À des fins de test, la valeur par défaut de 2 devrait suffire.
5. Dans le champ Virtual Private Cloud (VPC), sélectionnez un VPC dans la liste déroulante.
6. Pour les sous-réseaux et les groupes de sécurité VPC, vous pouvez utiliser les valeurs par défaut ou sélectionner trois sous-réseaux de votre choix et jusqu'à trois groupes de sécurité VPC (un minimum).
Dans la section Authentification, entrez une chaîne identifiant le nom de connexion de l'utilisateur principal dans le champ Nom d'utilisateur.

Dans le champ Mot de passe, entrez un mot de passe unique conforme aux instructions, puis confirmez-le.
Dans la section Chiffrement, conservez le paramètre par défaut (clé par défaut).

Vous pouvez éventuellement saisir un AWS KMS key ARN que vous avez créé. Pour de plus amples informations, veuillez consulter Chiffrement des données au repos pour les clusters élastiques Amazon DocumentDB.

Important
Le chiffrement doit être activé pour les clusters élastiques.
Dans la section Backup, modifiez les champs en fonction de vos besoins en matière de sauvegarde. À des fins de test, vous pouvez conserver les paramètres par défaut.
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.
2. 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. Choisissez Sélectionner une fenêtre si vous souhaitez configurer l'heure et la durée de création des sauvegardes.
    
    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.
    
    Durée : dans la liste, choisissez le nombre d'heures à allouer à la création de sauvegardes automatiques.
  2. Choisissez Aucune préférence si vous souhaitez qu'Amazon DocumentDB choisisse l'heure et la durée de création des sauvegardes.
Dans la section Maintenance, choisissez le jour, l'heure et la durée pendant lesquels les modifications ou les correctifs sont appliqués à votre cluster. À des fins de test, vous pouvez conserver les paramètres par défaut.
Choisissez Créer un cluster.

Le cluster élastique est en cours de provisionnement. Cette opération peut prendre jusqu'à quelques minutes. Vous pouvez vous connecter à votre cluster lorsque l'état du cluster élastique indique « Disponible » dans la liste des clusters.

Using the AWS CLI

Pour créer un cluster élastique à l'aide de AWS CLI, utilisez l'create-clusteropération avec les paramètres suivants :

--cluster-name : obligatoire. Nom actuel du cluster d'échelles élastiques tel qu'il a été saisi lors de sa création ou de sa dernière modification.
--shard-capacity : obligatoire. Le nombre de v CPUs attribué à chaque partition. Le maximum est de 64. Les valeurs autorisées sont 2, 4, 8, 16, 32, 64.
--shard-count : obligatoire. Le nombre de partitions attribuées au cluster. Le maximum est de 32.
--shard-instance-count—Facultatif. Le nombre d'instances de répliques s'appliquant à toutes les partitions de ce cluster. Le maximum est de 16.
--admin-user-name : obligatoire. Le nom d'utilisateur associé à l'utilisateur administrateur.
--admin-user-password : obligatoire. Le mot de passe associé à l'utilisateur administrateur.
--auth-type : obligatoire. Type d'authentification utilisé pour déterminer où récupérer le mot de passe utilisé pour accéder au cluster élastique. Les types valides sont PLAIN_TEXT ouSECRET_ARN.
--vpc-security-group-ids—Facultatif. Configurez une liste de groupes de sécurité EC2 VPC à associer à ce cluster.
--preferred-maintenance-window—Facultatif. Configurez la plage horaire hebdomadaire pendant laquelle la maintenance du système peut avoir lieu, en temps universel coordonné (UTC).

Le format est :ddd:hh24:mi-ddd:hh24:mi. Jours valides (ddd) : lundi, mardi, mercredi, jeudi, vendredi, samedi, dimanche

La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard sur une période de 8 heures pour chaque région Amazon Web Services, survenant un jour aléatoire de la semaine.

Fenêtre minimale de 30 minutes.
--kms-key-id—Facultatif. Configurez l'identifiant de clé KMS pour un cluster chiffré.

L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de AWS KMS chiffrement. Si vous créez un cluster en utilisant le même compte Amazon Web Services qui possède la clé de chiffrement KMS utilisée pour chiffrer le nouveau cluster, vous pouvez utiliser l'alias de clé KMS au lieu de l'ARN pour la clé de chiffrement KMS.

Si aucune clé de chiffrement n'est spécifiée dans KmsKeyId et si le StorageEncrypted paramètre est vrai, Amazon DocumentDB utilise votre clé de chiffrement par défaut.
--preferred-backup-window—Facultatif. Période quotidienne préférée pendant laquelle les sauvegardes automatisées sont créées. La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'entre elles. Région AWS
--backup-retention-period—Facultatif. Nombre de jours de conservation des sauvegardes automatiques. La valeur par défaut est 1.
--storage-encrypted—Facultatif. Configure si le cluster est chiffré ou non.

--no-storage-encryptedindique que le cluster n'est pas chiffré.
--subnet-ids—Facultatif. Configurez les identifiants de sous-réseau.

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

Note

Les exemples suivants incluent la création d'une clé KMS spécifique. Pour utiliser la clé KMS par défaut, n'incluez pas le --kms-key-id paramètre.

Pour Linux, macOS ou Unix :


aws docdb-elastic create-cluster \
     --cluster-name sample-cluster-123 \
     --shard-capacity 8 \
     --shard-count 4 \
     --shard-instance-count 3 \
     --auth-type PLAIN_TEXT \
     --admin-user-name testadmin \
     --admin-user-password testPassword \
     --vpc-security-group-ids ec-65f40350 \
     --kms-key-id arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 \
     --subnet-ids subnet-9253c6a3, subnet-9f1b5af9 \
     --preferred-backup-window 18:00-18:30 \ 
     --backup-retention-period 7

Pour Windows :


aws docdb-elastic create-cluster ^
     --cluster-name sample-cluster-123 ^
     --shard-capacity 8 ^
     --shard-count 4 ^
     --shard-instance-count 3 ^
     --auth-type PLAIN_TEXT ^
     --admin-user-name testadmin ^
     --admin-user-password testPassword ^
     --vpc-security-group-ids ec-65f40350 ^
     --kms-key-id arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 ^
     --subnet-ids subnet-9253c6a3, subnet-9f1b5af9 \
     --preferred-backup-window 18:00-18:30 \ 
     --backup-retention-period 7

Étape 2 : Connectez-vous à votre cluster élastique

Connectez-vous à votre cluster élastique Amazon DocumentDB à l'aide de. AWS CloudShell

Sur la console de gestion Amazon DocumentDB, sous Clusters, recherchez le cluster élastique que vous avez créé. Choisissez votre cluster en cochant la case à côté de celui-ci.
Cliquez sur Se connecter au cluster (qui se trouve à côté du menu déroulant Actions). Ce bouton n'est activé qu'une fois que vous avez coché la case à côté de votre cluster et que le statut du cluster est indiqué comme Disponible. L'écran CloudShell Exécuter la commande apparaît.
Dans le champ Nom du nouvel environnement, entrez un nom unique, tel que « test », puis cliquez sur Créer et exécuter. Les détails de l'environnement VPC sont automatiquement configurés pour votre base de données Amazon DocumentDB.
Lorsque vous y êtes invité, entrez le mot de passe que vous avez créé à l'étape 1 : Création d'un cluster élastique Amazon DocumentDB (sous-étape 5).

Une fois que vous avez saisi votre mot de passe et que vous y êtes invitédirect: mongos] <env-name>>, vous êtes connecté avec succès à votre cluster Amazon DocumentDB

Note

Pour plus d'informations sur le dépannage, consultez la section Résolution des problèmes liés à Amazon DocumentDB.

Étape 3 : Partagez votre collection, insérez et interrogez des données

Les clusters élastiques ajoutent la prise en charge du sharding dans Amazon DocumentDB. Maintenant que vous êtes connecté à votre cluster, vous pouvez partager le cluster, insérer des données et exécuter quelques requêtes.

Pour partager une collection, entrez les informations suivantes :


sh.shardCollection("db.Employee1" , { "Employeeid" : "hashed" })

Pour insérer un seul document, entrez les informations suivantes :


db.Employee1.insertOne({"Employeeid":1, "Name":"Joe", "LastName": "Bruin", "level": 1 })

La sortie suivante s'affiche :


WriteResult({ "nInserted" : 1 })

Pour lire le document que vous avez écrit, entrez la findOne() commande (il renvoie un seul document) :


db.Employee1.findOne()

La sortie suivante s'affiche :


{
"_id" : ObjectId("61f344e0594fe1a1685a8151"),
"EmployeeID" : 1,
"Name" : "Joe",
"LastName" : "Bruin",
"level" : 1
}

Pour effectuer quelques requêtes supplémentaires, considérez un cas d'utilisation d'un profil de jeu. Tout d'abord, insérez quelques entrées dans une collection intitulée « Employé ». Saisissez :


db.profiles.insertMany([ { "_id": 1, "name": "Matt", "status": "active", "level": 12, "score": 202 }, 
     { "_id": 2, "name": "Frank", "status": "inactive", "level": 2, "score": 9 }, 
     { "_id": 3, "name": "Karen", "status": "active", "level": 7, "score": 87 }, 
     { "_id": 4, "name": "Katie", "status": "active", "level": 3, "score": 27 }
])

La sortie suivante s'affiche :


{ acknowledged: true, 
     insertedIds: { 
        '0': ObjectId('679d02cd6b5a0581be78bcbd'),
        '1': ObjectId('679d02cd6b5a0581be78bcbe'),
        '2': ObjectId('679d02cd6b5a0581be78bcbf'),
        '3': ObjectId('679d02cd6b5a0581be78bcc0')
    }
}

Pour renvoyer tous les documents de la collection de profils, entrez la commande find () :
```
db.Employee.find()
```
Les données que vous avez saisies à l'étape 4 s'affichent.

Pour interroger un seul document, incluez un filtre (par exemple : « Katie »). Saisissez :


db.Employee.find({name: "Katie"})

La sortie suivante s'affiche :


[ 
   { 
     _id: ObjectId('679d02cd6b5a0581be78bcc0'), 
     Employeeid: 4, 
     name: 'Katie', 
     lastname: 'Schaper', 
     level: 3 
   } 
]

Pour rechercher un profil et le modifier, entrez la findAndModify commande. Dans cet exemple, le niveau « 14 » est attribué à l'employé « Matt » :


db.Employee.findAndModify({     
    query: { "Employeeid" : 1, "name" : "Matt"},     
    update: { "Employeeid" : 1, "name" : "Matt", "lastname" : "Winkle", "level" : 14 } 
})

Le résultat suivant s'affiche (notez que le niveau n'a pas encore changé) :


{ 
   _id: ObjectId('679d02cd6b5a0581be78bcbd'), 
   Employeeid: 1, 
   name: 'Matt', 
   lastname: 'Winkle', 
   level: 12 
}

Pour vérifier l'augmentation du niveau, entrez la requête suivante :


db.Employee.find({name: "Matt"})

La sortie suivante s'affiche :


[
   { 
   _id: ObjectId('679d02cd6b5a0581be78bcbd'), 
   Employeeid: 1, 
   name: 'Matt', 
   lastname: 'Winkle', 
   level: 14 
   }
]

Étape 4 : Explorez

Félicitations ! Vous avez terminé avec succès la procédure de démarrage pour les clusters élastiques Amazon DocumentDB.

Quelle est la prochaine étape ? Découvrez comment tirer pleinement parti de cette base de données grâce à certaines de ses fonctionnalités les plus populaires :

Note

Le cluster élastique que vous avez créé à partir de cette procédure de démarrage continuera à générer des coûts à moins que vous ne le supprimiez. Pour obtenir des instructions, voir la rubrique Supprimer un cluster élastique.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Comment ça marche

Bonnes pratiques

Commencez avec les clusters élastiques Amazon DocumentDB

Rubriques

Prérequis

Pour vous inscrire à un Compte AWS

Note

Étape 1 : Création d'un cluster élastique

Note

Note

Important

Note

Étape 2 : Connectez-vous à votre cluster élastique

Note

Étape 3 : Partagez votre collection, insérez et interrogez des données

Étape 4 : Explorez

Note