Travaillez avec les documents d'automatisation de Systems Manager - AWS Cloud9

AWS Cloud9 n'est plus disponible pour les nouveaux clients. Les clients existants de AWS Cloud9 peuvent continuer à utiliser le service normalement. En savoir plus »

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.

Travaillez avec les documents d'automatisation de Systems Manager

Avec AWS Systems Manager, vous avez la visibilité et le contrôle de votre infrastructure sur AWS. Systems Manager fournit une interface utilisateur unifiée que vous pouvez utiliser pour visualiser les données opérationnelles de plusieurs sources services AWS et automatiser les tâches opérationnelles sur l'ensemble de vos AWS ressources.

Un document de Systems Manager définit les actions que Systems Manager effectue sur vos instances gérées. Un document d'automatisation est un type de document Systems Manager permettant d'effectuer des tâches de maintenance et de déploiement courantes. Cela inclut la création ou la mise à jour d'une Amazon Machine Image (AMI). Cette rubrique explique comment créer, modifier, publier et supprimer des documents d'automatisation avec AWS Toolkit.

Hypothèses et prérequis

Avant de commencer, assurez-vous que vous remplissez les conditions suivantes :

IAMautorisations pour les documents Systems Manager Automation

Pour créer, modifier, publier et supprimer des documents d'automatisation de Systems Manager, vous devez disposer d'un profil d'identification contenant les autorisations nécessaires AWS Identity and Access Management (IAM). Le document de politique suivant définit les IAM autorisations nécessaires qui peuvent être utilisées dans une politique principale.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:ListDocuments", "ssm:ListDocumentVersions", "ssm:DescribeDocument", "ssm:GetDocument", "ssm:CreateDocument", "ssm:UpdateDocument", "ssm:UpdateDocumentDefaultVersion", "ssm:DeleteDocument" ], "Resource": "*" } ] }

Pour plus d'informations sur la mise à jour d'une IAM politique, voir Création de IAM politiques dans le Guide de IAM l'utilisateur.

Création d'un nouveau document d'automatisation de Systems Manager

Vous pouvez créer un document d'automatisation dans JSON ou YAML en utilisant la boîte à outils AWS . Lorsque vous créez un document d'automatisation, il est présenté dans un fichier sans titre. Vous pouvez nommer votre fichier et l'enregistrer. Toutefois, le fichier n'est chargé AWS que lorsque vous le publiez.

Pour créer un nouveau document d'automatisation
  1. Choisissez l'icône de recherche dans le panneau de navigation de gauche ou tapez Ctrl+P pour ouvrir le panneau de recherche.

  2. Dans le panneau de recherche, commencez à saisir le terme « systems manager » et choisissez la commande AWS : Create a new Systems Manager Document Locally (Créer un nouveau document Systems Manager localement) lorsqu'elle s'affiche.

  3. Choisissez l'un des modèles de démarrage pour un exemple « Hello World ».

  4. Choisissez JSON ou YAML comme format pour votre document.

    L'éditeur affiche votre nouveau document d'automatisation.

Note

Lorsque vous créez un document d'automatisation local pour la première fois, il n'apparaît pas automatiquement dans AWS. Avant de pouvoir l'exécuter, vous devez le publier sur AWS.

Publication d'un document d'automatisation de Systems Manager

Après avoir créé ou modifié votre document d'automatisation dans AWS Toolkit, vous pouvez le publier dans AWS.

Pour publier votre document d'automatisation
  1. Ouvrez le document d'automatisation que vous souhaitez publier à l'aide de la procédure décrite dans Modification d'un document d'automatisation existant de Systems Manager.

  2. Choisissez l'icône de recherche dans le panneau de navigation de gauche ou tapez Ctrl+P pour ouvrir le panneau de recherche.

  3. Dans le panneau de recherche, commencez à saisir le terme « systems manager » et choisissez la commande AWS : Publish a new Systems Manager Document (Publier un nouveau document Systems Manager) lorsqu'elle s'affiche.

  4. Pour l'étape 1 sur 3, choisissez l' Région AWS endroit où vous souhaitez publier le document.

  5. Pour Step 2 of 3 (Étape 2 sur 3), choisissez Quick Create (Création rapide) pour créer un document d'automatisation. Ou choisissez Quick Update (Mise à jour rapide) pour mettre à jour un document d'automatisation existant dans cette région.

    Note

    Vous ne pouvez mettre à jour que les documents d'automatisation que vous possédez. Si vous choisissez Quick Update (Mise à jour rapide) et que vous ne possédez aucun document dans cette région, un message vous informe qu'il faut publier un document avant de le mettre à jour.

  6. Pour Step 3 of 3 (Étape 3 sur 3), en fonction de votre choix à l'étape précédente, saisissez le nom d'un nouveau document d'automatisation ou sélectionnez un document existant à mettre à jour.

    Note

    Lorsque vous publiez une mise à jour d'un document d'automatisation existant dans AWS, une nouvelle version est ajoutée au document. Si un document comporte plusieurs versions, vous pouvez définir la version par défaut.

