Entradas compartilhadas aws:applications aws:cloudWatch aws:configureDocker aws:configurePackage aws:domainJoin aws:downloadContent aws:psModule aws:refreshAssociation aws:runDockerAction aws:runDocument aws:runPowerShellScript aws:runShellScript aws:softwareInventory aws:updateAgent aws:updateSsmAgent

Referência de plug-ins de documentos de comando

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.

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.

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

Conteúdo

Entradas compartilhadas
aws:applications
aws:cloudWatch
aws:configureDocker
aws:configurePackage
aws:domainJoin
aws:downloadContent
aws:psModule
aws:refreshAssociation
aws:runDockerAction
aws:runDocument
aws:runPowerShellScript
aws:runShellScript
aws:softwareInventory
aws:updateAgent
aws:updateSsmAgent

Entradas compartilhadas

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 umexitespecificado no parâmetroonFailureouonSuccessentradas. Para que uma etapa com essa entrada seja executada conforme esperado, a etapa deve ser a última definida nomainStepsdo documento.

Tipo: booliano

Valores válidos: true | false

Obrigatório: Não

onFailure

Se você especificar esta entrada para um plugin com a opçãoexite a etapa falhar, o status da etapa reflete a falha e o documento não executa as etapas restantes, a menos que umfinallyStepfoi definido. Se você especificar esta entrada para um plugin com a opçãosuccessAndExite a etapa falhar, o status da etapa mostra bem-sucedida e o documento não executa as etapas restantes, a menos que umfinallyStepfoi definido.

Tipo: string

Valores válidos: exit | 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 umfinallyStepfoi 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`

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

Sintaxe

Esquema 2.2

Esquema 1.2

Propriedades

ação

A medida a ser tomada.

Tipo: Enum

Valores válidos: Install | Repair | Uninstall

Obrigatório: Sim

parâmetros

Os parâmetros para o instalador.

Tipo: string

Obrigatório: Não

origem

O URL do arquivo .msi para o aplicativo.

Tipo: string

Obrigatório: Sim

sourceHash

O hash SHA256 do arquivo .msi.

Tipo: string

Obrigatório: Não

`aws:cloudWatch`

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 agente do CloudWatch no Guia de usuário do Amazon CloudWatch.

Importante

O agente 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 agente do CloudWatch unificado nos processos de coleta de logs. Para obter mais informações, consulte os tópicos a seguir.

Enviar logs de nós para o CloudWatch Logs unificado (agente do CloudWatch)
Migrar a coleta de logs de nós do Windows Server para o agente do CloudWatch
Coletar métricas, logs e rastreamentos com o agente do CloudWatch 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.

Atenção
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.

nota
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


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

Configurações e propriedades

AccessKey

Seu ID de chave de acesso da . 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

Obrigatório: Sim

CounterName

O nome do contador de performance no Performance Monitor.

Tipo: string

Obrigatório: 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) no site da Microsoft. Observe que 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 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 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 (destino): CloudWatch | CloudWatchLogs | CloudWatchn | CloudWatchLogsn

Obrigatório: Sim

FullName

O nome completo do componente.

Tipo: string

Obrigatório: Sim

Id

Identifica a origem de dados ou o destino. Esse identificador deve ser exclusivo no arquivo de configuração.

Tipo: string

Obrigatório: Sim

InstanceName

O nome da instância do contador de performance. Não use um asterisco (*) 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 _Total.

Tipo: string

Obrigatório: 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

nota

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: número 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:\\inetpub\\logs\\LogFiles\\W3SVCn). Para logs do IIS, somente o formato de log W3C é comportado. Não há suporte para os formatos IIS, NCSA e Personalizado.

Tipo: string

Obrigatório: 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

Obrigatório: Sim

LogName

O nome do arquivo de log.

Para encontrar o nome do log, no Visualizador de Eventos, no painel de navegação, clique em Logs de aplicações e serviços.
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>Operacional) e clique em Criar Modo de Exibição Personalizado.
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 | Security | System | Microsoft-Windows-WinINet/Analytic

Obrigatório: Sim

LogStream

O fluxo de logs de destino. Se você usar {instance_id}, 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} | {hostname} | {ip_address} <log_stream_name>

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 ({instance_id}, {hostname}, {ip_address}, 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.

nota

Não use caracteres especiais no nome. Caso contrário, a métrica e os alarmes associados podem não funcionar.

Tipo: string

Obrigatório: Sim

NameSpace

O namespace da métrica em que você deseja que os dados do contador de performance sejam gravados.

Tipo: string

Obrigatório: Sim

PollInterval

Quantos segundos devem transcorrer para que seja feito upload do novo contador de performance e dos dados de log.

Tipo: número 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 e Systems Manager service endpoints no Referência geral da Amazon Web Services.

Obrigatório: Sim

SecretKey

Sua chave de acesso secreta da . 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 | 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 na biblioteca do MSDN.

Tipo: string

Obrigatório: 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 | UTC

Obrigatório: Não

Unidade

A unidade de medida adequada para a métrica.

Tipo: string

Obrigatório: Sim

`aws:configureDocker`

(Esquema versão 2.0 ou posterior) configura uma instância para trabalhar com contêineres e o docker. Este plugin é compatível com os sistemas operacionais Linux e Windows Server.

Sintaxe

Esquema 2.2

Entradas

ação

O tipo de ação a ser executada.

Tipo: Enum

Valores válidos: Install | Uninstall

Obrigatório: Sim

`aws:configurePackage`

(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

Esquema 2.2

Entradas

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

Obrigatório: Sim

ação

Instala ou desinstala um pacote.

Tipo: Enum

Valores válidos: Install | 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. OIn-place updateA opção não tem suporte paraAWS-pacotes publicados.Uninstall and reinstallé o valor padrão.

Tipo: Enum

Valores válidos: Uninstall and reinstall | 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 aoSSM_argArgumento 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

versão

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`

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 no Manual de administração do AWS Directory Service.

