• 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). 

# Referência de plug-ins de documentos de comando
<a name="documents-command-ssm-plugin-reference"></a>

Essa referência descreve os plugins que você pode especificar em um documento de comando do AWS Systems Manager (SSM). Esses plugins não podem ser usados em documentos de automação do SSM que usam ações de automação. Para obter informações sobre ações de automação do AWS Systems Manager, consulte [Referência de ações do Systems Manager Automation](automation-actions.md).

O Systems Manager determina as ações a serem executadas em uma instância gerenciada lendo o conteúdo de um documento do SSM. Todo documento contém uma seção de execução de código. Dependendo da versão do esquema do documento, essa seção de execução de código pode conter um ou mais plugins ou etapas. Para a finalidade deste tópico da Ajuda, plugins e etapas são chamados de *plugins*. Esta seção inclui informações sobre cada um dos plugins do Systems Manager. Para obter mais informações sobre documentos, incluindo informações sobre a criação de documentos e as diferenças entre as versões de esquema, consulte [Documentos do AWS Systems Manager](documents.md).

Para plug-ins que aceitam parâmetros String, como `aws:runShellScript` e `aws:runPowerShellScript`, o parâmetro `interpolationType` pode ser usado para aumentar a segurança, tratando as entradas de parâmetros como literais de string em vez de comandos potencialmente executáveis. Por exemplo:

```
{
    "schemaVersion": "2.2",
    "description": "runShellScript with command strings stored as Parameter Store parameter",
    "parameters": {
      "commands": {
        "type": "StringList",
        "description": "(Required) The commands to run on the instance.",
        "default": ["{{ ssm:myShellCommands }}"],
        "interpolationType" : "ENV_VAR"
      }
    },
    //truncated
 }
```

**nota**  
Alguns dos plugins descritos aqui são executados apenas em instâncias do Windows Server ou em instâncias do Linux. São indicadas dependências de plataforma para cada plugin.   
Os plugins de documento a seguir são compatíveis com instâncias do Amazon Elastic Compute Cloud (Amazon EC2) para o macOS:  
`aws:refreshAssociation`
`aws:runShellScript`
`aws:runPowerShellScript`
`aws:softwareInventory`
`aws:updateSsmAgent`

