Utilisation des documents d'automatisation de Systems Manager Automation - AWS Boîte à outils pour VS Code

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.

Utilisation des documents d'automatisation de Systems Manager Automation

AWS Systems Managervous donne la visibilité et le contrôle de votre infrastructure surAWS. Systems Manager fournit une interface utilisateur unifiée qui vous permet de visualiser les données opérationnelles de plusieurs services AWS et d'automatiser les tâches opérationnelles sur l'ensemble de vos ressources AWS.

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 de Systems Manager que vous utilisez pour effectuer des tâches de maintenance et de déploiement courantes, telles que 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 Automation avecAWS Toolkit for Visual Studio Code.

Hypothèses et prérequis

Avant de commencer, assurez-vous que :

Autorisations IAM pour les documents d'automatisation de Systems Manager

Dans le Toolkit for VS Code, vous devez disposer d'un profil d'informations d'identification contenant leAWS Identity and Access Management(IAM) nécessaires à la création, à la modification, à la publication et à la suppression de documents d'automatisation de Systems Manager Automation de Le document de politique suivant définit les autorisations IAM nécessaires pouvant ê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 des informations sur la création de politiques IAM, consultez Création de politiques dans le Guide de l'utilisateur IAM. Pour plus d'informations sur la configuration de votre profil d'informations d'identification, consultezAWS IAMinformations d'identification.

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

Vous pouvez créer un nouveau document Automation dansJSONouYAMLà l'aide de Visual Studio Code. Lorsque vous créez un nouveau document Automation, il est présenté dans un fichier sans titre. Vous pouvez nommer votre fichier et l'enregistrer dans VS Code, mais le nom du fichier n'est pas visible pourAWS.

Pour créer un nouveau document d'automatisation
  1. Ouvrez VS Code.

  2. Dans la pageAfficher, choisissezPalette de commandespour ouvrir la palette de commandes.

  3. Dans la palette de commandes, entrezAWSBoîte à outils Créer un nouveau document Systems Manager Automation en local.

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

  5. Choisissez JSON ou YAML.

    Un nouveau document Automation est créé.

Note

Votre nouveau document Automation dans VS Code n'apparaît pas automatiquement dansAWS. Vous devez le publier dans AWS avant de pouvoir l'exécuter.

Ouverture d'un document d'automatisation de Systems Manager Automation

Vous utilisez le pluginAWSAutomation de Systems Manager Automation de existant de Systems Manager Automation Lorsque vous ouvrez un document d'automatisation existant, il apparaît comme un fichier sans titre dans VS Code.

Pour ouvrir votre document Automation
  1. Ouvrez VS Code.

  2. Dans le panneau de navigation de gauche, choisissezAWSpour ouvrirAWSexplorateur.

  3. DansAWS, pourSystems Manager, choisissez l'icône de téléchargement sur le document que vous souhaitez ouvrir, puis choisissez la version du document. Le fichier s'ouvre au format correspondant à cette version. Sinon, choisissez soitTélécharger au format JSONouTélécharger au format YAML.

Note

L'enregistrement local d'un document Automation en tant que fichier dans VS Code ne le fait pas apparaître dansAWS. Il doit être publié dansAWSavant de l'exécuter.

Modification d'un document d'automatisation Systems Manager Automation

Si vous possédez des documents Automation, ils apparaissent dans lePropriété de moicatégorie de documents Systems Manager dans leAWSexplorateur. Vous pouvez posséder des documents Automation qui existent déjà dansAWS, et vous pouvez être propriétaire de documents nouveaux ou mis à jour que vous avez précédemment publiés surAWSde VS Code.

Lorsque vous ouvrez un document Automation pour le modifier dans VS Code, vous pouvez en faire plus que dans leAWS Management Console. Par exemple :

  • Il existe une validation de schéma sur les deuxJSONetYAMLFormats.

  • Des extraits sont disponibles dans l'éditeur de documents pour vous permettre de créer n'importe quel type d'étape d'automatisation.

  • La saisie semi-automatique est prise en charge pour différentes options dansJSONetYAML.

Utilisation des versions

Les documents d'automatisation de Systems Manager Automation de Automation de Automation de Vous pouvez choisir la version par défaut d'un document Automation dans VS Code.

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

    Note

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

Publication d'un document d'automatisation Systems Manager Automation

Une fois que vous avez modifié votre document Automation dans VS Code, vous pouvez le publier dansAWS.

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

  2. Apportez les modifications que vous souhaitez publier. Pour plus d'informations, consultez Modification d'un document d'automatisation Systems Manager Automation.

  3. Dans le coin supérieur droit du fichier ouvert, choisissez l'icône de chargement.

  4. Dans la boîte de dialogue du flux de travail de publication, choisissez l'AWSRégion dans laquelle vous voulez publier le document d'automatisation.

  5. Si vous publiez un nouveau document, choisissezCréation rapide. Sinon, choisissezMise à jour rapidepour mettre à jour un document Automation existant dansAWSRégion .

  6. Entrez le nom de ce document d'automatisation.

Lorsque vous publiez une mise à jour d'un document Automation existant dansAWS, une nouvelle version est ajoutée au document.

Suppression d'un document Systems Manager Automation de

Vous pouvez supprimer des documents Automation dans VS Code. 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 Automation qui a déjà été exécuté ne supprime pas leAWSressources qui ont été créées ou modifiées lors de son démarrage.

Pour supprimer votre document Automation
  1. Ouvrez VS Code.

  2. Dans le panneau de navigation de gauche, choisissezAWSpour ouvrirAWSexplorateur.

  3. DansAWS, pourSystems Manager, ouvrez le menu contextuel (clic droit) du document que vous souhaitez supprimer et choisissezSuppression du document.

Exécution d'un document Systems Manager Automation de

Une fois que votre document Automation est publié surAWS, vous pouvez l'exécuter pour exécuter des tâches en votre nom dans votreAWS. Pour exécuter votre document d'automatisation, vous pouvez utiliser la AWS Management Console, les API de Systems Manager, la 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 simpledans leAWS Systems ManagerGuide de l'utilisateur.

Sinon, si vous souhaitez utiliser l'un des kits SDK AWS avec les API de Systems Manager pour exécuter votre document d'automatisation, consultez les références du kit SDK AWS.

Note

L'exécution d'un document d'automatisation peut créer de nouvelles ressources dansAWSet peut 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 le démarrer.