Sintaxe

Esquema 2.2

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

Propriedades

directoryId

O ID do diretório.

Tipo: string

Obrigatório: Sim

Exemplo: "directoryId": "d-1234567890"

directoryName

O nome do domínio.

Tipo: string

Obrigatório: 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ó.

Tipo: string

Obrigatório: Não

keepHostName

Determina se o nome do host é alterado para instâncias Linux quando ingressadas no domínio.

Tipo: booliano

Obrigatório: Não

Exemplos

Para ver exemplos, consulte Associar uma instância do Amazon EC2 ao seuAWS Managed Microsoft AD no Guia de administração do AWS Directory Service.

`aws:downloadContent`

(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

Esquema 2.2

Entradas

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

Obrigatório: 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_name
  
  O padrão é master.
  
  Para especificar uma ramificação não padrão, use o seguinte formato:
  
  branch:refs/heads/branch_name
- 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_name
  
  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/head/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 aorepositoryque 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 aorepositoryvocê 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 aorepositoryvocê 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, consulteModelo de responsabilidade compartilhada.

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ê especificarBasicouDigest, você deve fornecer valores para ousernameepasswordparâmetros. Para usar aDigestMétodo do,SSM AgentA versão 3.0.1181.0 ou posterior deve ser instalada na sua instância. ODigestsuporta criptografia MD5 e SHA256.

Tipo: string

Valores válidos: None | Basic | Digest
username

O nome de usuário a ser usado ao se conectar aourlvocê especificar usandoBasicautenticaçã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 aourlvocê especificar usandoBasicautenticaçã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.


{
    "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`

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

Sintaxe

Esquema 2.2

Esquema 1.2

Propriedades

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

Obrigatório: 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`

(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

Esquema 2.2

Entradas

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`

(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

Esquema 2.2

Entradas

ação

O tipo de ação a ser executada.

Tipo: string

Obrigatório: Sim

container

O ID do contêiner do Docker.

Tipo: string

Obrigatório: Não

image

O nome da imagem do Docker.

Tipo: string

Obrigatório: Não

cmd

O comando do contêiner.

Tipo: string

Obrigatório: Não

memory

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

publish

As portas do contêiner publicadas.

Tipo: string

Obrigatório: Não

`aws:runDocument`

(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 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

Esquema 2.2

Entradas

documentType

O tipo de documento a ser executado. Você pode executar documentos locais (LocalPath) ou documentos armazenados no Systems Manager (SSMDocument).

Tipo: string

Obrigatório: 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`

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

Esquema 2.2

Esquema 1.2

Propriedades

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`

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

Sintaxe

Esquema 2.2

Esquema 1.2

Propriedades

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`

(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 Inventário do AWS Systems Manager.

Sintaxe

Esquema 2.2

Entradas

applications

(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.

Tipo: string

Obrigatório: Não

networkConfig

(Opcional) Coletar metadados para configurações de rede.

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.

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

Tipo: string

Obrigatório: Não

`aws:updateAgent`

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) no Guia de usuário do Amazon EC2.

Sintaxe

Esquema 2.2

Esquema 1.2

Propriedades

agentName

EC2Config. Esse é o nome do agente que executa o serviço EC2Config.

Tipo: string

Obrigatório: 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

Obrigatório: 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`

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 ter mais informações, consulte Trabalhar com o SSM Agent.

Sintaxe

Esquema 2.2

Esquema 1.2

Propriedades

agentName

amazon-ssm-agent. Esse é o nome do Systems Manager Agent que processa solicitações e executa comandos na instância.

Tipo: string

Obrigatório: Sim

allowDowngrade

Permitir que o SSM Agent seja atualizado para uma versão anterior. Se definido como falso, o agente 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

Obrigatório: Sim

targetVersion

Uma versão específica do SSM Agent a ser instalada. Se não for especificado, o agente será atualizado para a versão mais recente.

Tipo: string

Obrigatório: Não

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Elementos e parâmetros de dados

Criar conteúdo de documento do SSM