Criação de integrações de webhooks para o Automation - AWS Systems Manager
Criação de integrações (console)Criação de integrações (linha de comando)Criação de webhooks para integrações

Criação de integrações de webhooks para o Automation

Para enviar mensagens usando webhooks durante uma automação, crie uma integração. As integrações podem ser invocadas durante uma automação usando a ação aws:invokeWebhook em seu runbook. Se você ainda não criou um webhook, consulte Criação de webhooks para integrações. Para saber mais a respeito da ação aws:invokeWebhook, consulte aws:invokeWebhook — Invoque uma integração de webhook do Automation.

Conforme mostrado nos procedimentos a seguir, você pode criar uma integração usando o console do Automation do Systems Manager ou sua ferramenta da linha de comando preferida.

Criação de integrações (console)

Para criar uma integração para o Automation (console)

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

  2. No painel de navegação à esquerda, escolha Automation (Automação).

  3. Escolha a guia Integrations (Integrações).

  4. Selecione Add integration (Adicionar integração), e escolha Webhook.

  5. Insira os valores necessários e todos os valores opcionais que você deseja incluir para a integração.

  6. Selecione Add (Adicionar) para criar a integração.

Criação de integrações (linha de comando)

Para criar uma integração usando ferramentas da linha de comando, você deve criar o parâmetro SecureString necessário para uma integração. A automação usa um namespace reservado no Parameter Store, um recurso do Systems Manager, para armazenar informações sobre sua integração. Se você criar uma integração usando o AWS Management Console, o Automation lida com esse processo para você. Seguindo o namespace, você deve especificar o tipo de integração que deseja criar e, em seguida, o nome da sua integração. Atualmente, o Automation oferece suporte a Integrações do tipo webhook.

Os campos com suporte a integrações do tipo webhook são os seguintes:

  • Descrição

  • headers

  • payload

  • URL

Antes de começar

Caso ainda não tenha feito isso, instale e configure a AWS Command Line Interface (AWS CLI) ou o AWS Tools for PowerShell. Para obter informações, consulte Instalar ou atualizar a versão mais recente da AWS CLI e Instalar o AWS Tools for PowerShell.

Para criar uma integração para o Automation (linha de comando)

  • Execute os seguintes comandos para criar o parâmetro SecureString necessário para uma integração. Substitua cada espaço reservado para recurso de exemplo por suas próprias informações. O namespace /d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/ é reservado no Parameter Store para integrações. O nome do parâmetro deve usar esse namespace seguido do nome da sua integração. Por exemplo, /d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/myWebhookIntegration.

    Linux & macOS
    aws ssm put-parameter \
    --name "/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/myWebhookIntegration" \
    --type "SecureString" \
    --data-type "aws:ssm:integration" \
    --value '{"description": "My first webhook integration for Automation.", "url": "myWebHookURL"}'
    Windows
    aws ssm put-parameter ^
    --name "/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/myWebhookIntegration" ^
    --type "SecureString" ^
    --data-type "aws:ssm:integration" ^
    --value  "{\"description\":\"My first webhook integration for Automation.\",\"url\":\"myWebHookURL\"}"
    PowerShell
    Write-SSMParameter `
    -Name "/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/myWebhookIntegration" `
    -Type "SecureString"
    -DataType "aws:ssm:integration"
    -Value '{"description": "My first webhook integration for Automation.", "url": "myWebHookURL"}'

Criação de webhooks para integrações

Ao criar webhooks com seu provedor, observe o seguinte:

  • O protocolo deve ser o HTTPS.

  • Há suporte para os cabeçalhos de solicitação personalizados.

  • Um corpo da solicitação padrão pode ser especificado.

  • O corpo da solicitação padrão pode ser substituído quando uma integração for invocada usando a ação aws:invokeWebhook.