**Topics**
+ [Entradas compartilhadas](#shared-inputs)
+ [`aws:applications`](#aws-applications)
+ [`aws:cloudWatch`](#aws-cloudWatch)
+ [`aws:configureDocker`](#aws-configuredocker)
+ [`aws:configurePackage`](#aws-configurepackage)
+ [`aws:domainJoin`](#aws-domainJoin)
+ [`aws:downloadContent`](#aws-downloadContent)
+ [`aws:psModule`](#aws-psModule)
+ [`aws:refreshAssociation`](#aws-refreshassociation)
+ [`aws:runDockerAction`](#aws-rundockeraction)
+ [`aws:runDocument`](#aws-rundocument)
+ [`aws:runPowerShellScript`](#aws-runPowerShellScript)
+ [`aws:runShellScript`](#aws-runShellScript)
+ [`aws:softwareInventory`](#aws-softwareinventory)
+ [`aws:updateAgent`](#aws-updateagent)
+ [`aws:updateSsmAgent`](#aws-updatessmagent)

## Entradas compartilhadas
<a name="shared-inputs"></a>

comSSM Agentversão 3.0.502 e posterior somente, todos os plugins podem usar as seguintes entradas:

**finallyStep**  
A última etapa que você deseja que o documento seja executado. Se essa entrada for definida para uma etapa, ela terá precedência sobre um`exit`especificado no parâmetro`onFailure`ou`onSuccess`entradas. Para que uma etapa com essa entrada seja executada conforme esperado, a etapa deve ser a última definida no`mainSteps`do documento.  
Tipo: booliano  
Valores válidos: `true` \$1 `false`  
Obrigatório: não

**onFailure**  
Se você especificar esta entrada para um plugin com a opção`exit`e a etapa falhar, o status da etapa reflete a falha e o documento não executa as etapas restantes, a menos que um`finallyStep`foi definido. Se você especificar esta entrada para um plugin com a opção`successAndExit`e a etapa falhar, o status da etapa mostra bem-sucedida e o documento não executa as etapas restantes, a menos que um`finallyStep`foi definido.  
Tipo: string  
Valores válidos: `exit` \$1 `successAndExit`  
Obrigatório: não

**onSuccess**  
Se você especificar essa entrada para um plugin e a etapa for executada com êxito, o documento não executará nenhuma etapa restante, a menos que um`finallyStep`foi definido.  
Tipo: string  
Valores válidos: `exit`  
Obrigatório: não

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: Shared inputs example
parameters:
  customDocumentParameter:
    type: String
    description: Example parameter for a custom Command-type document.
mainSteps:
- action: aws:runDocument
  name: runCustomConfiguration
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomDocument"
    documentParameters: '"documentParameter":{{customDocumentParameter}}'
    onSuccess: exit
- action: aws:runDocument
  name: ifConfigurationFailure
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomRepairDocument"
    onFailure: exit
- action: aws:runDocument
  name: finalConfiguration
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomFinalDocument"
    finallyStep: true
```

------
#### [ JSON ]

```
{
   "schemaVersion": "2.2",
   "description": "Shared inputs example",
   "parameters": {
      "customDocumentParameter": {
         "type": "String",
         "description": "Example parameter for a custom Command-type document."
      }
   },
   "mainSteps":[
      {
         "action": "aws:runDocument",
         "name": "runCustomConfiguration",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomDocument",
            "documentParameters": "\"documentParameter\":{{customDocumentParameter}}",
            "onSuccess": "exit"
         }
      },
      {
         "action": "aws:runDocument",
         "name": "ifConfigurationFailure",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomRepairDocument",
            "onFailure": "exit"
         }
      },
      {
         "action": "aws:runDocument",
         "name":"finalConfiguration",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomFinalDocument",
            "finallyStep": true
         }
      }
   ]
}
```

------

## `aws:applications`
<a name="aws-applications"></a>

Instala, repara ou desinstala aplicativos em uma instância do EC2. Este plugin é executado somente em sistemas operacionais Windows Server.

### Sintaxe
<a name="applications-syntax"></a>

#### Esquema 2.2
<a name="applications-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:applications plugin
parameters:
  source:
    description: "(Required) Source of msi."
    type: String
mainSteps:
- action: aws:applications
  name: example
  inputs:
    action: Install
    source: "{{ source }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion":"2.2",
  "description":"aws:applications",
  "parameters":{
    "source":{
    "description":"(Required) Source of msi.",
    "type":"String"
    }
  },
  "mainSteps":[
    {
      "action":"aws:applications",
      "name":"example",
      "inputs":{
        "action":"Install",
        "source":"{{ source }}"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="applications-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:applications:
    properties:
    - id: 0.aws:applications
      action: "{{ action }}"
      parameters: "{{ parameters }}"
      source: "{{ source }}"
      sourceHash: "{{ sourceHash }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:applications":{
         "properties":[
            {
               "id":"0.aws:applications",
               "action":"{{ action }}",
               "parameters":"{{ parameters }}",
               "source":"{{ source }}",
               "sourceHash":"{{ sourceHash }}"
            }
         ]
      }
   }
}
```

------

### Propriedades
<a name="applications-properties"></a>

**ação**  
A medida a ser tomada.  
Tipo: Enum  
Valores válidos: `Install` \$1 `Repair` \$1 `Uninstall`  
Obrigatório: Sim

**parameters**  
Os parâmetros para o instalador.  
Tipo: string  
Obrigatório: não

**origem**  
O URL do arquivo `.msi` para o aplicativo.  
Tipo: String  
Exigido: sim

**sourceHash**  
O hash SHA256 do arquivo `.msi`.  
Tipo: string  
Obrigatório: não

## `aws:cloudWatch`
<a name="aws-cloudWatch"></a>

Exporte dados do Windows Server para o Amazon CloudWatch ou Amazon CloudWatch Logs e monitore os dados usando as métricas do CloudWatch. Este plugin é executado somente em sistemas operacionais Windows Server. Para obter mais informações sobre como configurar a integração do CloudWatch, ao Amazon Elastic Compute Cloud (Amazon EC2) consulte [Coletar métricas, logs e rastreamentos com o atendente do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html) no *Guia de usuário do Amazon CloudWatch*.

**Importante**  
O atendente unificado do CloudWatch substituiu SSM Agent como a ferramenta para enviar dados de log para o Amazon CloudWatch Logs. Não há compatibilidade com o plugin aws:cloudWatch do SSM Agent. Recomendamos usar somente o atendente do CloudWatch unificado nos processos de coleta de logs. Para saber mais, consulte os seguintes tópicos:  
[Enviar logs de nós para o CloudWatch Logs unificado (agente do CloudWatch)](monitoring-cloudwatch-agent.md)
[Migrar a coleta de logs de nós do Windows Server para o agente do CloudWatch](monitoring-cloudwatch-agent.md#monitoring-cloudwatch-agent-migrate)
[Coletar métricas, logs e rastreamentos com o atendente do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html) no *Guia do usuário do Amazon CloudWatch*.

Você pode exportar e monitorar os seguintes tipos de dados:

**ApplicationEventLog**  
Envia dados de log de eventos da aplicação para o CloudWatch Logs.

**CustomLogs**  
Envia qualquer arquivo de log baseado em texto para o Amazon CloudWatch Logs. O plugin do CloudWatch cria uma impressão digital para os arquivos de log. O sistema associa então um deslocamento de dados com cada impressão digital. O plugin faz upload dos arquivos quando há alterações, registra o deslocamento e associa o deslocamento com uma impressão digital. Esse método é usado para evitar uma situação em que um usuário ativa o plugin, associa o serviço com um diretório que contém um grande número de arquivos, e o sistema faz upload de todos os arquivos.  
Lembre-se de que, se seu aplicativo truncar ou tentar limpar os logs durante a sondagem, qualquer log especificado para `LogDirectoryPath` pode perder entradas. Se, por exemplo, você quiser limitar o tamanho do arquivo de log, crie um novo arquivo de log quando o limite for atingido e continue a gravar dados no novo arquivo.

**ETW**  
Envia os dados de rastreamento de eventos para Windows (ETW) ao CloudWatch Logs.

**IIS**  
Envia dados de log do IIS ao CloudWatch Logs.

**PerformanceCounter**  
Envia contadores de performance do Windows para o CloudWatch. Você poderá selecionar categorias diferentes para fazer upload no CloudWatch como métricas. Para cada contador de performance que você deseja carregar, crie uma seção **PerformanceCounter** com um ID exclusivo (por exemplo, "PerformanceCounter2", "PerformanceCounter3" e assim por diante) e configure as respectivas propriedades.  
Se o AWS Systems Manager SSM Agent ou o plugin do CloudWatch for interrompido, os dados do contador de performance não serão registrados em log no CloudWatch. Esse comportamento é diferente daquele dos logs personalizados ou dos logs de eventos do Windows. Os logs personalizados e logs de eventos do Windows preservarão dados do contador de performance e farão upload dos dados no CloudWatch depois que o SSM Agent ou o plugin do CloudWatch estiver disponível.

**SecurityEventLog**  
Envia dados de log de eventos de segurança para o CloudWatch Logs.

**SystemEventLog**  
Envia dados de log de eventos de sistema ao CloudWatch Logs

Você pode definir os seguintes destinos para os dados:

**CloudWatch**  
O destino para o qual os dados de métrica do contador de performance são enviados. Você pode incluir mais seções com IDs exclusivos (por exemplo, "CloudWatch2", "CloudWatch3" etc.) e especificar uma região diferente para cada novo ID a fim de enviar os mesmos dados para diferentes locais.

**CloudWatchLogs**  
O destino para o qual os dados de log são enviados. Você pode incluir mais seções com IDs exclusivos (por exemplo, "CloudWatchLogs2", "CloudWatchLogs3" etc.) e especificar uma região diferente para cada novo ID a fim de enviar os mesmos dados para diferentes locais.

### Sintaxe
<a name="cloudWatch-syntax"></a>

```
"runtimeConfig":{
        "aws:cloudWatch":{
            "settings":{
                "startType":"{{ status }}"
            },
            "properties":"{{ properties }}"
        }
    }
```

### Configurações e propriedades
<a name="cloudWatch-properties"></a>

**AccessKey**  
Sua ID de chave de acesso. Essa propriedade é obrigatória, a menos que você tenha lançado sua instância usando uma função do IAM. Essa propriedade não pode ser usada com o SSM.  
Tipo: string  
Obrigatório: não

**CategoryName**  
A categoria de contador de performance no Performance Monitor.  
Tipo: String  
Exigido: sim

**CounterName**  
O nome do contador de performance no Performance Monitor.  
Tipo: String  
Exigido: sim

**CultureName**  
O local em que o time stamp é registrado. Se **CultureName** estiver em branco, o mesmo local usado atualmente por sua instância do Windows Server será usado como o padrão.  
Tipo: string  
Valores válidos: para obter uma lista de valores comportados, consulte [National Language Support (NLS)](https://msdn.microsoft.com/en-us/library/cc233982.aspx) no site da Microsoft. Os valores **div**, **div-MV**, **hu** e **hu-HU** não são compatíveis.  
Obrigatório: não

**DimensionName**  
Uma dimensão para sua métrica do Amazon CloudWatch. Se você especificar `DimensionName`, também deverá especificar `DimensionValue`. Esses parâmetros produzem outro modo de exibição para a listagem de métricas. Você pode usar a mesma dimensão para várias métricas de modo a visualizar todas as métricas que pertencem a uma dimensão específica.  
Tipo: string  
Obrigatório: não

**DimensionValue**  
Um valor de dimensão para a métrica do Amazon CloudWatch.  
Tipo: string  
Obrigatório: não

**Codificação**  
A codificação de arquivo a ser usada (por exemplo, UTF-8). Use o nome da codificação, não o nome da exibição.  
Tipo: string  
Valores válidos: para obter uma lista de valores comportados, consulte [Encoding Class](https://learn.microsoft.com/en-us/dotnet/api/system.text.encoding?view=net-7.0) na biblioteca Microsoft Learn.  
Obrigatório: Sim

**Filtro**  
O prefixo dos nomes de log. Deixe esse parâmetro em branco para monitorar todos os arquivos.  
Tipo: string  
Valores válidos: para obter uma lista de valores compatíveis, consulte [FileSystemWatcherFilter property](http://msdn.microsoft.com/en-us/library/system.io.filesystemwatcher.filter.aspx) na biblioteca do MSDN.  
Obrigatório: não

**Fluxos**  
Cada tipo de dados para fazer upload, bem como o destino dos dados (CloudWatch ou CloudWatch Logs). Por exemplo, para enviar um contador de performance definido de acordo com `"Id": "PerformanceCounter"` para o destino do CloudWatch definido em `"Id": "CloudWatch"`, insira **"PerformanceCounter,CloudWatch"**. Da mesma forma, para enviar o log personalizado, o log do ETW e o log do sistema para o destino do CloudWatch Logs definido em `"Id": "ETW"`, insira **“(ETW),CloudWatchLogs”**. Além disso, é possível enviar o mesmo contador de performance ou arquivo de log para mais de um destino. Por exemplo, para enviar o log do aplicativo para dois destinos diferentes que você definiu em `"Id": "CloudWatchLogs"` e `"Id": "CloudWatchLogs2"`, insira **"ApplicationEventLog, (CloudWatchLogs, CloudWatchLogs2)"**.  
Tipo: string  
Valores válidos (origem): `ApplicationEventLog` \$1 `CustomLogs` \$1 `ETW` \$1 `PerformanceCounter` \$1 `SystemEventLog` \$1 `SecurityEventLog`   
Valores válidos (destino): `CloudWatch` \$1 `CloudWatchLogs` \$1 `CloudWatch`*n* \$1 `CloudWatchLogs`*n*   
Obrigatório: Sim

**FullName**  
O nome completo do componente.  
Tipo: String  
Exigido: sim

**Id**  
Identifica a origem de dados ou o destino. Esse identificador deve ser exclusivo no arquivo de configuração.  
Tipo: String  
Exigido: sim

**InstanceName**  
O nome da instância do contador de performance. Não use um asterisco (\$1) para indicar todas as instâncias, pois cada componente do contador de performance só é compatível com uma única métrica. Você pode, porém, usar **\$1Total**.  
Tipo: String  
Exigido: sim

**Níveis**  
Os tipos de mensagem a enviar para o Amazon CloudWatch.  
Tipo: string  
Valores válidos:   
+ **1** - Somente o upload de mensagens de erro.
+ **2** - Somente o upload de mensagens de aviso.
+ **4** - Somente o upload de mensagens de informação.
Observe que você pode adicionar valores para incluir mais de um tipo de mensagem. Por exemplo, **3** significa que mensagens de erro (**1**) e mensagens de aviso (**2**) estão incluídas. Um valor de **7** significa que mensagens de erro (**1**), mensagens de aviso (**2**) e mensagens informativas (**4**) estão incluídas.  
Obrigatório: Sim  
Os logs de segurança do Windows devem definir os níveis como 7.

**LineCount**  
O número de linha no cabeçalho para identificar o arquivo de log. Por exemplo, os arquivos de log do IIS têm cabeçalhos praticamente idênticos. Você pode especificar **3**, que leria as três primeiras linhas do cabeçalho do arquivo de log para identificá-lo. Em arquivos de log do IIS, a terceira linha é o time stamp que é diferente entre arquivos de log.  
Tipo: inteiro  
Obrigatório: não

**LogDirectoryPath**  
Em CustomLogs, o caminho em que os logs são armazenados na instância do EC2. Para logs do IIS, a pasta em que os logs do IIS são armazenados para um site específico (por exemplo, **C:\$1\$1inetpub\$1\$1logs\$1\$1LogFiles\$1\$1W3SVC*n***). Para logs do IIS, somente o formato de log W3C é comportado. Não há suporte para os formatos IIS, NCSA e Personalizado.   
Tipo: String  
Exigido: sim

**LogGroup**  
O nome para o seu grupo de logs. Esse nome é exibido na tela **Log Groups** (Grupos de logs) no console do CloudWatch.  
Tipo: String  
Exigido: sim

**LogName**  
O nome do arquivo de log.  

1. Para encontrar o nome do log, no Visualizador de Eventos, no painel de navegação, clique em **Logs de aplicações e serviços**.

1. Na lista de logs, clique com o botão direito do mouse no log do qual você deseja fazer upload (por exemplo, `Microsoft` > `Windows` > `Backup` > `Operational`) e clique em **Criar Modo de Exibição Personalizado**.

1. Na caixa de diálogo **Create Custom View** (Criar modo de exibição personalizado), selecione a guia **XML**. O **LogName** está na tag <Select Path=> (por exemplo, `Microsoft-Windows-Backup`). Copie o texto para o parâmetro **LogName**.
Tipo: string  
Valores válidos: `Application` \$1 `Security` \$1 `System` \$1 `Microsoft-Windows-WinINet/Analytic`  
Obrigatório: Sim

**LogStream**  
O fluxo de logs de destino. Se você usar **\$1instance\$1id\$1**, o padrão, o ID de instância dessa instância será usado como nome do fluxo de logs.  
Tipo: string  
Valores válidos: `{instance_id}` \$1 `{hostname}` \$1 `{ip_address}` *<log\$1stream\$1name>*  
Se você especificar o nome de uma transmissão de log que ainda não existe, o CloudWatch Logs a criará automaticamente. Você pode usar uma cadeia de caracteres literal ou as variáveis predefinidas (**\$1instance\$1id\$1**, **\$1hostname\$1**, **\$1ip\$1address\$1**, ou uma combinação das três, para definir um nome de fluxo de log.  
O nome da transmissão de logs especificado nesse parâmetro aparece na tela **Log Groups > Streams for *<YourLogStream>*** (Grupos de logs > Transmissões para <SuaTransmissãoDeLogs>) no console do CloudWatch.  
Obrigatório: Sim

**MetricName**  
A métrica do CloudWatch na qual você deseja que os dados de performance sejam incluídos.  
Não use caracteres especiais no nome. Caso contrário, a métrica e os alarmes associados podem não funcionar.
Tipo: String  
Exigido: sim

**NameSpace**  
O namespace da métrica em que você deseja que os dados do contador de performance sejam gravados.  
Tipo: String  
Exigido: sim

**PollInterval**  
Quantos segundos devem transcorrer para que seja feito upload do novo contador de performance e dos dados de log.  
Tipo: inteiro  
Valores válidos: defina como 5 ou mais segundos. É recomendável 15 segundos (00:00:15).  
Obrigatório: Sim

**Região**  
A Região da AWS para a qual você deseja enviar dados de log. Embora seja possível enviar contadores de performance para uma região diferente daquela para onde você envia os dados de log, recomendamos que você defina esse parâmetro como a mesma região onde sua instância está sendo executada.  
Tipo: string  
Valores válidos: IDs de regiões do Regiões da AWS suportado pelo Systems Manager e pelo CloudWatch Logs, como `us-east-2`, `eu-west-1` e `ap-southeast-1`. Para listas de Regiões da AWS com suporte por cada serviço, consulte [Amazon CloudWatch Logs Service Endpoints](https://docs.aws.amazon.com/general/latest/gr/cwl_region.html#cwl_region) e [Systems Manager service endpoints](https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) no *Referência geral da Amazon Web Services*.   
Obrigatório: Sim

**SecretKey**  
Sua chave de acesso secreta. Essa propriedade é obrigatória, a menos que você tenha lançado sua instância usando uma função do IAM.  
Tipo: string  
Obrigatório: não

**startType**  
Ative ou desative o CloudWatch na instância.  
Tipo: string  
Valores válidos: `Enabled` \$1 `Disabled`  
Obrigatório: Sim

**TimestampFormat**  
O formato time stamp que você deseja usar. Para obter uma lista de valores compatíveis, consulte [Cadeias de caracteres de formato de data e hora personalizado](http://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx) na biblioteca do MSDN.  
Tipo: String  
Exigido: sim

**TimeZoneKind**  
Fornece informações de fuso horário quando essas informações não estiverem incluídas no time stamp do log. Se esse parâmetro for deixado em branco e se o carimbo de data/hora não incluir informações de fuso horário, o CloudWatch Logs adotará como padrão o fuso horário local. Esse parâmetro será ignorado se o carimbo já incluir informações de fuso horário.  
Tipo: string  
Valores válidos: `Local` \$1 `UTC`  
Obrigatório: não

**Unidade**  
A unidade de medida adequada para a métrica.  
Tipo: string  
Valores válidos: segundos \$1 microssegundos \$1 milissegundos \$1 bytes \$1 kilobytes \$1 megabytes \$1 gigabytes \$1 terabytes \$1 bits \$1 kilobits \$1 megabits \$1 gigabits \$1 terabits \$1 porcentagem \$1 contagem \$1 bytes/segundo \$1 kilobytes/segundo \$1 megabytes/segundo \$1 gigabytes/segundo \$1 terabytes/segundo \$1 bits/segundo \$1 kilobits/segundo \$1 megabits/segundo \$1 gigabits/segundo \$1 terabits/segundo \$1 contagem/segundos \$1 nenhum.  
Obrigatório: Sim

## `aws:configureDocker`
<a name="aws-configuredocker"></a>

(Esquema versão 2.0 ou posterior) configura uma instância para trabalhar com contêineres e o docker. Este plug-in é compatível com a maioria das variantes do Linux e sistemas operacionais Windows Server.

### Sintaxe
<a name="configuredocker-syntax"></a>

#### Esquema 2.2
<a name="configuredocker-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:configureDocker
parameters:
  action:
    description: "(Required) The type of action to perform."
    type: String
    default: Install
    allowedValues:
    - Install
    - Uninstall
mainSteps:
- action: aws:configureDocker
  name: configureDocker
  inputs:
    action: "{{ action }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:configureDocker plugin",
  "parameters": {
    "action": {
      "description": "(Required) The type of action to perform.",
      "type": "String",
      "default": "Install",
      "allowedValues": [
        "Install",
        "Uninstall"
      ]
    }
  },
  "mainSteps": [
    {
      "action": "aws:configureDocker",
      "name": "configureDocker",
      "inputs": {
        "action": "{{ action }}"
      }
    }
  ]
}
```

------

### Entradas
<a name="configuredocker-properties"></a>

**ação**  
O tipo de ação a ser executada.  
Tipo: Enum  
Valores válidos: `Install` \$1 `Uninstall`  
Obrigatório: Sim

## `aws:configurePackage`
<a name="aws-configurepackage"></a>

(Esquema versão 2.0 ou posterior) Instale ou desinstale um pacote do AWS Systems Manager Distributor. Você pode instalar a versão mais recente, a versão padrão ou uma versão especificada do pacote. Os pacotes fornecidos pela AWS também são compatíveis. Este plugin é executado nos sistemas operacionais Windows Server e Linux, mas nem todos os pacotes disponíveis são compatíveis com sistemas operacionais Linux.

Pacotes da AWS disponíveis para Windows Server incluem o seguinte: `AWSPVDriver`, `AWSNVMe`, `AwsEnaNetworkDriver`, `AwsVssComponents`, `AmazonCloudWatchAgent`, `CodeDeployAgent`, e `AWSSupport-EC2Rescue.`

Os pacotes disponíveis da AWS para sistemas operacionais Linux incluem o seguinte: `AmazonCloudWatchAgent`, `CodeDeployAgent` `AWSSupport-EC2Rescue`.

### Sintaxe
<a name="configurepackage-syntax"></a>

#### Esquema 2.2
<a name="configurepackage-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:configurePackage
parameters:
  name:
    description: "(Required) The name of the AWS package to install or uninstall."
    type: String
  action:
    description: "(Required) The type of action to perform."
    type: String
    default: Install
    allowedValues:
    - Install
    - Uninstall
  ssmParameter:
    description: "(Required) Argument stored in Parameter Store."
    type: String
    default: "{{ ssm:parameter_store_arg }}"
mainSteps:
- action: aws:configurePackage
  name: configurePackage
  inputs:
    name: "{{ name }}"
    action: "{{ action }}"
    additionalArguments: 
      "{\"SSM_parameter_store_arg\": \"{{ ssmParameter }}\", \"SSM_custom_arg\": \"myValue\"}"
```

------
#### [ JSON ]

```
{
   "schemaVersion": "2.2",
   "description": "aws:configurePackage",
   "parameters": {
      "name": {
         "description": "(Required) The name of the AWS package to install or uninstall.",
         "type": "String"
      },
      "action": {
         "description": "(Required) The type of action to perform.",
         "type": "String",
         "default": "Install",
         "allowedValues": [
            "Install",
            "Uninstall"
         ]
      },
      "ssmParameter": {
         "description": "(Required) Argument stored in Parameter Store.",
         "type": "String",
         "default": "{{ ssm:parameter_store_arg }}"
      }
   },
   "mainSteps": [
      {
         "action": "aws:configurePackage",
         "name": "configurePackage",
         "inputs": {
            "name": "{{ name }}",
            "action": "{{ action }}",
            "additionalArguments": "{\"SSM_parameter_store_arg\": \"{{ ssmParameter }}\", \"SSM_custom_arg\": \"myValue\"}"
         }
      }
   ]
}
```

------

### Entradas
<a name="configurepackage-properties"></a>

**name**  
O nome do pacote da AWS a ser instalado ou desinstalado. Os pacotes disponíveis incluem o seguinte: `AWSPVDriver`, `AwsEnaNetworkDriver`, `AwsVssComponents` e `AmazonCloudWatchAgent`.  
Tipo: String  
Exigido: sim

**ação**  
Instala ou desinstala um pacote.  
Tipo: Enum  
Valores válidos: `Install` \$1 `Uninstall`  
Obrigatório: Sim

**installationType**  
O tipo de instalação a ser executada. Se você especificar `Uninstall and reinstall`, o pacote será completamente desinstalado e, depois, reinstalado. A aplicação estará indisponível até que a reinstalação seja concluída. Se você especificar `In-place update`, somente arquivos novos ou alterados serão adicionados à instalação existente de acordo com as instruções fornecidas em um script de atualização. O aplicativo permanece disponível durante todo o processo de atualização. O`In-place update`A opção não tem suporte paraAWS-pacotes publicados.`Uninstall and reinstall`é o valor padrão.  
Tipo: Enum  
Valores válidos: `Uninstall and reinstall` \$1 `In-place update`  
Obrigatório: não

**additionalArguments**  
Uma string JSON dos parâmetros adicionais a serem fornecidos aos scripts de instalação, desinstalação ou atualização. Cada parâmetro deve ser prefixado com `SSM_`. Você pode fazer referência a um parâmetro Parameter Store em seus argumentos adicionais usando a convenção `{{ssm:parameter-name}}`. Para usar o parâmetro adicional em seu script de instalação, desinstalação ou atualização, você deve fazer referência ao parâmetro como uma variável de ambiente usando a sintaxe apropriada para o sistema operacional. Por exemplo, no PowerShell, você faz referência ao`SSM_arg`Argumento como`$Env:SSM_arg`. Não há limite para o número de argumentos que você define, mas a entrada de argumento adicional tem um limite de 4096 caracteres. Esse limite inclui todas as chaves e valores que você define.  
Tipo: StringMap  
Obrigatório: não

**version**  
Uma versão específica do pacote a ser instalada ou desinstalada. No caso de instalação, o sistema instala a última versão publicada, por padrão. No caso de desinstalação, o sistema desinstala a versão atualmente instalada, por padrão. Se não for encontrada nenhuma versão instalada, é feito download da última versão publicada e a ação de desinstalação é executada.  
Tipo: string  
Obrigatório: não

## `aws:domainJoin`
<a name="aws-domainJoin"></a>

Ingressar uma instância do EC2 em um domínio. Esse plugin é executado em sistemas operacionais Linux e Windows Server. Este plugin altera o nome do host das instâncias Linux para o formato EC2AMAZ-*XXXXXXX*. Para obter mais informações sobre como ingressar instâncias do EC2, consulte [Associe uma instância do EC2 ao Diretório do Microsoft AD gerenciado pela AWS](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_join_instance.html) no *Manual de administração do AWS Directory Service*.

### Sintaxe
<a name="domainJoin-syntax"></a>

#### Esquema 2.2
<a name="domainJoin-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:domainJoin
parameters:
  directoryId:
    description: "(Required) The ID of the directory."
    type: String
  directoryName:
    description: "(Required) The name of the domain."
    type: String
  directoryOU:
    description: "(Optional) The organizational unit to assign the computer object to."
    type: String
  dnsIpAddresses:
    description: "(Required) The IP addresses of the DNS servers for your directory."
    type: StringList
  hostname:
    description: "(Optional) The hostname you want to assign to the node."
    type: String
mainSteps:
- action: aws:domainJoin
  name: domainJoin
  inputs:
    directoryId: "{{ directoryId }}"
    directoryName: "{{ directoryName }}"
    directoryOU: "{{ directoryOU }}"
    dnsIpAddresses: "{{ dnsIpAddresses }}"
    hostname: "{{ hostname }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:domainJoin",
  "parameters": {
    "directoryId": {
      "description": "(Required) The ID of the directory.",
      "type": "String"
    },
    "directoryName": {
      "description": "(Required) The name of the domain.",
      "type": "String"
    },
    "directoryOU": {
        "description": "(Optional) The organizational unit to assign the computer object to.",
        "type": "String"
      },
    "dnsIpAddresses": {
      "description": "(Required) The IP addresses of the DNS servers for your directory.",
      "type": "StringList"
    },
    "hostname": {
        "description": "(Optional) The hostname you want to assign to the node.",
        "type": "String"
      }
  },
  "mainSteps": [
    {
      "action": "aws:domainJoin",
      "name": "domainJoin",
      "inputs": {
        "directoryId": "{{ directoryId }}",
        "directoryName": "{{ directoryName }}",
        "directoryOU":"{{ directoryOU }}",
        "dnsIpAddresses":"{{ dnsIpAddresses }}",
        "hostname":"{{ hostname }}"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="domainJoin-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:domainJoin:
    properties:
      directoryId: "{{ directoryId }}"
      directoryName: "{{ directoryName }}"
      directoryOU: "{{ directoryOU }}"
      dnsIpAddresses: "{{ dnsIpAddresses }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:domainJoin":{
         "properties":{
            "directoryId":"{{ directoryId }}",
            "directoryName":"{{ directoryName }}",
            "directoryOU":"{{ directoryOU }}",
            "dnsIpAddresses":"{{ dnsIpAddresses }}"
         }
      }
   }
}
```

------

### Propriedades
<a name="domainJoin-properties"></a>

**directoryId**  
O ID do diretório.  
Tipo: String  
Exigido: sim  
Exemplo: "directoryId": "d-1234567890"

**directoryName**  
O nome do domínio.  
Tipo: String  
Exigido: sim  
Exemplo: "directoryName": "example.com"

**directoryOU**  
A unidade organizacional (UO).  
Tipo: string  
Obrigatório: não  
Exemplo: "directoryOU": "OU=test,DC=example,DC=com"

**dnsIpAddresses**  
Os endereços IP dos servidores DNS.  
Tipo: StringList  
Obrigatório: Sim  
Exemplo: "dnsIpAddresses": ["198.51.100.1","198.51.100.2"]

**hostname**  
O nome de host que você deseja atribuir ao nó. Caso não seja fornecido, não haverá modificação de nome para instâncias Windows Server, enquanto instâncias Linux utilizarão o padrão de nomenclatura predefinido. Quando fornecido, as instâncias Windows Server utilizarão o valor exato indicado. Para instâncias Linux, servirá como um prefixo (a menos que `keepHostName` seja definido como “true”).  
Tipo: string  
Obrigatório: não

**keepHostName**  
Determina se o nome do host é alterado para instâncias Linux quando ingressadas no domínio. É um parâmetro somente Linux. Por padrão (sem entradas para `hostname`, `hostnameNumAppendDigits` e com `keepHostName` definido como "false"), hosts Linux serão renomeados para o padrão EC2AMAZ-XXXXXX. Ao ser definido como “true”, mantém o nome de host original e ignora entradas para `hostname` e `hostnameNumAppendDigits`.  
Tipo: booliano  
Obrigatório: não

**hostnameNumAppendDigits**  
Define o número de dígitos numéricos aleatórios que devem ser acrescentados após o valor do nome de host. É um parâmetro somente Linux usado em conjunto com o parâmetro `hostname`. Será ignorado se `hostname` não for fornecido.  
Tipo: string  
Valores permitidos: de 1 a 5  
Obrigatório: não

### Exemplos
<a name="domainJoin-examples"></a>

Para ver exemplos, consulte [Associar uma instância do Amazon EC2 ao seuAWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ec2-join-aws-domain.html) no *Guia de administração do AWS Directory Service*.

## `aws:downloadContent`
<a name="aws-downloadContent"></a>

(Esquema versão 2.0 ou posterior) Baixe os documentos e scripts do SSM de locais remotos. Não há suporte a repositórios do GitHub Enterprise. Este plugin é compatível com os sistemas operacionais Linux e Windows Server.

### Sintaxe
<a name="downloadContent-syntax"></a>

#### Esquema 2.2
<a name="downloadContent-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:downloadContent
parameters:
  sourceType:
    description: "(Required) The download source."
    type: String
  sourceInfo:
    description: "(Required) The information required to retrieve the content from
      the required source."
    type: StringMap
mainSteps:
- action: aws:downloadContent
  name: downloadContent
  inputs:
    sourceType: "{{ sourceType }}"
    sourceInfo: "{{ sourceInfo }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:downloadContent",
  "parameters": {
    "sourceType": {
    "description": "(Required) The download source.",
    "type": "String"
  },
  "sourceInfo": {
    "description": "(Required) The information required to retrieve the content from the required source.",
    "type": "StringMap"
    }
  },
  "mainSteps": [
    {
      "action": "aws:downloadContent",
      "name": "downloadContent",
      "inputs": {
        "sourceType":"{{ sourceType }}",
        "sourceInfo":"{{ sourceInfo }}"
      }
    }
  ]
}
```

------

### Entradas
<a name="downloadContent-inputs"></a>

**sourceType**  
A origem do download. O Systems Manager é compatível com os tipos de origem a seguir para baixar scripts e documentos SSM: `GitHub`, `Git`, `HTTP`, `S3` e `SSMDocument`.  
Tipo: String  
Exigido: sim

**sourceInfo**  
As informações necessárias para recuperar o conteúdo da fonte necessária.  
Tipo: StringMap  
Obrigatório: Sim  
 **Para sourceType `GitHub,`, especifique o seguinte:**   
+ owner: o proprietário do repositório.
+ repository: o nome do repositório.
+ path: o caminho para o arquivo ou diretório do qual fazer download.
+ getOptions: opções extras para recuperar conteúdo de uma ramificação diferente da principal ou de uma confirmação específica no repositório. O getOptions poderá ser omitido se você estiver usando a confirmação mais recente na ramificação principal. Se seu repositório foi criado após 1º de outubro de 2020, a ramificação padrão pode ser nomeada principal em vez de mestre. Nesse caso, você precisará especificar valores para o parâmetro GetOptions.

  Esse parâmetro usa o seguinte formato:
  + branch:refs/heads/*branch\$1name*

    O padrão é `master`.

    Para especificar uma ramificação não padrão, use o seguinte formato:

    branch:refs/heads/*branch\$1name*
  + commitID:*commitID*

    O padrão é `head`.

    Para usar a versão do documento do SSM em uma confirmação diferente da mais recente, especifique o ID completo da confirmação. Por exemplo:

    ```
    "getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
    ```
+ tokenInfo: o parâmetro do Systems Manager (um parâmetro SecureString) em que você armazena as informações de token de acesso do GitHub no formato `{{ssm-secure:secure-string-token-name}}`.
**nota**  
O campo `tokenInfo` é o único campo do plugin de documento SSM que é compatível com um parâmetro SecureString. Os parâmetros SecureString não são compatíveis com nenhum outro campo, nem com outros plugins de documentos SSM.

```
{
    "owner":"TestUser",
    "repository":"GitHubTest",
    "path":"scripts/python/test-script",
    "getOptions":"branch:master",
    "tokenInfo":"{{ssm-secure:secure-string-token}}"
}
```
 **Para sourceType `Git`, especifique o seguinte:**   
+ repositório

  O URL do repositório Git do arquivo ou diretório que você deseja baixar.

  Tipo: string
Além disso, é possível especificar qualquer um dos seguintes parâmetros opcionais:  
+ getOptions

  Opções extras para recuperar conteúdo de uma ramificação diferente da principal ou de uma confirmação específica no repositório. O getOptions poderá ser omitido se você estiver usando a confirmação mais recente na ramificação principal.

  Tipo: string

  Esse parâmetro usa o seguinte formato:
  + branch:refs/heads/*branch\$1name*

    O padrão é `master`.

    `"branch"` é necessário somente se o documento do SSM estiver armazenado em uma ramificação diferente de `master`. Por exemplo:

    ```
    "getOptions": "branch:refs/heads/main"
    ```
  + commitID:*commitID*

    O padrão é `head`.

    Para usar a versão do documento do SSM em uma confirmação diferente da mais recente, especifique o ID completo da confirmação. Por exemplo:

    ```
    "getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
    ```
+ privateSSHKey

  A chave SSH a ser usada ao se conectar ao`repository`que você especificar. Você pode usar este formato para referencair um parâmetro `SecureString` para o valor da sua chave SSH: `{{ssm-secure:your-secure-string-parameter}}`.

  Tipo: string
+ skipHostKeyChecking

  Determina o valor da opção StrictHostKeyChecking quando se conecta ao `repository` que você especificar. O valor padrão é `false`.

  Tipo: booliano
+ username

  O nome de usuário a ser usado ao se conectar ao`repository`você especifica usando HTTP. Você pode usar este formato para referenciar um parâmetro `SecureString` para o valor do seu nome de usuário: `{{ssm-secure:your-secure-string-parameter}}`.

  Tipo: string
+ password

  A senha a ser usada ao se conectar ao`repository`você especifica usando HTTP. Você pode usar este formato para referencair um parâmetro `SecureString` para o valor da sua senha: `{{ssm-secure:your-secure-string-parameter}}`.

  Tipo: string
 **Para sourceType `HTTP`, especifique o seguinte:**   
+ url

  path: o URL do arquivo ou diretório do qual você deseja fazer download do .

  Tipo: string
Além disso, é possível especificar qualquer um dos seguintes parâmetros opcionais:  
+ allowInsecureDownload

  Determina se um download pode ser realizado em uma conexão que não esteja criptografada com o Security Socket Layer (SSL) ou o Transport Layer Security (TLS). O valor padrão é `false`. Não recomendamos realizar downloads sem criptografia. Se você optar por fazê-lo, você assume todos os riscos associados. A segurança é uma responsabilidade compartilhada entre a AWS e você. Isso é descrito como o modelo de responsabilidade compartilhada da. Para saber mais, consulte[Modelo de responsabilidade compartilhada](https://aws.amazon.com/compliance/shared-responsibility-model/).

  Tipo: booliano
+ authMethod

  Determina se um nome de usuário e senha são usados para autenticação quando se conectar à `url` que você especificar. Se você especificar`Basic`ou`Digest`, você deve fornecer valores para o`username`e`password`parâmetros. Para usar a`Digest`Método do,SSM AgentA versão 3.0.1181.0 ou posterior deve ser instalada na sua instância. O`Digest`suporta criptografia MD5 e SHA256.

  Tipo: string

  Valores válidos: `None` \$1 `Basic` \$1 `Digest`
+ username

  O nome de usuário a ser usado ao se conectar ao`url`você especificar usando`Basic`autenticação. Você pode usar este formato para referenciar um parâmetro `SecureString` para o valor do seu nome de usuário: `{{ssm-secure:your-secure-string-parameter}}`.

  Tipo: string
+ password

  A senha a ser usada ao se conectar ao`url`você especificar usando`Basic`autenticação. Você pode usar este formato para referencair um parâmetro `SecureString` para o valor da sua senha: `{{ssm-secure:your-secure-string-parameter}}`.

  Tipo: string
 **Para sourceType `S3`, especifique o seguinte:**   
+ path: o URL para o arquivo ou diretório do qual você deve baixar no Amazon S3.
Ao fazer download de um arquivo de um bucket do S3, os arquivos .etag são gerados no diretório de download.

```
{
    "path": "https://s3.amazonaws.com/amzn-s3-demo-bucket/powershell/helloPowershell.ps1" 
}
```
 **Para sourceType `SSMDocument`, especifique *um* dos seguintes:**   
+ name: o nome e a versão do documento no seguinte formato: `name:version`. A versão é opcional. 

  ```
  {
      "name": "Example-RunPowerShellScript:3" 
  }
  ```
+ name: o ARN do documento no seguinte formato: `arn:aws:ssm:region:account_id:document/document_name`

  ```
  {
     "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc"
  }
  ```

**destinationPath**  
Um caminho local opcional na instância em que você deseja fazer download do arquivo. Se você não especificar um caminho, o conteúdo será obtido por download em um caminho relativo ao ID do comando.  
Tipo: string  
Obrigatório: não

## `aws:psModule`
<a name="aws-psModule"></a>

Instalar módulos do PowerShell em uma instância do Amazon EC2. Este plugin é executado somente em sistemas operacionais Windows Server.

### Sintaxe
<a name="psModule-syntax"></a>

#### Esquema 2.2
<a name="psModule-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:psModule
parameters:
  source:
    description: "(Required) The URL or local path on the instance to the application
      .zip file."
    type: String
mainSteps:
- action: aws:psModule
  name: psModule
  inputs:
    source: "{{ source }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:psModule",
  "parameters": {
    "source": {
      "description": "(Required) The URL or local path on the instance to the application .zip file.",
      "type": "String"
    }
  },
  "mainSteps": [
    {
      "action": "aws:psModule",
      "name": "psModule",
      "inputs": {
        "source": "{{ source }}"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="domainJoin-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:psModule:
    properties:
    - runCommand: "{{ commands }}"
      source: "{{ source }}"
      sourceHash: "{{ sourceHash }}"
      workingDirectory: "{{ workingDirectory }}"
      timeoutSeconds: "{{ executionTimeout }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:psModule":{
         "properties":[
            {
               "runCommand":"{{ commands }}",
               "source":"{{ source }}",
               "sourceHash":"{{ sourceHash }}",
               "workingDirectory":"{{ workingDirectory }}",
               "timeoutSeconds":"{{ executionTimeout }}"
            }
         ]
      }
   }
}
```

------

### Propriedades
<a name="psModule-properties"></a>

**runCommand**  
O comando do PowerShell a ser executado após a instalação do módulo.  
Tipo: StringList  
Obrigatório: não

**origem**  
O URL ou o caminho local na instância para o arquivo `.zip` do aplicativo.  
Tipo: String  
Exigido: sim

**sourceHash**  
O hash SHA256 do arquivo `.zip`.  
Tipo: string  
Obrigatório: não

**timeoutSeconds**  
O tempo em segundos para um comando ser concluído antes de ser considerado como tendo falhado.  
Tipo: string  
Obrigatório: não

**workingDirectory**  
O caminho para o diretório de trabalho em sua instância.  
Tipo: string  
Obrigatório: não

## `aws:refreshAssociation`
<a name="aws-refreshassociation"></a>

(Esquema versão 2.0 ou posterior) Atualizar (forçar aplicação) uma associação sob demanda. Essa ação alterará o estado do sistema com base no que é definido na associação selecionada ou em todas as associações vinculadas aos destinos. Esse plugin é executado em sistemas operacionais Linux e Microsoft Windows Server.

### Sintaxe
<a name="refreshassociation-syntax"></a>

#### Esquema 2.2
<a name="refreshassociation-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:refreshAssociation
parameters:
  associationIds:
    description: "(Optional) List of association IDs. If empty, all associations bound
      to the specified target are applied."
    type: StringList
mainSteps:
- action: aws:refreshAssociation
  name: refreshAssociation
  inputs:
    associationIds:
    - "{{ associationIds }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:refreshAssociation",
  "parameters": {
    "associationIds": {
      "description": "(Optional) List of association IDs. If empty, all associations bound to the specified target are applied.",
      "type": "StringList"
    }
  },
  "mainSteps": [
    {
      "action": "aws:refreshAssociation",
      "name": "refreshAssociation",
      "inputs": {
        "associationIds": [
          "{{ associationIds }}"
        ]
      }
    }
  ]
}
```

------

### Entradas
<a name="refreshassociation-properties"></a>

**associationIds**  
Lista de IDs de associação. Se estiver vazia, todas as associações vinculadas ao destino especificado serão aplicadas.  
Tipo: StringList  
Obrigatório: não

## `aws:runDockerAction`
<a name="aws-rundockeraction"></a>

(Esquema versão 2.0 ou posterior) Executar ações do Docker em contêineres. Esse plugin é executado em sistemas operacionais Linux e Microsoft Windows Server.

### Sintaxe
<a name="rundockeraction-syntax"></a>

#### Esquema 2.2
<a name="rundockeraction-syntax-2.2"></a>

------
#### [ YAML ]

```
---
mainSteps:
- action: aws:runDockerAction
  name: RunDockerAction
  inputs:
    action: "{{ action }}"
    container: "{{ container }}"
    image: "{{ image }}"
    memory: "{{ memory }}"
    cpuShares: "{{ cpuShares }}"
    volume: "{{ volume }}"
    cmd: "{{ cmd }}"
    env: "{{ env }}"
    user: "{{ user }}"
    publish: "{{ publish }}"
    workingDirectory: "{{ workingDirectory }}"
    timeoutSeconds: "{{ timeoutSeconds }}"
```

------
#### [ JSON ]

```
{
   "mainSteps":[
      {
         "action":"aws:runDockerAction",
         "name":"RunDockerAction",
         "inputs":{
            "action":"{{ action }}",
            "container":"{{ container }}",
            "image":"{{ image }}",
            "memory":"{{ memory }}",
            "cpuShares":"{{ cpuShares }}",
            "volume":"{{ volume }}",
            "cmd":"{{ cmd }}",
            "env":"{{ env }}",
            "user":"{{ user }}",
            "publish":"{{ publish }}",
            "workingDirectory": "{{ workingDirectory }}",
            "timeoutSeconds": "{{ timeoutSeconds }}"
         }
      }
   ]
}
```

------

### Entradas
<a name="rundockeraction-properties"></a>

**ação**  
O tipo de ação a ser executada.  
Tipo: String  
Exigido: sim

**contêiner**  
O ID do contêiner do Docker.  
Tipo: string  
Obrigatório: não

**imagem**  
O nome da imagem do Docker.  
Tipo: string  
Obrigatório: não

**cmd**  
O comando do contêiner.  
Tipo: string  
Obrigatório: não

**memória**  
O limite de memória do contêiner.  
Tipo: string  
Obrigatório: não

**cpuShares**  
Os compartilhamentos da CPU do contêiner (peso relativo).  
Tipo: string  
Obrigatório: não

**volume**  
O volume em que o contêiner é montado.  
Tipo: StringList  
Obrigatório: não

**env**  
As variáveis de ambiente do contêiner.  
Tipo: string  
Obrigatório: não

**usuário**  
O nome de usuário do contêiner.  
Tipo: string  
Obrigatório: não

**publicar**  
As portas do contêiner publicadas.  
Tipo: string  
Obrigatório: não

**workingDirectory**  
O caminho para o diretório de trabalho em seu nó gerenciado.  
Tipo: string  
Obrigatório: não

**timeoutSeconds**  
O tempo em segundos para um comando ser concluído antes de ser considerado como tendo falhado.  
Tipo: string  
Obrigatório: não

## `aws:runDocument`
<a name="aws-rundocument"></a>

(Esquema versão 2.0 ou posterior) Executa documentos do SSM armazenados no Systems Manager ou em um compartilhamento local. Você pode usar esse plugin com o plugin [`aws:downloadContent`](#aws-downloadContent) para baixar um documento do SSM de um local remoto para um compartilhamento local e em seguida executá-lo. Este plugin é compatível com os sistemas operacionais Linux e Windows Server. Este plugin não suporta a execução do documento `AWS-UpdateSSMAgent` ou de qualquer documento que use o plugin `aws:updateSsmAgent`.

### Sintaxe
<a name="rundocument-syntax"></a>

#### Esquema 2.2
<a name="aws-rundocument-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:runDocument
parameters:
  documentType:
    description: "(Required) The document type to run."
    type: String
    allowedValues:
    - LocalPath
    - SSMDocument
mainSteps:
- action: aws:runDocument
  name: runDocument
  inputs:
    documentType: "{{ documentType }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:runDocument",
  "parameters": {
    "documentType": {
      "description": "(Required) The document type to run.",
      "type": "String",
      "allowedValues": [
        "LocalPath",
        "SSMDocument"
      ]
    }
  },
  "mainSteps": [
    {
      "action": "aws:runDocument",
      "name": "runDocument",
      "inputs": {
        "documentType": "{{ documentType }}"
      }
    }
  ]
}
```

------

### Entradas
<a name="rundocument-properties"></a>

**documentType**  
O tipo de documento a ser executado. Você pode executar documentos locais (`LocalPath`) ou documentos armazenados no Systems Manager (`SSMDocument`).  
Tipo: String  
Exigido: sim

**documentPath**  
O caminho para o documento. Se `documentType` for `LocalPath`, especifique o caminho para o documento no compartilhamento local. Se `documentType` for `SSMDocument`, especifique o nome do documento.  
Tipo: string  
Obrigatório: não

**documentParameters**  
Os parâmetros para o documento.  
Tipo: StringMap  
Obrigatório: não

## `aws:runPowerShellScript`
<a name="aws-runPowerShellScript"></a>

Executar scripts PowerShell ou especificar o caminho para um script a ser executado. Esse plugin é executado em sistemas operacionais Microsoft Windows Server e Linux.

### Sintaxe
<a name="runPowerShellScript-syntax"></a>

#### Esquema 2.2
<a name="runPowerShellScript-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:runPowerShellScript
parameters:
  commands:
    type: String
    description: "(Required) The commands to run or the path to an existing script
      on the instance."
    default: Write-Host "Hello World"
mainSteps:
- action: aws:runPowerShellScript
  name: runPowerShellScript
  inputs:
    timeoutSeconds: '60'
    runCommand:
    - "{{ commands }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:runPowerShellScript",
  "parameters": {
    "commands": {
      "type": "String",
      "description": "(Required) The commands to run or the path to an existing script on the instance.",
      "default": "Write-Host \"Hello World\""
    }
  },
  "mainSteps": [
    {
      "action": "aws:runPowerShellScript",
      "name": "runPowerShellScript",
      "inputs": {
        "timeoutSeconds": "60",
        "runCommand": [
          "{{ commands }}"
        ]
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="runPowerShellScript-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:runPowerShellScript:
    properties:
    - id: 0.aws:runPowerShellScript
      runCommand: "{{ commands }}"
      workingDirectory: "{{ workingDirectory }}"
      timeoutSeconds: "{{ executionTimeout }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:runPowerShellScript":{
         "properties":[
            {
               "id":"0.aws:runPowerShellScript",
               "runCommand":"{{ commands }}",
               "workingDirectory":"{{ workingDirectory }}",
               "timeoutSeconds":"{{ executionTimeout }}"
            }
         ]
      }
   }
}
```

------

### Propriedades
<a name="runPowerShellScript-properties"></a>

**runCommand**  
Especifique os comandos a serem executados ou o caminho para um script existente na instância.  
Tipo: StringList  
Obrigatório: Sim

**timeoutSeconds**  
O tempo em segundos para um comando ser concluído antes de ser considerado como tendo falhado. Quando o tempo limite é atingido, o Systems Manager interrompe a execução do comando.  
Tipo: string  
Obrigatório: não

**workingDirectory**  
O caminho para o diretório de trabalho em sua instância.  
Tipo: string  
Obrigatório: não

## `aws:runShellScript`
<a name="aws-runShellScript"></a>

Executar scripts shell do Linux ou especificar o caminho para um script a ser executado. Esse plugin só é executado em sistemas operacionais Linux.

### Sintaxe
<a name="runShellScript-syntax"></a>

#### Esquema 2.2
<a name="runShellScript-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:runShellScript
parameters:
  commands:
    type: String
    description: "(Required) The commands to run or the path to an existing script
      on the instance."
    default: echo Hello World
mainSteps:
- action: aws:runShellScript
  name: runShellScript
  inputs:
    timeoutSeconds: '60'
    runCommand:
    - "{{ commands }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:runShellScript",
  "parameters": {
    "commands": {
      "type": "String",
      "description": "(Required) The commands to run or the path to an existing script on the instance.",
      "default": "echo Hello World"
    }
  },
  "mainSteps": [
    {
      "action": "aws:runShellScript",
      "name": "runShellScript",
      "inputs": {
        "timeoutSeconds": "60",
        "runCommand": [
          "{{ commands }}"
        ]
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="runShellScript-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:runShellScript:
    properties:
    - runCommand: "{{ commands }}"
      workingDirectory: "{{ workingDirectory }}"
      timeoutSeconds: "{{ executionTimeout }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:runShellScript":{
         "properties":[
            {
               "runCommand":"{{ commands }}",
               "workingDirectory":"{{ workingDirectory }}",
               "timeoutSeconds":"{{ executionTimeout }}"
            }
         ]
      }
   }
}
```

------

### Propriedades
<a name="runShellScript-properties"></a>

**runCommand**  
Especifique os comandos a serem executados ou o caminho para um script existente na instância.  
Tipo: StringList  
Obrigatório: Sim

**timeoutSeconds**  
O tempo em segundos para um comando ser concluído antes de ser considerado como tendo falhado. Quando o tempo limite é atingido, o Systems Manager interrompe a execução do comando.  
Tipo: string  
Obrigatório: não

**workingDirectory**  
O caminho para o diretório de trabalho em sua instância.  
Tipo: string  
Obrigatório: não

## `aws:softwareInventory`
<a name="aws-softwareinventory"></a>

(Esquema versão 2.0 ou posterior) Coletar metadados sobre aplicativos, arquivos e configurações em suas instâncias gerenciadas. Esse plugin é executado em sistemas operacionais Linux e Microsoft Windows Server. Quando você configura a coleta de inventário, primeiro cria uma associação do AWS Systems Manager State Manager. O coleta os dados de inventário quando a associação é executada. Se você não criar a associação primeiro e tentar invocar o plugin aws:softwareInventory usando, por exemplo, o `aws:softwareInventory`, o sistema retornará o seguinte erro:

```
The aws:softwareInventory plugin can only be invoked via ssm-associate.
```

Uma instância pode ter apenas uma associação de inventário configurada por vez. Se você configurar uma instância com duas ou mais associações, a associação de inventário não será executada, e os dados de inventário não serão coletados. Para obter mais informações sobre como coletar o inventário, consulte [AWS Systems Manager Inventory](systems-manager-inventory.md).

### Sintaxe
<a name="softwareinventory-syntax"></a>

#### Esquema 2.2
<a name="softwareinventory-syntax-2.2"></a>

------
#### [ YAML ]

```
---
mainSteps:
- action: aws:softwareInventory
  name: collectSoftwareInventoryItems
  inputs:
    applications: "{{ applications }}"
    awsComponents: "{{ awsComponents }}"
    networkConfig: "{{ networkConfig }}"
    files: "{{ files }}"
    services: "{{ services }}"
    windowsRoles: "{{ windowsRoles }}"
    windowsRegistry: "{{ windowsRegistry}}"
    windowsUpdates: "{{ windowsUpdates }}"
    instanceDetailedInformation: "{{ instanceDetailedInformation }}"
    customInventory: "{{ customInventory }}"
```

------
#### [ JSON ]

```
{
   "mainSteps":[
      {
         "action":"aws:softwareInventory",
         "name":"collectSoftwareInventoryItems",
         "inputs":{
            "applications":"{{ applications }}",
            "awsComponents":"{{ awsComponents }}",
            "networkConfig":"{{ networkConfig }}",
            "files":"{{ files }}",
            "services":"{{ services }}",
            "windowsRoles":"{{ windowsRoles }}",
            "windowsRegistry":"{{ windowsRegistry}}",
            "windowsUpdates":"{{ windowsUpdates }}",
            "instanceDetailedInformation":"{{ instanceDetailedInformation }}",
            "customInventory":"{{ customInventory }}"
         }
      }
   ]
}
```

------

### Entradas
<a name="softwareinventory-properties"></a>

**aplicações**  
(Opcional) Coletar metadados para aplicativos instalados.  
Tipo: string  
Obrigatório: não

**awsComponents**  
(Opcional) Colete metadados para componentes da AWS, como o amazon-ssm-agent.  
Tipo: string  
Obrigatório: não

**files**  
(Opcional, requer o SSM Agent versão 2.2.64.0 ou posterior) Colete metadados para arquivos, incluindo, por exemplo, nomes de arquivos, a hora em que os arquivos foram criados, a hora em que os arquivos foram modificados e acessados pela última vez e os tamanhos dos arquivos. Para obter mais informações sobre como coletar inventário de arquivos, consulte [Trabalhar com o inventário de arquivos e do Registro do Windows](inventory-file-and-registry.md).  
Tipo: string  
Obrigatório: não

**networkConfig**  
(Opcional) Coletar metadados para configurações de rede.  
Tipo: string  
Obrigatório: não

**billingInfo**  
(Opcional) Colete metadados para obter detalhes da plataforma associados ao código de cobrança da AMI.  
Tipo: string  
Obrigatório: não

**windowsUpdates**  
(Opcional) Coletar metadados para todas as atualizações do Windows.  
Tipo: string  
Obrigatório: não

**instanceDetailedInformation**  
(Opcional) Colete mais informações da instância do que as fornecidas pelo plugin do inventário padrão (`aws:instanceInformation`), incluindo o modelo da CPU, a velocidade e o número de núcleos.  
Tipo: string  
Obrigatório: não

**serviços**  
(Opcional, somente o SO Windows, requer o SSM Agent versão 2.2.64.0 ou posterior) Colete metadados para configurações de serviço.  
Tipo: string  
Obrigatório: não

**windowsRegistry**  
(Opcional, somente o SO Windows, requer o SSM Agent versão 2.2.64.0 ou posterior) Colete chaves e valores do Registro do Windows. Você pode escolher um caminho de chaves e coletar todos os valores e chaves recursivamente. Você pode também coletar determinada chave de registro e o respectivo valor para um caminho específico. O inventário coleta o caminho da chave, o nome, o tipo e o valor. Para obter mais informações sobre como coletar inventário do Registro do Windows, consulte [Trabalhar com o inventário de arquivos e do Registro do Windows](inventory-file-and-registry.md).  
Tipo: string  
Obrigatório: não

**windowsRoles**  
(Opcional, somente o SO Windows, requer o SSM Agent versão 2.2.64.0 ou posterior) Colete metadados para configurações de função do Microsoft Windows.  
Tipo: string  
Obrigatório: não

**customInventory**  
(Opcional) Coletar dados de inventário personalizado. Para obter mais informações sobre inventário personalizado, consulte [Trabalhar com inventário personalizado](inventory-custom.md)  
Tipo: string  
Obrigatório: não

**customInventoryDirectory**  
(Opcional) Colete dados de inventário personalizados do diretório especificado. Para obter mais informações sobre inventário personalizado, consulte [Trabalhar com inventário personalizado](inventory-custom.md)  
Tipo: string  
Obrigatório: não

## `aws:updateAgent`
<a name="aws-updateagent"></a>

Atualizar o serviço EC2Config para a versão mais recente ou especificar uma versão mais antiga. Este plugin executado somente em sistemas operacionais Microsoft Windows Server. Para obter mais informações sobre o serviço EC2Config, consulte [Configurar uma instância do Windows usando o serviço EC2Config (legado)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2config-service.html) no *Guia de usuário do Amazon EC2*.

### Sintaxe
<a name="updateagent-syntax"></a>

#### Esquema 2.2
<a name="updateagent-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:updateAgent
mainSteps:
- action: aws:updateAgent
  name: updateAgent
  inputs:
    agentName: Ec2Config
    source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:updateAgent",
  "mainSteps": [
    {
      "action": "aws:updateAgent",
      "name": "updateAgent",
      "inputs": {
        "agentName": "Ec2Config",
        "source": "https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="updateagent-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:updateAgent:
    properties:
      agentName: Ec2Config
      source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
      allowDowngrade: "{{ allowDowngrade }}"
      targetVersion: "{{ version }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:updateAgent":{
         "properties":{
            "agentName":"Ec2Config",
            "source":"https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json",
            "allowDowngrade":"{{ allowDowngrade }}",
            "targetVersion":"{{ version }}"
         }
      }
   }
}
```

------

### Propriedades
<a name="updateagent-properties"></a>

**agentName**  
EC2Config. Esse é o nome do atendente que executa o serviço EC2Config.  
Tipo: String  
Exigido: sim

**allowDowngrade**  
Permitir que o serviço EC2Config seja atualizado para uma versão anterior. Se definido como falso, o serviço poderá ser atualizado apenas para versões mais novas (padrão). Se definido como verdadeiro, especifique a versão anterior.   
Tipo: booliano  
Obrigatório: não

**origem**  
O local em que o Systems Manager copia a versão do EC2Config a ser instalada. Não é possível mudar esse local.  
Tipo: String  
Exigido: sim

**targetVersion**  
Uma versão específica do serviço EC2Config a ser instalado. Se não for especificado, o serviço será atualizado para a versão mais recente.  
Tipo: string  
Obrigatório: não

## `aws:updateSsmAgent`
<a name="aws-updatessmagent"></a>

Atualizar o SSM Agent para a versão mais recente ou especificar uma versão mais antiga. Esse plugin é executado em sistemas operacionais Linux e Windows Server. Para obter mais informações, consulte [Trabalhar com o SSM Agent](ssm-agent.md). 

### Sintaxe
<a name="updateSSMagent-syntax"></a>

#### Esquema 2.2
<a name="updateaSSMgent-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:updateSsmAgent
parameters:
  allowDowngrade:
    default: 'false'
    description: "(Optional) Allow the Amazon SSM Agent service to be downgraded to
      an earlier version. If set to false, the service can be upgraded to newer versions
      only (default). If set to true, specify the earlier version."
    type: String
    allowedValues:
    - 'true'
    - 'false'
mainSteps:
- action: aws:updateSsmAgent
  name: updateSSMAgent
  inputs:
    agentName: amazon-ssm-agent
    source: https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json
    allowDowngrade: "{{ allowDowngrade }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:updateSsmAgent",
  "parameters": {
    "allowDowngrade": {
      "default": "false",
      "description": "(Required) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.",
      "type": "String",
      "allowedValues": [
        "true",
        "false"
      ]
    }
  },
  "mainSteps": [
    {
      "action": "aws:updateSsmAgent",
      "name": "awsupdateSsmAgent",
      "inputs": {
        "agentName": "amazon-ssm-agent",
        "source": "https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json",
        "allowDowngrade": "{{ allowDowngrade }}"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="updateaSSMgent-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:updateSsmAgent:
    properties:
    - agentName: amazon-ssm-agent
      source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
      allowDowngrade: "{{ allowDowngrade }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:updateSsmAgent":{
         "properties":[
            {
               "agentName":"amazon-ssm-agent",
               "source":"https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json",
               "allowDowngrade":"{{ allowDowngrade }}"
            }
         ]
      }
   }
}
```

------

### Propriedades
<a name="updateSSMagent-properties"></a>

**agentName**  
amazon-ssm-agent. Esse é o nome do Systems Manager Agent que processa solicitações e executa comandos na instância.  
Tipo: String  
Exigido: sim

**allowDowngrade**  
Permitir que o SSM Agent seja atualizado para uma versão anterior. Se definido como falso, o atendente poderá ser atualizado apenas para versões mais novas (padrão). Se definido como verdadeiro, especifique a versão anterior.   
Tipo: booliano  
Obrigatório: Sim

**origem**  
O local em que o Systems Manager copia a versão do SSM Agent a ser instalada. Não é possível mudar esse local.  
Tipo: String  
Exigido: sim

**targetVersion**  
Uma versão específica do SSM Agent a ser instalada. Se não for especificado, o atendente será atualizado para a versão mais recente.  
Tipo: string  
Obrigatório: não