Criar modelos de alteração usando ferramentas de linha de comando - AWS Systems Manager

Criar modelos de alteração usando ferramentas de linha de comando

Os procedimentos a seguir descrevem como usar o AWS Command Line Interface (AWS CLI) (no Linux,macOS ou Windows) ou o AWS Tools for Windows PowerShell para criar uma solicitação de alteração no Change Manager, um recurso do AWS Systems Manager.

Para criar um novo modelo de alteração
  1. Instale e configure a AWS CLI ou o AWS Tools for PowerShell, caso ainda não o tenha feito.

    Para obter informações, consulte Instalar ou atualizar a versão mais recente da AWS CLI e Instalar o AWS Tools for PowerShell.

  2. Crie um arquivo JSON em sua máquina local com um nome, como MyChangeTemplate.json e, em seguida, cole o conteúdo do modelo de alteração nesse arquivo.

    nota

    Os modelos de alteração usam uma versão do esquema 0.3 que não inclui o mesmo suporte dos runbooks do Automation.

    Veja um exemplo a seguir.

    nota

    O parâmetro minRequiredApprovals é usado para especificar quantos revisores em um nível especificado devem aprovar uma solicitação de alteração criada usando esse modelo.

    Este exemplo demonstra dois níveis de aprovações. Você pode especificar até cinco níveis de aprovações, mas somente um nível é necessário.

    No primeiro nível, o usuário específico "John-Doe" deve aprovar cada solicitação de alteração. Depois disso, quaisquer três membros da função do IAM Admin devem aprovar a solicitação de alteração.

    Para obter mais informações sobre aprovações para modelos de alteração, consulte Sobre as aprovações em seus modelos de alteração.

    { "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 } ] } } } ] }
  3. Execute o comando a seguir para criar o modelo de alteração.

    Linux & macOS
    aws ssm create-document \ --name MyChangeTemplate \ --document-format JSON \ --document-type Automation.ChangeTemplate \ --content file://MyChangeTemplate.json \ --tags Key=tag-key,Value=tag-value
    Windows
    aws ssm create-document ^ --name MyChangeTemplate ^ --document-format JSON ^ --document-type Automation.ChangeTemplate ^ --content file://MyChangeTemplate.json ^ --tags Key=tag-key,Value=tag-value
    PowerShell
    $json = Get-Content -Path "C:\path\to\file\MyChangeTemplate.json" | Out-String New-SSMDocument ` -Content $json ` -Name "MyChangeTemplate" ` -DocumentType "Automation.ChangeTemplate" ` -Tags "Key=tag-key,Value=tag-value"

    Para obter informações sobre outras opções que você pode especificar, consulte create-document.

    O sistema retorna informações como estas.

    {
       "DocumentDescription":{
          "CreatedDate":1.585061751738E9,
          "DefaultVersion":"1",
          "Description":"Use this template to update an EC2 Linux AMI. Requires one
          approver specified in the template and an approver specified in the request.",
          "DocumentFormat":"JSON",
          "DocumentType":"Automation",
          "DocumentVersion":"1",
          "Hash":"0d3d879b3ca072e03c12638d0255ebd004d2c65bd318f8354fcde820dEXAMPLE",
          "HashType":"Sha256",
          "LatestVersion":"1",
          "Name":"MyChangeTemplate",
          "Owner":"123456789012",
          "Parameters":[
             {
                "DefaultValue":"",
                "Description":"Level one approvers",
                "Name":"LevelOneApprovers",
                "Type":"String"
             },
             {
                "DefaultValue":"",
                "Description":"Level one approver type",
                "Name":"LevelOneApproverType",
                "Type":"String"
             },
       "cloudWatchMonitors": {
          "monitors": [
             "my-cloudwatch-alarm"
          ]
       }
          ],
          "PlatformTypes":[
             "Windows",
             "Linux"
          ],
          "SchemaVersion":"0.3",
          "Status":"Creating",
          "Tags":[
    
          ]
       }
    }

Os usuários em sua organização ou conta que foram especificados como revisores de modelo na guia Settings (Configurações) do Change Manager serão notificados de que um novo modelo de alteração está com a revisão pendente.

Se um tópico do Amazon Simple Notification Service (Amazon SNS) tiver sido especificado para modelos de alteração, as notificações serão enviadas quando o modelo de alteração for rejeitado ou aprovado. Se você não receber notificações relacionadas a este modelo de alteração, retorne ao Change Manager mais tarde para verificar seu status.