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

Esta referência descreve os plug-ins que você pode especificar em um documento do tipo Comando 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 AWS Systems Manager automação, consulteReferê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: sequência

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: sequência

Obrigatório: Sim

sourceHash

O hash SHA256 do arquivo .msi.

Tipo: string

Obrigatório: não

`aws:cloudWatch`

Exporte dados Windows Server para a Amazon CloudWatch ou Amazon CloudWatch Logs e monitore os dados usando CloudWatch métricas. Este plugin é executado somente em sistemas operacionais Windows Server. Para obter mais informações sobre como configurar a CloudWatch integração com o Amazon Elastic Compute Cloud (Amazon EC2), consulte Coleta de métricas e registros de instâncias do Amazon EC2 e servidores locais com o agente. CloudWatch

Importante

O CloudWatch agente unificado foi substituído SSM Agent como 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 CloudWatch agente unificado para seus processos de coleta de registros. Para obter mais informações, consulte os tópicos a seguir.

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

ApplicationEventLog: Envia dados do registro de eventos do aplicativo para o CloudWatch Logs.
CustomLogs: Envia qualquer arquivo de log baseado em texto para o Amazon CloudWatch Logs. O CloudWatch plug-in cria uma impressão digital para 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 dados do Event Tracing for Windows (ETW) para CloudWatch o Logs.
IIS: Envia dados de log do IIS para CloudWatch Logs.
PerformanceCounter: Envia contadores de desempenho do Windows para CloudWatch. Você pode selecionar categorias diferentes para fazer upload CloudWatch como métricas. Para cada contador de desempenho que você deseja carregar, crie uma PerformanceCounterseção com uma ID exclusiva (por exemplo, "PerformanceCounter2"," PerformanceCounter 3" etc.) e configure suas propriedades.

