• O AWS Systems Manager CloudWatch Dashboard não estará mais disponível a partir de 30 de abril de 2026. Os clientes podem continuar usando o console do Amazon CloudWatch para visualizar, criar e gerenciar os painéis do Amazon CloudWatch exatamente como fazem hoje. Para obter mais informações, consulte a [documentação do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html). 

# Variáveis de sistema de automação
<a name="automation-variables"></a>

Os runbooks do AWS Systems Manager Automation usam as variáveis a seguir. Para obter um exemplo de como essas variáveis são usadas, visualize a origem JSON do runbook `AWS-UpdateWindowsAmi`. 

**Para visualizar a origem JSON do runbook `AWS-UpdateWindowsAmi`**

1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).

1. No painel de navegação, escolha **Documents**.

1. Na lista de documentos, use a barra de pesquisa ou os números à direita da barra de pesquisa para escolher o runbook `AWS-UpdateWindowsAmi`.

1. Escolha a guia **Conteúdo**. 

**Variáveis do sistema**  
Runbooks do Automation oferecem suporte para as seguintes variáveis de sistema:


****  

| Variável | Detalhes | 
| --- | --- | 
| `global:ACCOUNT_ID` | O ID da Conta da AWS do usuário ou do perfil no qual o Automation é executado. | 
| `global:DATE` | A data (no runtime), no formato aaaa-MM-dd. | 
| `global:DATE_TIME` | A data e a hora (no runtime), no formato aaaa-MM-dd\_HH.mm.ss. | 
| `global:AWS_PARTITION` | A partição na qual o recurso está. Para Regiões da AWS padrão, a partição é `aws`. Para obter recursos em outras partições, a partição é `aws-{{partitionname}}`. Por exemplo, a partição para recursos na região da AWS GovCloud (Oeste dos EUA) é `aws-us-gov`. | 
| `global:REGION` | A região em que o runbook é executado. Por exemplo, us-east-2. | 

**Variáveis de automação**  
Runbooks do Automation oferecem suporte para as seguintes variáveis de automação:


****  

| Variável | Detalhes | 
| --- | --- | 
| `automation:EXECUTION_ID` | O identificador exclusivo atribuído à automação atual. Por exemplo, `1a2b3c-1a2b3c-1a2b3c-1a2b3c1a2b3c1a2b3c`. | 

