Ações do AWS Systems Manager

Esta página fornece uma referência para as ações do AWS Systems Manager disponíveis no catálogo de ações de automação de fluxo de trabalho. Use estas ações para criar, executar e gerenciar documentos de automação do AWS Systems Manager.

Pré-requisitos

Para pré-requisitos e configuração de credenciais, consulte Configurar credenciais da AWS.

Criar um documento

O identificador da ação é aws.systemsManager.writeDocument.

Cria ou atualiza um documento do SSM na sua conta da AWS. Consulte a documentação do AWS Systems Manager.

A tabela a seguir descreve os campos de entrada para esta ação.

Entrada	Tipo	Descrição	Exemplo
`awsRoleArn`	Corda	Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Corda	Opcional. ID da chave de acesso da AWS. Passe como um segredo.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Corda	Opcional. Chave de acesso secreta da AWS. Passe como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Corda	Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo.	`${{ :secrets:awsSessionToken }}`
`region`	Corda	Obrigatório. Região da AWS onde o documento será criado.	`us-east-2`
`documentName`	Corda	Obrigatório. Nome para o documento do SSM.	`my-ssm-document`
`documentType`	Corda	Opcional. Tipo de documento do SSM. Os valores válidos estão listados na Referência da API do AWS Systems Manager .	`Command`
`documentFormat`	Corda	Opcional. Formato do conteúdo do documento. Valores válidos: `JSON` , `YAML` , `TEXT` .	`YAML`
`documentContent`	Corda	Obrigatório. O conteúdo do documento SSM como uma string.	Veja o exemplo abaixo.
`override`	Boleano	Opcional. Quando `true` (padrão), substitui um documento existente com o mesmo nome. Quando `false` , retorna um erro se um documento com esse nome já existir.	`true`
`selectors`	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "documentName", "expression": ".documentName"}]`

A tabela a seguir descreve os campos de saída para esta ação.

Saída	Tipo	Exemplo
`documentName`	Corda	`my-ssm-document`
`documentVersion`	Corda	`1`
`documentType`	Corda	`Command`
`documentStatus`	Corda	`Active` . O valor será um dos status da Referência da API do AWS Systems Manager .
`success`	Boleano	`true`
`errorMessage`	Corda	`"Some error message from ssm"`

Exemplo: listar todas as funções do Lambda

Conteúdo do documento SSM:

schemaVersion: '0.3'
description: List all Lambda function names.
mainSteps:
  - name: ExecuteAwsApi
    action: aws:executeAwsApi
    isEnd: true
    inputs:
      Service: lambda
      Api: ListFunctions
    outputs:
      - Name: resultFunctionName
        Selector: $..FunctionName
        Type: StringList
outputs:
  - ExecuteAwsApi.resultFunctionName

Fluxo de trabalho completo usando este documento:

name: aws-api
workflowInputs:
  key:
    type: String
    defaultValue: "${{ :secrets:11933347:USERNAME_AWS_ACCESS_KEY_ID }}"
  access:
    type: String
    defaultValue: "${{ :secrets:11933347:USERNAME_AWS_SECRET_ACCESS_KEY }}"
  token:
    type: String
    defaultValue: "${{ :secrets:11933347:USERNAME_AWS_SESSION_TOKEN }}"
  region:
    type: String
    defaultValue: us-east-2
steps:
  - name: createSsmDocument
    type: action
    action: aws.systemsManager.writeDocument
    version: 1
    inputs:
      awsAccessKeyId: ${{ .workflowInputs.key }}
      awsSecretAccessKey: ${{ .workflowInputs.access }}
      awsSessionToken: ${{ .workflowInputs.token }}
      region: ${{ .workflowInputs.region }}
      documentName: "LambdaListFunctionNames"
      documentContent: |
        schemaVersion: '0.3'
        description: List all Lambda function names.
        mainSteps:
          - name: ExecuteAwsApi
            action: aws:executeAwsApi
            isEnd: true
            inputs:
              Service: lambda
              Api: ListFunctions
            outputs:
              - Name: resultFunctionName
                Selector: $..FunctionName
                Type: StringList
        outputs:
          - ExecuteAwsApi.resultFunctionName
  - name: start1
    type: action
    action: aws.systemsManager.startAutomation
    version: 1
    inputs:
      awsAccessKeyId: ${{ .workflowInputs.key }}
      awsSecretAccessKey: ${{ .workflowInputs.access }}
      awsSessionToken: ${{ .workflowInputs.token }}
      region: ${{ .workflowInputs.region }}
      documentName: "${{ .steps.createSsmDocument.outputs.documentName }}"

Excluir um documento

O identificador da ação é aws.systemsManager.deleteDocument.

Exclui um documento do AWS SSM da sua conta. Consulte a documentação do AWS Systems Manager.

A tabela a seguir descreve os campos de entrada para esta ação.

Entrada	Tipo	Descrição	Exemplo
`awsRoleArn`	Corda	Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Corda	Opcional. ID da chave de acesso da AWS. Passe como um segredo.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Corda	Opcional. Chave de acesso secreta da AWS. Passe como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Corda	Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo.	`${{ :secrets:awsSessionToken }}`
`region`	Corda	Obrigatório. Região da AWS onde o documento está localizado.	`us-east-2`
`documentName`	Corda	Obrigatório. Nome do documento SSM a ser excluído.	`my-ssm-document`
`selectors`	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "success", "expression": ".success"}]`