Modification d'un document d'automatisation existant de Systems Manager

Vous pouvez utiliser l' AWS Explorateur pour rechercher les documents d'automatisation de Systems Manager existants. Lorsque vous ouvrez un document existant, il apparaît sous forme de fichier sans titre dans un AWS Cloud9 éditeur. Il existe trois types de documents d'automatisation que vous téléchargez :

  • Détenu par Amazon : SSM documents préconfigurés pouvant être utilisés en spécifiant des paramètres lors de l'exécution.

  • En ma possession : documents que j'ai créés et sur lesquels j'ai publié AWS.

  • Partagés avec moi : documents que les propriétaires ont partagés avec vous, sur la base de votre Compte AWS identifiant.

Les seuls types de documents que vous pouvez mettre à jour AWS sont ceux qui m'appartiennent. Vous pouvez également télécharger des documents d'automatisation qui sont partagés ou détenus par Amazon, et les modifier dans AWS Cloud9. Toutefois, lorsque vous publiez sur AWS, vous devez soit créer un nouveau document, soit mettre à jour un document existant dont vous êtes le propriétaire. Vous ne pouvez pas créer de nouvelles versions de documents qui ont un autre propriétaire ou qui appartiennent à Amazon.

Pour de plus amples informations, veuillez consulter Documents AWS Systems Manager dans le Guide de l'utilisateur AWS Systems Manager .

  1. Dans l' AWS explorateur, pour Systems Manager, choisissez la catégorie de SSM document que vous souhaitez télécharger : Owned by Amazon, Owned by me ou Shared with me.

  2. Pour un document spécifique, ouvrez le menu contextuel (clic droit) et choisissez Télécharger sous YAML ou Télécharger sous JSON.

    Le SSM document formaté s'affiche dans un nouvel onglet de l'éditeur.

Une fois les modifications terminées, vous pouvez utiliser la commande AWS: Publier un nouveau document de Systems Manager pour créer un nouveau document dans le AWS Cloud ou mettre à jour un document existant dont vous êtes propriétaire.

Utilisation des versions

Les documents d'automatisation de Systems Manager utilisent les versions pour la gestion des changements. Avec AWS Toolkit, vous pouvez définir la version par défaut du document, qui est la version utilisée lorsque vous exécutez le document.

Pour définir une version par défaut
  • Dans l' AWS explorateur, accédez au document dont vous souhaitez définir la version par défaut, ouvrez le menu contextuel (clic droit) du document, puis choisissez Définir la version par défaut.

    Note

    Si le document choisi ne comporte qu'une version, vous ne pouvez pas modifier la version par défaut.

Suppression d'un document d'automatisation de Systems Manager

Vous pouvez supprimer les documents d'automatisation que vous possédez dans AWS Toolkit. La suppression d'un document d'automatisation supprime le document et toutes ses versions.

Important
  • La suppression est une action destructrice qui ne peut être annulée.

  • La suppression d'un document d'automatisation déjà démarré ne supprime pas les ressources AWS créées ou modifiées lors de son exécution.

  • La suppression n'est autorisée que si vous êtes propriétaire du document.

Pour supprimer votre document d'automatisation
  1. Dans le volet AWS Explorateur, pour Systems Manager, développez Owned by Me pour répertorier vos documents.

  2. Ouvrez le menu contextuel (clic droit) du document que vous souhaitez supprimer et choisissez Delete document (Supprimer le document).

  3. Dans la boîte de dialogue d'avertissement qui s'affiche, choisissez Supprimer pour confirmer.

Exécution d'un document d'automatisation de Systems Manager

Une fois votre document d'automatisation publié sur AWS, vous pouvez l'exécuter pour effectuer des tâches en votre nom dans votre Compte AWS. Pour exécuter votre document d'automatisation, vous utilisez le AWS Management Console, le Systems Manager APIs AWS CLI, ou le AWS Tools for PowerShell. Pour plus d'informations sur la façon d'exécuter un document d'automatisation, consultez Exécution d'une automatisation simple dans le Guide de l'utilisateur AWS Systems Manager .

Sinon, si vous souhaitez utiliser l'un des outils AWS SDKs avec le Systems Manager APIs pour exécuter votre document d'automatisation, consultez les AWS SDKréférences.

Important

L'exécution d'un document d'automatisation peut créer de nouvelles ressources AWS et entraîner des frais de facturation. Nous vous recommandons fortement de comprendre ce que votre document d'automatisation va créer dans votre compte avant de l'exécuter.