AWS Systems Manager Documents
Un document AWS Systems Manager (SSM) définit les actions exécutées par Systems Manager sur vos instances gérées. Systems Manager inclut plus d'une centaine de documents préconfigurés que vous pouvez utiliser en spécifiant des paramètres lors de l'exécution. Vous pouvez trouver des documents préconfigurés dans la console Documents de Systems Manager en sélectionnant l'onglet Propriété d'Amazon ou en spécifiant Amazon comme filtre Owner lors de l'appel de l'opération d'API ListDocuments. Les documents utilisent JSON (JavaScript Object Notation) ou YAML et incluent les étapes et paramètres que vous spécifiez. Pour vos premiers pas dans SSM documents, ouvrez Systems Manager console
Important
Dans Systems Manager, un document SSM appartenant à Amazon est un document créé et géré par Amazon Web Services lui-même. Les documents appartenant à Amazon comprennent un préfixe tel que AWS-* dans le nom du document. Le propriétaire du document est considéré comme étant Amazon, et non un compte utilisateur spécifique dans AWS. Ces documents sont accessibles à tous.
En quoi la fonction Documents peut-elle être utile à mon organisation ?
Documents, une fonction de AWS Systems Manager, offre les avantages suivants :
-
Catégories de documents
Pour vous aider à trouver les documents dont vous avez besoin, sélectionnez une catégorie en fonction du type de document que vous recherchez. Pour élargir votre recherche, vous pouvez choisir plusieurs catégories du même type de document. Le choix de catégories de différents types de documents n'est pas pris en charge. Les catégories ne sont prises en charge que pour les documents appartenant à Amazon.
-
Version de document
Vous pouvez créer et enregistrer différentes versions des documents. Vous pouvez ensuite spécifier une version par défaut pour chaque document. La version par défaut d'un document peut être mise à jour vers une version plus récente ou rétablie vers une version plus ancienne du document. Lorsque vous modifiez le contenu d'un document, Systems Manager incrémente automatiquement la version du document. Vous pouvez récupérer ou utiliser n'importe quelle version d'un document en spécifiant la version du document dans la console, les commandes AWS Command Line Interface (AWS CLI) ou les appels d'API.
-
Personnaliser les documents selon vos besoins
Si vous souhaitez personnaliser les étapes et les actions dans un document, vous pouvez créer votre propre document. Le système stocke le document avec votre Compte AWS dans la Région AWS dans laquelle vous l'avez créé. Pour de plus amples informations sur la création d'un document SSM, veuillez consulter Création du contenu du document SSM.
-
Baliser les documents
Vous pouvez baliser vos documents pour vous aider à identifier rapidement un ou plusieurs documents en fonction des balises que vous lui avez affectées. Par exemple, vous pouvez baliser des documents pour des environnements, des services, des utilisateurs, des groupes ou des périodes spécifiques. Vous pouvez également restreindre l'accès aux documents en créant une politique AWS Identity and Access Management (IAM) qui spécifie les balises auxquelles un utilisateur ou un groupe peuvent accéder.
-
Partager les documents
Vous pouvez rendre vos documents publics ou les partager avec des Comptes AWS spécifiques de la même Région AWS. Le partage des documents entre plusieurs comptes peut être utile si, par exemple, vous souhaitez que toutes les instances Amazon Elastic Compute Cloud (Amazon EC2) que vous fournissez aux clients ou aux employés aient la même configuration. En plus de maintenir des applications ou des correctifs sur les instances à jour, il se peut que vous souhaitiez limiter les instances du client à partir de certaines activités. Il est également possible de s'assurer que les employés utilisés par des comptes au sein de toute votre organisation aient accès à certaines ressources internes. Pour en savoir plus, consultez Partage de documents SSM.
Qui devrait utiliser les documents ?
-
Tout client AWS qui souhaite utiliser les fonctionnalités de Systems Manager pour améliorer son efficacité opérationnelle à grande échelle, réduire les erreurs associées aux interventions manuelles et accélérer la résolution des problèmes courants.
-
Experts en infrastructure qui souhaitent automatiser les tâches de déploiement et de configuration.
-
Les administrateurs qui souhaitent résoudre de manière fiable les problèmes courants, améliorer l'efficacité du dépannage et réduire les opérations répétitives.
-
Les utilisateurs qui souhaitent automatiser une tâche qu'ils exécutent normalement manuellement.
Quels sont les types de documents SSM ?
Le tableau suivant décrit les différents types de documents SSM et leur utilisation.
| Type | A utiliser avec | Détails |
|---|---|---|
|
ApplicationConfiguration ApplicationConfigurationSchema |
AWS AppConfig, une fonctionnalité de AWS Systems Manager, permet de créer, gérer et déployer rapidement des configurations d'application. Vous pouvez stocker des données de configuration dans un document SSM en créant un document qui utilise le type de document Si vous créez une configuration dans un document SSM, vous devez spécifier un schéma JSON correspondant. Le schéma utilise le type de document |
|
|
Runbook Automation |
Utilisez des runbooks Automation lors de l'exécution de tâches de maintenance et de déploiement courantes, telles que la création ou la mise à jour d'une Amazon Machine Image (AMI). State Manager utilise des runbooks Automation pour appliquer une configuration. Ces actions peuvent être exécutées sur une ou plusieurs cibles lors du cycle de vie d'une instance. Maintenance Windows utilise des runbooks Automation pour effectuer les tâches courantes de maintenance et de déploiement en fonction de la planification spécifiée. Tous les runbooks Automation pris en charge sur les systèmes d'exploitation Linux sont également pris en charge sur les instances EC2 pour macOS. |
|
|
Document Change Calendar |
Change Calendar, une fonctionnalité de AWS Systems Manager, utilise le type de document Change Calendar n'est pas pris en charge sur les instances EC2 pour macOS. |
|
|
Modèle AWS CloudFormation |
Ces modèles AWS CloudFormation décrivent les ressources que vous voulez mettre en service dans vos piles CloudFormation. Le stockage de modèles CloudFormation sous forme de documents Systems Manager vous permet de bénéficier des fonctions des documents Systems Manager. Cela inclut la création et la comparaison de plusieurs versions de votre modèle, ainsi que le partage de votre modèle avec d'autres comptes dans la même Région AWS. Vous pouvez créer et modifier des modèles et des piles CloudFormation en utilisant Application Manager, une fonctionnalité de Systems Manager. Pour en savoir plus, consultez Utilisation des modèles et des modèles AWS CloudFormation dans Application Manager.. |
|
|
Document de commande |
Run Command, une fonctionnalité de AWS Systems Manager, utilise les documents Command pour exécuter des commandes. State Manager, une fonctionnalité de AWS Systems Manager utilise les documents Command pour appliquer une configuration. Ces actions peuvent être exécutées sur une ou plusieurs cibles lors du cycle de vie d'une instance. Maintenance Windows, une des fonctions de AWS Systems Manager, utilise des documents de commande pour appliquer une configuration en fonction de la planification spécifiée. La plupart des documents Command sont pris en charge sur tous les systèmes d'exploitation Linux et Windows Server pris en charge par Systems Manager. Les documents Command suivants sont pris en charge sur les instances EC2 pour macOS :
|
|
|
Modèle de pack de conformité AWS Config |
Les modèles de packs de conformité AWS Config sont des documents au format YAML utilisés pour créer des packs de conformité contenant la liste des règles gérées ou personnalisées AWS Config et des actions de remédiation. Pour plus d'informations, consultez Pack de conformité. |
|
|
Document de package |
Dans Distributor, une fonctionnalité de AWS Systems Manager, un package est représenté par un document SSM. Un document de package inclut des fichiers d'archive ZIP attachés qui contiennent des logiciels ou des ressources à installer sur les instances gérées. La création d'un package dans Distributor crée le document de package. Distributor n'est pas pris en charge sur les instances gérées Oracle Linux et macOS. |
|
|
Document de politique |
Inventory, une des fonctions de AWS Systems Manager, utilise le document de politique Systems Manager Inventory et le document de politique |
|
|
Modèle d'analyse post-incident |
Incident Manager utilise le modèle d'analyse post-incident pour créer une analyse basée sur les bonnes pratiques de gestion des opérations AWS. Utilisez le modèle pour créer une analyse qui aidera votre équipe à identifier les améliorations à apporter à votre réponse aux incidents. |
|
|
Document de session |
Session Manager, une fonctionnalité de AWS Systems Manager, utilise des documents Session pour déterminer le type de session à démarrer, telle qu'une session de réacheminement de port, une session d'exécution de commande interactive ou une session de création de tunnel SSH. Les documents Session sont pris en charge sur tous les systèmes d'exploitation Linux et Windows Server pris en charge par Systems Manager. Les documents Command suivants sont pris en charge sur les instances EC2 pour macOS :
|
Quotas de documents SSM
Pour plus d'informations sur les quotas de document SSM, veuillez consulter la rubrique Quotas de service Systems Manager dans la Référence générale d'Amazon Web Services.