nota
Se o AWS Systems Manager SSM Agent ou o CloudWatch plug-in for interrompido, os dados do contador de desempenho não serão registrados. CloudWatch Esse comportamento é diferente daquele dos logs personalizados ou dos logs de eventos do Windows. Os registros personalizados e os registros de eventos do Windows preservam os dados do contador de desempenho e os carregam CloudWatch depois SSM Agent ou o CloudWatch plug-in está disponível.
SecurityEventLog: Envia dados do registro de eventos de segurança para o CloudWatch Logs.
SystemEventLog: Envia dados do registro de eventos do sistema para o 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 adicionar mais seções com IDs exclusivos (por exemplo, CloudWatch "2", CloudWatch 3" etc.) e especificar uma região diferente para cada nova ID para enviar os mesmos dados para locais diferentes.
CloudWatchLogs: O destino para o qual os dados de log são enviados. Você pode adicionar mais seções com IDs exclusivos (por exemplo, CloudWatchLogs "2", CloudWatchLogs 3" etc.) e especificar uma região diferente para cada nova ID para enviar os mesmos dados para locais diferentes.

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: sequência

Obrigatório: Sim

CounterName

O nome do contador de performance no Performance Monitor.

Tipo: sequência

Obrigatório: Sim

CultureName

O local em que o time stamp é registrado. Se CultureNameestiver em branco, o padrão será o mesmo local usado pela sua instância. Windows Server

Tipo: sequência

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 CloudWatch métrica da Amazon. 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 sua CloudWatch métrica da Amazon.

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: sequência

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: sequência

Valores válidos: para obter uma lista dos valores suportados, consulte a FileSystemWatcherFilter propriedade na biblioteca MSDN.

Obrigatório: Não

Fluxos

Cada tipo de dados a ser carregado, junto com o destino dos dados (CloudWatch ou CloudWatch registros). Por exemplo, para enviar um contador de desempenho definido em "Id": "PerformanceCounter" para o CloudWatch destino definido em"Id": "CloudWatch", digite CloudWatch"PerformanceCounter,”. Da mesma forma, para enviar o log personalizado, o log ETW e o log do sistema para o destino de CloudWatch registros definido em"Id": "ETW", digite “(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", digite "ApplicationEventLog, (CloudWatchLogs, CloudWatchLogs 2)”.

Tipo: sequência

Valores válidos (destino): CloudWatch | CloudWatchLogs | CloudWatchn | CloudWatchLogsn

Obrigatório: Sim

FullName

O nome completo do componente.

Tipo: sequência

Obrigatório: Sim

Id

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

Tipo: sequência

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: sequência

Obrigatório: Sim

Níveis

Os tipos de mensagens a serem enviadas para a Amazon CloudWatch.

Tipo: sequência

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: inteiro

Obrigatório: não

LogDirectoryPath

Para CustomLogs, o caminho em que os registros são armazenados na sua instância do EC2. Para registros do IIS, a pasta em que os registros do IIS são armazenados para um site individual (por exemplo, C:\\ inetpub\\ logs\\LogFiles\ W3SVC n). Para logs do IIS, somente o formato de log W3C é comportado. Não há suporte para os formatos IIS, NCSA e Personalizado.

Tipo: sequência

Obrigatório: Sim

LogGroup

O nome para o seu grupo de logs. Esse nome é exibido na tela Log Groups no console do CloudWatch.

Tipo: sequência

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. LogNameEstá na tag <Select Path=> (por exemplo,). Microsoft-Windows-Backup Copie esse texto no LogNameparâmetro.

Tipo: sequência

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: sequência

Valores válidos: {instance_id} | {hostname} | {ip_address} <log_stream_name>

Se você inserir um nome de fluxo de registros que ainda não exista, o CloudWatch Logs o criará automaticamente para você. 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 do fluxo de log especificado nesse parâmetro é exibido na tela Grupos de registros > Transmissões para < YourLogStream > no CloudWatch console.

Obrigatório: Sim

MetricName

A CloudWatch métrica na qual você deseja que os dados de desempenho 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: sequência

Obrigatório: Sim

NameSpace

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

Tipo: sequência

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

Região da AWS Para onde você deseja enviar os dados de registro. 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: sequência

Valores válidos: IDs de regiões Regiões da AWS compatíveis com Systems Manager e CloudWatch Logsus-east-2, comoeu-west-1, ap-southeast-1 e. Para ver as listas dos serviços Regiões da AWS suportados por cada serviço, consulte os endpoints do serviço Amazon CloudWatch Logs Service e os endpoints do serviço Systems Manager 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 CloudWatch desative a instância.

Tipo: sequência

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: sequência

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 seu carimbo de data/hora não incluir informações de fuso horário, o CloudWatch Logs usará 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: sequência

Valores válidos: Local | UTC

Obrigatório: Não

Unidade

A unidade de medida adequada para a métrica.

Tipo: sequência

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 AWS Systems Manager Distributor pacote. Você pode instalar a versão mais recente, a versão padrão ou uma versão especificada do pacote. Pacotes fornecidos pelo também AWS são suportados. 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.

Os AWS pacotes disponíveis Windows Server incluem o seguinte: AWSPVDriverAWSNVMe,AwsEnaNetworkDriver,AwsVssComponents,AmazonCloudWatchAgent,CodeDeployAgent, e AWSSupport-EC2Rescue.

AWS Os pacotes disponíveis para sistemas operacionais Linux incluem os seguintes: AmazonCloudWatchAgentCodeDeployAgent, AWSSupport-EC2Rescue e.

Sintaxe

Esquema 2.2

Entradas

name

O nome do AWS pacote a ser instalado ou desinstalado. Os pacotes disponíveis incluem o seguinte: AWSPVDriver, AwsEnaNetworkDriver, AwsVssComponents e AmazonCloudWatchAgent.

Tipo: sequência

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. A In-place update opção não é compatível com pacotes AWS 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, em 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

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 unir instâncias do EC2, consulte Unir uma instância do EC2 ao seu diretório gerenciado do AWS Microsoft AD no Guia de AWS Directory Service Administração.

Sintaxe

Esquema 2.2

Esquema 1.2

Propriedades

directoryId

O ID do diretório.

Tipo: sequência

Obrigatório: Sim

Exemplo: "directoryId": "d-1234567890"

directoryName

O nome do domínio.

Tipo: sequência

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"]

Exemplos

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

`aws:downloadContent`

(Esquema versão 2.0 ou posterior) Baixe documentos e scripts SSM de locais remotos. GitHub Enterpriserepositórios não são suportados. 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: sequência

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 Systems Manager ( SecureStringum parâmetro) em que você armazena GitHub as informações do token de acesso, no formato. {{ssm-secure:secure-string-token-name}}

nota
Esse tokenInfo campo é o único campo de plug-in de documento SSM que suporta um SecureString parâmetro. SecureString os parâmetros não são compatíveis com nenhum outro campo nem com nenhum outro plug-in de documento 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: sequência

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: sequência

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: sequência
skipHostKeyVerificando

Determina o valor da StrictHostKeyChecking opção ao se conectar ao repository que você especifica. 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: sequência
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: sequência

Para sourceType HTTP, especifique o seguinte:

url

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

Tipo: sequência

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 você 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: sequência

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: sequência
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: sequência

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/doc-example-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`

Instale PowerShell módulos 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 PowerShell comando 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: sequência

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: sequência

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: sequência

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`

Execute PowerShell scripts ou especifique o caminho para a execução de um script. 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. Ao configurar a coleta de inventário, você começa criando uma AWS Systems Manager State Manager associação. 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 AWS componentes como 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.

Sintaxe

Esquema 2.2

Esquema 1.2

Propriedades

agentName

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

Tipo: sequência

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: sequência

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: sequência

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: sequência

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