> For the complete documentation index, see [llms.txt](https://help.hyperflow.global/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/integracao/aws-secrets-manager.md). # AWS Secrets Manager ## 🔐 Módulo AWS Secrets Manager O módulo **AWS Secrets Manager** permite que o seu chatbot gerencie segredos armazenados no Amazon Secrets Manager durante uma conversa. Com ele, você pode criar, atualizar, excluir, recuperar e listar segredos — como senhas, chaves de acesso, tokens e outras informações sensíveis — de forma segura e automatizada, sem expor esses dados diretamente no fluxo. **📷 Inserir print:** visão geral do nó AWS Secrets Manager no canvas do Builder *** ### 🗂️ Como acessar 1. No menu lateral, clique em **Aplicativo**. 2. Em seguida, clique em **Fluxos**. 3. Abra o fluxo desejado ou crie um novo. 4. No canvas do Builder, clique no botão **+** para adicionar um novo nó. 5. Localize e selecione **AWS - Secrets Manager** na lista de módulos disponíveis. **📷 Inserir print:** lista de módulos com o item "AWS - Secrets Manager" destacado {% hint style="warning" %} **Pré-requisito:** Para usar este módulo, é necessário ter uma integração com a AWS configurada na plataforma. Caso o campo **Nome da integração** esteja vazio, acesse as configurações de integrações, cadastre as credenciais da AWS e retorne para configurar o módulo. {% endhint %} *** ### 🧩 Conhecendo o módulo Ao adicionar o módulo ao fluxo, um painel de configuração é aberto. Nele, você seleciona a integração AWS, escolhe a operação desejada e preenche os campos específicos de cada operação. O nó exibe no canvas um ícone da AWS e uma etiqueta com a operação selecionada (em letras maiúsculas), facilitando a identificação visual no fluxo. **📷 Inserir print:** painel de configuração do módulo AWS Secrets Manager aberto *** ### 🔧 Configurações do módulo #### 📌 Campos obrigatórios (comuns a todas as operações) | Campo | O que preencher | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | **Nome da integração** | Selecione a integração AWS cadastrada que o bot deve usar para acessar o Secrets Manager. Campo obrigatório. | | **Operação** | Escolha o que o módulo deve fazer com os segredos. As opções disponíveis são: **Criar**, **Atualizar**, **Excluir**, **Recuperar** e **Listar**. | **📷 Inserir print:** painel com os campos "Nome da integração" e "Operação" preenchidos *** ### ⚙️ Operações disponíveis #### 1️⃣ Criar segredo **🎯 Propósito** Cria um ou mais segredos novos no AWS Secrets Manager. Use quando o fluxo precisar armazenar informações sensíveis coletadas durante a conversa — como credenciais, tokens ou chaves — em um cofre seguro na AWS. **✅ Como fazer na tela** 1. Selecione a operação **create** no campo **Operação**. 2. O painel exibirá automaticamente um par de campos para o primeiro segredo: * **Nome do segredo:** informe o identificador do segredo (ex.: `minha-empresa/api-key`). Aceita variáveis do fluxo (ex.: `{{input.nomeSegredo}}`). * **Valor do segredo:** informe o conteúdo a ser armazenado (ex.: a senha ou token). Este campo não aceita variáveis dinâmicas. 3. Para adicionar mais segredos na mesma operação, clique em **Adicionar mais segredos**. Um novo par de campos será exibido. 4. Para remover um segredo da lista, clique no ícone de lixeira ao lado do par. O botão de exclusão fica desativado quando há apenas um segredo na lista. {% hint style="info" %} Você pode criar múltiplos segredos em uma única execução do módulo. Cada par **Nome / Valor** representa um segredo independente que será criado no Secrets Manager. {% endhint %} **📷 Inserir print:** painel da operação "create" com dois segredos adicionados e o botão "Adicionar mais segredos" visível **📌 Resultado esperado** Os segredos informados serão criados no AWS Secrets Manager. O fluxo seguirá pelo caminho **OK**, e os resultados da operação estarão disponíveis como variáveis nos próximos nós. *** #### 2️⃣ Atualizar segredo **🎯 Propósito** Atualiza o valor de um segredo já existente no AWS Secrets Manager. Use quando o fluxo precisar renovar uma senha, rotacionar um token ou modificar o conteúdo de um segredo previamente criado. **✅ Como fazer na tela** 1. Selecione a operação **update** no campo **Operação**. 2. O painel exibirá dois campos: * **Nome do segredo:** informe o identificador do segredo que será atualizado. Aceita variáveis do fluxo. * **Valor do segredo:** informe o novo valor que substituirá o conteúdo atual. Aceita variáveis do fluxo. **📷 Inserir print:** painel da operação "update" com os campos "Nome do segredo" e "Valor do segredo" **📌 Resultado esperado** O valor do segredo será atualizado no AWS Secrets Manager. O fluxo seguirá pelo caminho **OK** com os resultados da operação disponíveis como variáveis. *** #### 3️⃣ Excluir segredo **🎯 Propósito** Remove um segredo existente do AWS Secrets Manager. Use quando o fluxo precisar apagar credenciais ou informações sensíveis que não são mais necessárias. **✅ Como fazer na tela** 1. Selecione a operação **delete** no campo **Operação**. 2. O painel exibirá o campo: * **Segredo a ser excluído:** informe o nome exato do segredo que será removido. Este campo não aceita variáveis dinâmicas. {% hint style="warning" %} **Atenção:** A exclusão de um segredo no AWS Secrets Manager é uma operação permanente. Certifique-se de que o nome informado está correto antes de executar o fluxo. {% endhint %} **📷 Inserir print:** painel da operação "delete" com o campo "Segredo a ser excluído" preenchido **📌 Resultado esperado** O segredo será removido do AWS Secrets Manager. O fluxo seguirá pelo caminho **OK** confirmando a exclusão. *** #### 4️⃣ Recuperar segredo **🎯 Propósito** Busca o valor de um segredo armazenado no AWS Secrets Manager e o disponibiliza como variável no fluxo. Use quando o chatbot precisar usar uma credencial ou informação sensível armazenada na AWS durante o atendimento — sem expô-la diretamente no fluxo. **✅ Como fazer na tela** 1. Selecione a operação **get** no campo **Operação**. 2. O painel exibirá o campo: * **Nome do segredo:** informe o identificador do segredo que deseja recuperar. Aceita variáveis do fluxo. **📷 Inserir print:** painel da operação "get" com o campo "Nome do segredo" preenchido **📌 Resultado esperado** O valor do segredo será recuperado e disponibilizado como variável para os próximos nós do fluxo no caminho **OK**. Use essa variável para autenticar requisições ou preencher campos sem expor a informação sensível diretamente no fluxo. *** #### 5️⃣ Listar segredos **🎯 Propósito** Lista todos os segredos disponíveis na conta AWS configurada na integração. Use quando o fluxo precisar verificar quais segredos existem ou obter uma relação de identificadores para uso em outras operações. **✅ Como fazer na tela** 1. Selecione a operação **list** no campo **Operação**. 2. Nenhum campo adicional é exibido — apenas a integração AWS é necessária. **📷 Inserir print:** painel da operação "list" sem campos adicionais **📌 Resultado esperado** A lista de segredos disponíveis na conta será retornada e estará disponível como variável nos próximos nós do fluxo no caminho **OK**. *** ### 🔀 Saídas do módulo no fluxo Após a execução, o módulo AWS Secrets Manager direciona o fluxo por dois caminhos: | Saída | Quando acontece | | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **OK** | A operação foi executada com sucesso. Os resultados (incluindo o valor do segredo recuperado, se aplicável) ficam disponíveis como variáveis para os próximos nós. | | **ERR** | Ocorreu um erro na execução (ex.: credenciais inválidas, segredo não encontrado, permissão negada, nome duplicado na criação). | Conecte cada saída ao próximo nó conforme a lógica do seu fluxo — por exemplo, usar o valor recuperado no caminho **OK** ou exibir uma mensagem de erro no caminho **ERR**. **📷 Inserir print:** nó AWS Secrets Manager no canvas com as saídas OK e ERR conectadas a nós diferentes *** ### 💡 Dicas úteis * **Variáveis do fluxo:** Os campos **Nome do segredo** e **Valor do segredo** (nas operações de criar, atualizar e recuperar) aceitam variáveis dinâmicas com a sintaxe `{{nome.da.variavel}}`. Use isso para definir nomes e valores de segredos com base em dados coletados durante a conversa. * **Nomenclatura dos segredos:** O AWS Secrets Manager recomenda o padrão `prefixo/nome-do-segredo` (ex.: `minha-empresa/token-whatsapp`) para organizar os segredos por ambiente ou serviço. * **Operação get para autenticações:** Use a operação **Recuperar** para buscar tokens e chaves de API antes de módulos de integração, mantendo as credenciais fora do fluxo visível. * **Múltiplos segredos na criação:** A operação **Criar** permite adicionar vários segredos em uma única execução. Cada par **Nome / Valor** é criado de forma independente no Secrets Manager. * **Permissões necessárias:** A integração AWS usada precisa ter as permissões adequadas no Secrets Manager para cada operação: `secretsmanager:CreateSecret` (criar), `secretsmanager:PutSecretValue` (atualizar), `secretsmanager:DeleteSecret` (excluir), `secretsmanager:GetSecretValue` (recuperar) e `secretsmanager:ListSecrets` (listar). *** ### 📋 Caso de uso **Cenário:** Uma empresa de tecnologia usa um chatbot para processar integrações com sistemas externos. Durante o fluxo de onboarding de um novo cliente, o bot gera e armazena automaticamente uma chave de acesso personalizada no AWS Secrets Manager. Em atendimentos subsequentes, o bot recupera essa chave para autenticar requisições em nome do cliente, sem expor a credencial em nenhuma etapa visível do fluxo. **Configuração principal:** 1. **Etapa 1 — Criar o segredo durante o onboarding:** * Adicione o módulo **AWS Secrets Manager** ao fluxo de cadastro, após o nó que gera a chave de acesso do cliente. * Selecione a **integração AWS** configurada. * Selecione a operação **create**. * No campo **Nome do segredo**, use um nome dinâmico: `clientes/{{input.idCliente}}/api-key`. * No campo **Valor do segredo**, informe a chave gerada: `{{input.chaveGerada}}`. * Conecte a saída **OK** ao próximo nó que confirma o cadastro ao cliente. * Conecte a saída **ERR** a um nó que registra o erro e notifica a equipe interna. 2. **Etapa 2 — Recuperar o segredo em atendimentos futuros:** * No fluxo de atendimento, adicione o módulo **AWS Secrets Manager** antes do nó de integração com o sistema externo. * Selecione a mesma **integração AWS**. * Selecione a operação **get**. * No campo **Nome do segredo**, use: `clientes/{{input.idCliente}}/api-key`. * Conecte a saída **OK** ao nó de integração, usando a variável retornada como credencial de autenticação. * Conecte a saída **ERR** a um nó que informa ao cliente que não foi possível processar a solicitação. **Resultado esperado no fluxo:** O chatbot cria e armazena automaticamente credenciais únicas por cliente durante o cadastro e as recupera de forma segura em cada atendimento subsequente, sem expor as chaves em nenhum ponto visível do fluxo. *** ### ✅ Resumo * O módulo **AWS Secrets Manager** permite criar, atualizar, excluir, recuperar e listar segredos armazenados no Amazon Secrets Manager diretamente em fluxos de chatbot. * Todas as operações exigem uma **integração AWS** previamente configurada na plataforma. * A operação **Criar** suporta múltiplos segredos em uma única execução, cada um com seu próprio par de **Nome** e **Valor**. * A operação **Recuperar** disponibiliza o valor do segredo como **variável** nos próximos nós, permitindo autenticar integrações sem expor credenciais diretamente no fluxo. * O módulo possui duas saídas: **OK** (operação executada com sucesso, resultados disponíveis como variável) e **ERR** (falha na execução), que devem ser conectadas a nós diferentes conforme a lógica do fluxo. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/integracao/aws-secrets-manager.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.