A tabela a seguir descreve os campos de saída para esta ação.

Saída	Tipo	Exemplo
`documentName`	Corda	`my-ssm-document`
`success`	Boleano	`true`
`errorMessage`	Corda	`"Some error message from ssm"`

Iniciar uma automação

O identificador da ação é aws.systemsManager.startAutomation.

Inicia uma automação usando um documento do AWS SSM. Consulte a documentação do AWS Systems Manager.

A tabela a seguir descreve os campos de entrada para esta ação.

Entrada	Tipo	Descrição	Exemplo
`awsRoleArn`	Corda	Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Corda	Opcional. ID da chave de acesso da AWS. Passe como um segredo.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Corda	Opcional. Chave de acesso secreta da AWS. Passe como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Corda	Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo.	`${{ :secrets:awsSessionToken }}`
`region`	Corda	Obrigatório. Região da AWS onde o documento SSM está localizado.	`us-east-2`
`documentName`	Corda	Obrigatório. Nome do documento SSM a ser executado.	`my-ssm-document`
`parameters`	Mapa	Opcional. Pares de valor principal a serem passados como parâmetros para o documento SSM.	`{"myKey": "myValue"}`
`idempotencyToken`	UUID	Opcional. Passado como o token do cliente para idempotência ao iniciar a automação.	`any-token`
`selectors`	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "automationExecutionId", "expression": ".automationExecutionId"}]`

A tabela a seguir descreve os campos de saída para esta ação.

Saída	Tipo	Exemplo
`automationExecutionId`	Corda	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`success`	Boleano	`true`
`errorMessage`	Corda	`"Some error message from ssm"`

Aguarde o status da automação

O identificador da ação é aws.systemsManager.waitForAutomationStatus.

Consulta uma execução de automação do AWS SSM até que ela atinja um dos status terminais especificados ou o tempo limite expire. Consulte a documentação do AWS Systems Manager.

A tabela a seguir descreve os campos de entrada para esta ação.

Entrada	Tipo	Descrição	Exemplo
`awsRoleArn`	Corda	Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Corda	Opcional. ID da chave de acesso da AWS. Passe como um segredo.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Corda	Opcional. Chave de acesso secreta da AWS. Passe como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Corda	Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo.	`${{ :secrets:awsSessionToken }}`
`region`	Corda	Obrigatório. Região da AWS onde a execução da automação está em andamento.	`us-east-2`
`automationExecutionId`	Corda	Obrigatório. O ID de execução a ser aguardado.	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`automationExecutionStatuses`	Lista	Opcional. Lista de status de AutomationExecution que interrompem a espera. Padrão: `["Success", "Failed"]` .	`["Success", "Failed"]`
`timeout`	Interno	Opcional. Duração em segundos para aguardar. O padrão é `180` , o máximo é `600` . Se excedido, retorna `success: false` com `errorMessage: "Timeout waiting for automation status"` .	`180`
`selectors`	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "automationExecutionStatus", "expression": ".automationExecutionStatus"}]`

A tabela a seguir descreve os campos de saída para esta ação.

Saída	Tipo	Exemplo
`automationExecutionId`	Corda	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`automationExecutionStatus`	Corda	`Success` . Um dos status passados em `automationExecutionStatuses` , ou null se a ação falhou.
`automationExecutionOutputs`	Mapa	`{"ExecuteGetApiResources": {"resultResourceId": ["pky3cb"]}}` . Mapa de valores de saída do documento SSM; utilize-os nas etapas subsequentes do fluxo de trabalho.
`success`	Boleano	`true`
`errorMessage`	Corda	`"Some error message from ssm"`

Esta tradução de máquina é fornecida para sua comodidade.

Pré-requisitos.css-21sua1{background:none;border:none;width:0;padding:0;}

Criar um documento

Excluir um documento

Iniciar uma automação

Aguarde o status da automação

Pré-requisitos