Création de modèles de modifications à l'aide de l'éditeur - AWS Systems Manager

Création de modèles de modifications à l'aide de l'éditeur

Suivez les étapes de cette rubrique pour configurer un modèle de modification dans Change Manager, un outil d’AWS Systems Manager, en saisissant JSON ou YAML au lieu d’utiliser les commandes de la console.

Pour créer un modèle de modification à l'aide d'Editor

  1. Dans le panneau de navigation, sélectionnez Change Manager.

  2. Sélectionnez Create template (Créer un modèle).

  3. Pour Name (Nom), saisissez un nom pour le modèle permettant d'identifier sa fonction, RestartEC2LinuxInstance par exemple.

  4. Au-dessus de Change template details (Détails du modèle de modification), sélectionnez Editor (Éditeur).

  5. Dans la section Document editor (Éditeur de document), sélectionnez Edit (Modifier), puis saisissez le contenu JSON ou YAML pour votre modèle de modification.

    Voici un exemple.

    Note

    Le paramètre minRequiredApprovals permet de spécifier combien de réviseurs à un niveau spécifié doivent approuver une demande de modification créée à l'aide de ce modèle.

    Cet exemple illustre deux niveaux d'approbation. Vous pouvez spécifier jusqu'à cinq niveaux d'approbation, mais un seul niveau est requis.

    Au premier niveau, l'utilisateur spécifique « John-Doe » doit approuver chaque demande de modification. Après cela, trois membres du rôle de l'IAM Admin doivent approuver la demande de modification.

    Pour plus d'informations sur les modèles de modification, consultez À propos des approbations dans vos modèles de modification.

    YAML
    description: >-
  This change template demonstrates the feature set available for creating
  change templates for Change Manager. This template starts a Runbook workflow
  for the Automation runbook called AWS-HelloWorld.
templateInformation: >
  ### Document Name: HelloWorldChangeTemplate

  ## What does this document do?

  This change template demonstrates the feature set available for creating
  change templates for Change Manager. This template starts a Runbook workflow
  for the Automation runbook called AWS-HelloWorld.

  ## Input Parameters

  * ApproverSnsTopicArn: (Required) Amazon Simple Notification Service ARN for
  approvers.

  * Approver: (Required) The name of the approver to send this request to.

  * ApproverType: (Required) The type of reviewer.
    * Allowed Values: IamUser, IamGroup, IamRole, SSOGroup, SSOUser

  ## Output Parameters

  This document has no outputs
schemaVersion: '0.3'
parameters:
  ApproverSnsTopicArn:
    type: String
    description: Amazon Simple Notification Service ARN for approvers.
  Approver:
    type: String
    description: IAM approver
  ApproverType:
    type: String
    description: >-
      Approver types for the request. Allowed values include IamUser, IamGroup,
      IamRole, SSOGroup, and SSOUser.
executableRunBooks:
  - name: AWS-HelloWorld
    version: '1'
emergencyChange: false
autoApprovable: false
mainSteps:
  - name: ApproveAction1
    action: 'aws:approve'
    timeoutSeconds: 3600
    inputs:
      Message: >-
        A sample change request has been submitted for your review in Change
        Manager. You can approve or reject this request.
      EnhancedApprovals:
        NotificationArn: '{{ ApproverSnsTopicArn }}'
        Approvers:
          - approver: John-Doe
            type: IamUser
            minRequiredApprovals: 1
  - name: ApproveAction2
    action: 'aws:approve'
    timeoutSeconds: 3600
    inputs:
      Message: >-
        A sample change request has been submitted for your review in Change
        Manager. You can approve or reject this request.
      EnhancedApprovals:
        NotificationArn: '{{ ApproverSnsTopicArn }}'
        Approvers:
          - approver: Admin
            type: IamRole
            minRequiredApprovals: 3
    JSON
    {
   "description": "This change template demonstrates the feature set available for creating
  change templates for Change Manager. This template starts a Runbook workflow
  for the Automation runbook called AWS-HelloWorld",
   "templateInformation": "### Document Name: HelloWorldChangeTemplate\n\n
    ## What does this document do?\n
    This change template demonstrates the feature set available for creating change templates for Change Manager. 
    This template starts a Runbook workflow for the Automation runbook called AWS-HelloWorld.\n\n
    ## Input Parameters\n* ApproverSnsTopicArn: (Required) Amazon Simple Notification Service ARN for approvers.\n
    * Approver: (Required) The name of the approver to send this request to.\n
    * ApproverType: (Required) The type of reviewer.  * Allowed Values: IamUser, IamGroup, IamRole, SSOGroup, SSOUser\n\n
    ## Output Parameters\nThis document has no outputs\n",
   "schemaVersion": "0.3",
   "parameters": {
      "ApproverSnsTopicArn": {
         "type": "String",
         "description": "Amazon Simple Notification Service ARN for approvers."
      },
      "Approver": {
         "type": "String",
         "description": "IAM approver"
      },
      "ApproverType": {
         "type": "String",
         "description": "Approver types for the request. Allowed values include IamUser, IamGroup, IamRole, SSOGroup, and SSOUser."
      }
   },
   "executableRunBooks": [
      {
         "name": "AWS-HelloWorld",
         "version": "1"
      }
   ],
   "emergencyChange": false,
   "autoApprovable": false,
   "mainSteps": [
      {
         "name": "ApproveAction1",
         "action": "aws:approve",
         "timeoutSeconds": 3600,
         "inputs": {
            "Message": "A sample change request has been submitted for your review in Change Manager. You can approve or reject this request.",
            "EnhancedApprovals": {
               "NotificationArn": "{{ ApproverSnsTopicArn }}",
               "Approvers": [
                  {
                     "approver": "John-Doe",
                     "type": "IamUser",
                     "minRequiredApprovals": 1
                  }
               ]
            }
         }
      },
        {
         "name": "ApproveAction2",
         "action": "aws:approve",
         "timeoutSeconds": 3600,
         "inputs": {
            "Message": "A sample change request has been submitted for your review in Change Manager. You can approve or reject this request.",
            "EnhancedApprovals": {
               "NotificationArn": "{{ ApproverSnsTopicArn }}",
               "Approvers": [
                  {
                     "approver": "Admin",
                     "type": "IamRole",
                     "minRequiredApprovals": 3                  
                  }
               ]
            }
         }
      }
   ]
}

  6. Sélectionnez Save and preview (Enregistrer et prévisualiser).

  7. Vérifiez les détails du modèle de modification que vous créez.

    Si vous voulez apporter des modifications au modèle de modification avant de l'envoyer en vérification, sélectionnez Actions, Edit (Actions, modifier).

    Si le contenu du modèle de modification vous convient, sélectionnez Submit for review (Envoyer en vérification). Les utilisateurs de votre organisation ou de votre compte qui ont été spécifiés comme vérificateurs de modèles sous l'onglet Settings (Paramètres) dans Change Manager sont informés qu'un nouveau modèle de modification est en attente de vérification.

    Si une rubrique Amazon Simple Notification Service (Amazon SNS) a été spécifiée pour les modèles de modifications, des notifications sont envoyées lorsque le modèle de modification est rejeté ou approuvé. Si vous ne recevez pas de notifications liées à ce modèle de modification, vous pouvez revenir à Change Manager plus tard afin de vérifier son statut.