**Topics**
+ [Terminologia](#automation-terms)
+ [Cenários compatíveis](#automation-variables-support)
+ [Cenários não compatíveis](#automation-variables-unsupported)

## Terminologia
<a name="automation-terms"></a>

Os termos a seguir descrevem como as variáveis e os parâmetros são resolvidos.


****  

| Prazo | Definição | Exemplo | 
| --- | --- | --- | 
| ARN constante | Um nome do recurso da Amazon (ARN) válido sem variáveis. | `arn:aws:iam::123456789012:role/roleName` | 
| Parâmetro do runbook | Um parâmetro definido no nível do runbook (por exemplo, `instanceId`). O parâmetro é usado em uma substituição de string básica. Seu valor é fornecido na ocasião de início da execução. |  <pre>{ <br />   "description": "Create Image Demo",<br />   "version": "0.3",<br />   "assumeRole": "{{Your_Automation_Assume_Role_ARN}}",<br />   "parameters":{ <br />      "instanceId": { <br />         "type": "String",<br />         "description": "Instance to create image from"<br />   }<br />}</pre>  | 
| Variável de sistema | Uma variável geral substituída no runbook quando uma parte dele é avaliada. |  <pre>"activities": [ <br />   { <br />      "id": "copyImage",<br />      "activityType": "AWS-CopyImage",<br />      "maxAttempts": 1,<br />      "onFailure": "Continue",<br />      "inputs": { <br />         "ImageName": "{{imageName}}",<br />         "SourceImageId": "{{sourceImageId}}",<br />         "SourceRegion": "{{sourceRegion}}",<br />         "Encrypted": true,<br />         "ImageDescription": "Test CopyImage Description created on {{global:DATE}}"<br />      }<br />   }<br />]</pre>  | 
| Variável de automação | Uma variável relativa à execução de automação substituída no runbook quando uma parte dele for avaliada. |  <pre>{ <br />   "name": "runFixedCmds",<br />   "action": "aws:runCommand",<br />   "maxAttempts": 1,<br />   "onFailure": "Continue",<br />   "inputs": { <br />      "DocumentName": "AWS-RunPowerShellScript",<br />      "InstanceIds": [ <br />         "{{LaunchInstance.InstanceIds}}"<br />      ],<br />      "Parameters": { <br />         "commands": [ <br />            "dir",<br />            "date",<br />            "“{{outputFormat}}” -f “left”,”right”,”{{global:DATE}}”,”{{automation:EXECUTION_ID}}”<br />         ]<br />      }<br />   }<br />}</pre>  | 
| Parâmetro do Systems Manager | Uma variável definida no AWS Systems Manager Parameter Store. Ele não pode ser referenciado diretamente na entrada da etapa. Podem ser necessárias permissões para acessar o parâmetro. |  <pre><br />description: Launch new Windows test instance<br />schemaVersion: '0.3'<br />assumeRole: '{{AutomationAssumeRole}}'<br />parameters:<br />  AutomationAssumeRole:<br />    type: String<br />    default: ''<br />    description: >-<br />      (Required) The ARN of the role that allows Automation to perform the<br />      actions on your behalf. If no role is specified, Systems Manager<br />      Automation uses your IAM permissions to run this runbook.<br />  LatestAmi:<br />    type: String<br />    default: >-<br />      {{ssm:/aws/service/ami-windows-latest/Windows_Server-2016-English-Full-Base}}<br />    description: The latest Windows Server 2016 AMI queried from the public parameter.<br />mainSteps:<br />  - name: launchInstance<br />    action: 'aws:runInstances'<br />    maxAttempts: 3<br />    timeoutSeconds: 1200<br />    onFailure: Abort<br />    inputs:<br />      ImageId: '{{LatestAmi}}'<br />...</pre>  | 

## Cenários compatíveis
<a name="automation-variables-support"></a>


****  

| Cenário | Comentários | Exemplo | 
| --- | --- | --- | 
| `assumeRole` de ARN constante na criação. | Uma verificação de autorização é realizada para verificar se o usuário de chamada tem permissão para transmitir a `assumeRole` especificada. |  <pre>{<br />  "description": "Test all Automation resolvable parameters",<br />  "schemaVersion": "0.3",<br />  "assumeRole": "arn:aws:iam::123456789012:role/roleName",<br />  "parameters": { <br />  ...</pre>  | 
| Parâmetro do runbook fornecido para o `AssumeRole` quando a automação é iniciada. | Devem ser definidos na lista de parâmetros do runbook. |  <pre>{<br />  "description": "Test all Automation resolvable parameters",<br />  "schemaVersion": "0.3",<br />  "assumeRole": "{{dynamicARN}}",<br />  "parameters": {<br /> ...</pre>  | 
| Valor fornecido para o parâmetro do runbook no início. | O cliente fornece o valor a ser usado para um parâmetro. Quaisquer entradas fornecidas na inicialização precisam ser definidas na lista de parâmetros do runbook. | <pre>...<br />"parameters": {<br />    "amiId": {<br />      "type": "String",<br />      "default": "{{ami-12345678}}",<br />      "description": "list of commands to run as part of first step"<br />    },<br />...</pre>As entradas para iniciar a execução da automação incluem: `{"amiId" : ["{{ami-12345678}}"] }` | 
| Parâmetro do Systems Manager referenciado no conteúdo do runbook. | A variável existe na conta do cliente ou é um parâmetro acessível publicamente, e o `AssumeRole` do runbook tem acesso à variável. Uma verificação é realizada na ocasião da criação para confirmar se `AssumeRole` tem acesso. O parâmetro não pode ser referenciado diretamente na entrada da etapa. |  <pre><br />...<br />parameters:<br />    LatestAmi:<br />    type: String<br />    default: >-<br />      {{ssm:/aws/service/ami-windows-latest/Windows_Server-2016-English-Full-Base}}<br />    description: The latest Windows Server 2016 AMI queried from the public parameter.<br />mainSteps:<br />  - name: launchInstance<br />    action: 'aws:runInstances'<br />    maxAttempts: 3<br />    timeoutSeconds: 1200<br />    onFailure: Abort<br />    inputs:<br />      ImageId: '{{LatestAmi}}'<br />...</pre>  | 
| Variável de sistema referenciada na definição de etapa | Uma variável de sistema é substituída no runbook quando a automação é iniciada. O valor injetado no runbook é relativo a quando ocorre a substituição. Ou seja, o valor de uma variável de tempo injetado na etapa 1 é diferente do valor injetado na etapa 3 devido ao tempo necessário para executar as etapas intermediárias. As variáveis do sistema não precisam ser definidas na lista de parâmetros do runbook. |  <pre>...<br />  "mainSteps": [<br />    {<br />      "name": "RunSomeCommands",<br />      "action": "aws:runCommand",<br />      "maxAttempts": 1,<br />      "onFailure": "Continue",<br />      "inputs": {<br />        "DocumentName": "AWS:RunPowerShell",<br />        "InstanceIds": ["{{LaunchInstance.InstanceIds}}"],<br />        "Parameters": {<br />            "commands" : [<br />                "echo {The time is now {{global:DATE_TIME}}}"<br />            ]<br />        }<br />    }<br />}, ... </pre>  | 
| Variável de automação referenciada na definição de etapa. | As variáveis de automação não precisam ser definidas na lista de parâmetros do runbook. A única variável de Automação com suporte é **automation:EXECUTION\_ID**. |  <pre>...<br />"mainSteps": [<br />    {<br />      "name": "invokeLambdaFunction",<br />      "action": "aws:invokeLambdaFunction",<br />      "maxAttempts": 1,<br />      "onFailure": "Continue",<br />      "inputs": {<br />        "FunctionName": "Hello-World-LambdaFunction",<br /><br />"Payload" : "{ "executionId" : "{{automation:EXECUTION_ID}}" }"<br />      }<br />    }<br />... </pre>  | 
| Consulte a saída da etapa anterior na próxima definição de etapa. | Este é o redirecionamento de parâmetros. A saída de uma etapa anterior é referenciada usando a sintaxe `{{stepName.OutputName}}`. Essa sintaxe não pode ser usada pelo cliente para parâmetros do runbook. Isso é resolvido quando a etapa de referência é executada. O parâmetro não está listado nos parâmetros do runbook. |  <pre>...<br />"mainSteps": [<br />    {<br />      "name": "LaunchInstance",<br />      "action": "aws:runInstances",<br />      "maxAttempts": 1,<br />      "onFailure": "Continue",<br />      "inputs": {<br />        "ImageId": "{{amiId}}",<br />        "MinInstanceCount": 1,<br />        "MaxInstanceCount": 2<br />      }<br />    },<br />    {<br />      "name":"changeState",<br />      "action": "aws:changeInstanceState",<br />      "maxAttempts": 1,<br />      "onFailure": "Continue",<br />      "inputs": {<br />        "InstanceIds": ["{{LaunchInstance.InstanceIds}}"],<br />        "DesiredState": "terminated"<br />      }<br />    }<br /><br />... </pre>  | 

## Cenários não compatíveis
<a name="automation-variables-unsupported"></a>


****  

| Cenário | Comentário | Exemplo | 
| --- | --- | --- | 
| Parâmetro do Systems Manager fornecido para o `assumeRole` na criação | Sem suporte. |  <pre>...<br /><br />{<br />  "description": "Test all Automation resolvable parameters",<br />  "schemaVersion": "0.3",<br />  "assumeRole": "{{{{ssm:administratorRoleARN}}}}",<br />  "parameters": {<br /><br />... </pre>  | 
| Parâmetro do Systems Manager referenciado diretamente na entrada da etapa. | Retorna a exceção `InvalidDocumentContent` no momento da criação. |  <pre><br />...<br />mainSteps:<br />  - name: launchInstance<br />    action: 'aws:runInstances'<br />    maxAttempts: 3<br />    timeoutSeconds: 1200<br />    onFailure: Abort<br />    inputs:<br />      ImageId: '{{ssm:/aws/service/ami-windows-latest/Windows_Server-2016-English-Full-Base}}'<br />...</pre>  | 
| Definição de etapa variável | A definição de uma etapa no runbook é construída por variáveis. |  <pre>...<br /><br />"mainSteps": [<br />    {<br />      "name": "LaunchInstance",<br />      "action": "aws:runInstances",<br />      "{{attemptModel}}": 1,<br />      "onFailure": "Continue",<br />      "inputs": {<br />        "ImageId": "{{ami-12345678}}",<br />        "MinInstanceCount": 1,<br />        "MaxInstanceCount": 2<br />      }<br /><br />...<br /><br />User supplies input : { "attemptModel" : "minAttempts" } </pre>  | 
| Referência cruzada de parâmetros do runbook | O usuário fornece um parâmetro de entrada na hora de início, que é uma referência a outro parâmetro no runbook. |  <pre>...<br />"parameters": {<br />    "amiId": {<br />      "type": "String",<br />      "default": "{{ami-7f2e6015}}",<br />      "description": "list of commands to run as part of first step"<br />    },<br />    "alternateAmiId": {<br />      "type": "String",<br />      "description": "The alternate AMI to try if this first fails".<br /><br />"default" : "{{amiId}}"<br />    },<br /><br />... </pre>  | 
| Expansão de vários níveis | O runbook define uma variável que é avaliada como o nome de uma variável. Ela fica dentro dos delimitadores de variáveis (ou seja, *{{ }}*) e é expandida para o valor dessa variável/parâmetro. |  <pre>...<br />  "parameters": {<br />    "{{firstParameter}}": {<br />      "type": "String",<br />      "default": "param2",<br />      "description": "The parameter to reference"<br />    },<br />    "{{secondParameter}}": {<br />      "type": "String",<br />      "default" : "echo {Hello world}",<br />      "description": "What to run"<br />    }<br />  },<br />  "mainSteps": [{<br />      "name": "runFixedCmds",<br />      "action": "aws:runCommand",<br />      "maxAttempts": 1,<br />      "onFailure": "Continue",<br />      "inputs": {<br />        "DocumentName": "AWS-RunPowerShellScript",<br /><br />"InstanceIds" : "{{LaunchInstance.InstanceIds}}",<br />        "Parameters": {<br />          "commands": [ "{{ {{firstParameter}} }}"]<br /><br />}<br /><br />...<br /><br />Note: The customer intention here would be to run a command of "echo {Hello world}" </pre>  | 
| Referenciar a saída de uma etapa do runbook que é um tipo de variável diferente | O usuário faz referência à saída de uma etapa do runbook anterior em uma etapa subsequente. A saída é um tipo de variável que não atende aos requisitos da ação na etapa subsequente. |  <pre>...<br />mainSteps:<br />- name: getImageId<br />  action: aws:executeAwsApi<br />  inputs:<br />    Service: ec2<br />    Api: DescribeImages<br />    Filters:  <br />    - Name: "name"<br />      Values: <br />      - "{{ImageName}}"<br />  outputs:<br />  - Name: ImageIdList<br />    Selector: "$.Images"<br />    Type: "StringList"<br />- name: copyMyImages<br />  action: aws:copyImage<br />  maxAttempts: 3<br />  onFailure: Abort<br />  inputs:<br />    SourceImageId: {{getImageId.ImageIdList}}<br />    SourceRegion: ap-northeast-2<br />    ImageName: Encrypted Copies of LAMP base AMI in ap-northeast-2<br />    Encrypted: true <br />... <br />Note: You must provide the type required by the Automation action. <br />In this case, aws:copyImage requires a "String" type variable but the preceding step outputs a "StringList" type variable.<br />                                        </pre>  |