Ative um Lambda Hook em sua conta

O tópico a seguir mostra como ativar um Lambda Hook em sua conta, o que o torna utilizável na conta e na região em que foi ativado.

Ativar um Lambda Hook (console)

Para ativar um Lambda Hook para uso em sua conta

1. Faça login no AWS Management Console e abra o AWS CloudFormation console em https://console.aws.amazon.com/cloudformation.

2. Na barra de navegação na parte superior da tela, escolha Região da AWS onde você deseja criar o Hook in.

3. Se você não criou uma função Lambda para o Hook, faça o seguinte:

   • Abra a página Functions (Funções) no console do Lambda.

   • Crie a função Lambda que você usará com esse Hook e, em seguida, retorne a esse procedimento. Para obter mais informações, consulte Crie funções Lambda para avaliar recursos para Lambda Hooks.

   Se você já criou sua função Lambda, vá para a próxima etapa.

4. Em Nome do gancho, escolha uma das seguintes opções:

   • Forneça um nome curto e descritivo que será adicionado depoisPrivate::Lambda::. Por exemplo, se você inserirMyTestHook, o nome completo do Hook seráPrivate::Lambda::MyTestHook.

   • Forneça o nome completo do Hook (também chamado de alias) usando este formato: Provider::ServiceName::HookName

5. Para a função Lambda, forneça a função Lambda a ser usada com este Hook. Você pode usar:

   • O nome completo do recurso da Amazon (ARN) sem um sufixo.

   • Um qualificado ARN com um sufixo de versão ou alias.

6. Para alvos de Hook, escolha o que avaliar:

   • Pilhas — avalia os modelos de pilha quando os usuários criam, atualizam ou excluem pilhas.

   • Recursos — avalia as alterações de recursos individuais quando os usuários atualizam as pilhas.

   • Conjuntos de alterações — avalia as atualizações planejadas quando os usuários criam conjuntos de alterações.

   • Cloud Control API — Avalia as operações de criação, atualização ou exclusão iniciadas pelo Cloud Control API.

7. Em Ações, escolha quais ações (criar, atualizar, excluir) invocarão seu Hook.

8. Para o modo Hook, escolha como o Hook responde quando a função Lambda invocada pelo Hook retorna uma resposta: FAILED

   • Avisar — Emite avisos aos usuários, mas permite que as ações continuem. Isso é útil para validações não críticas ou verificações de informações.

   • Falha — Impede que a ação prossiga. Isso é útil para aplicar políticas rígidas de conformidade ou segurança.

9. Em Função de execução, escolha a IAM função que o Hook assume para invocar sua função Lambda. Você pode permitir CloudFormation a criação automática de uma função de execução para você ou especificar uma função que você criou.

10. Escolha Próximo.

11. (Opcional) Para filtros Hook, faça o seguinte:

    1. Em Filtro de recursos, especifique quais tipos de recursos podem invocar o Hook. Isso garante que o Hook seja invocado apenas para recursos relevantes.

    2. Em Critérios de filtragem, escolha a lógica para aplicar filtros de nome e função da pilha:

       • Todos os nomes e funções da pilha — O Hook só será invocado quando todos os filtros especificados corresponderem.

       • Qualquer nome de pilha e função de pilha — O Hook será invocado se pelo menos um dos filtros especificados corresponder.

       nota

       Nas API operações do Cloud Control, todos os filtros de nomes de pilha e papéis de pilha são ignorados.

    3. Para nomes de pilhas, inclua ou exclua pilhas específicas das invocações de Hook.

       • Em Incluir, especifique os nomes das pilhas a serem incluídas. Use isso quando você tiver um pequeno conjunto de pilhas específicas que deseja atingir. Somente as pilhas especificadas nesta lista invocarão o Hook.

       • Em Excluir, especifique os nomes das pilhas a serem excluídas. Use isso quando quiser invocar o Hook na maioria das pilhas, mas exclua algumas específicas. Todas as pilhas, exceto as listadas aqui, invocarão o Hook.

    4. Para funções do Stack, inclua ou exclua pilhas específicas das invocações do Hook com base nas funções associadas. IAM

       • Em Incluir, especifique uma ou mais IAM funções ARNs para direcionar as pilhas associadas a essas funções. Somente as operações de pilha iniciadas por essas funções invocarão o Hook.

       • Em Excluir, especifique uma ou mais IAM funções ARNs para as pilhas que você deseja excluir. O Hook será invocado em todas as pilhas, exceto aquelas iniciadas pelas funções especificadas.

12. Escolha Próximo.

13. Na página Revisar e ativar, revise suas escolhas. Para fazer alterações, escolha Editar na seção relacionada.

14. Quando estiver pronto para continuar, escolha Ativar gancho.

Ativar um gancho Lambda ()AWS CLI

Antes de continuar, confirme se você criou a função Lambda e a função de execução que você usará com este Hook. Para ter mais informações, consulte Crie funções Lambda para avaliar recursos para Lambda Hooks e Crie uma função de execução para um Lambda Hook.

Para ativar um Lambda Hook para uso em sua conta ()AWS CLI

1. Para começar a ativar um Hook, use o seguinte activate-typecomando, substituindo os espaços reservados por seus valores específicos. Este comando autoriza o Hook a usar uma função de execução especificada de seu Conta da AWS.

   aws cloudformation activate-type --type HOOK \
     --type-name AWS::Hooks::LambdaHook \
     --publisher-id aws-hooks \
     --execution-role arn:aws:iam::123456789012:role/my-execution-role \
     --type-name-alias Private::Lambda::MyTestHook \
     --region us-west-2

2. Para finalizar a ativação do Hook, você deve configurá-lo usando um arquivo JSON de configuração.

   Use o cat comando para criar um JSON arquivo com a estrutura a seguir. Para obter mais informações, consulte Referência de sintaxe de esquema de configuração de hook.

   $ cat > config.json
   {
     "CloudFormationConfiguration": {
       "HookConfiguration": {
         "HookInvocationStatus": "ENABLED",
         "TargetOperations": [
           "CLOUD_CONTROL"
         ],
         "FailureMode": "WARN",
         "Properties": {
           "LambdaFunction": "arn:aws:lambda:us-west-2:123456789012:function:MyFunction"
         }
       }
     }
   }

   • HookInvocationStatus: Defina como ENABLED para ativar o Hook.

   • TargetOperations: especifique em quais operações executar o Hook.

   • FailureMode: defina como FAIL ou WARN.

   • LambdaFunction: especifique ARN a função Lambda.

3. Use o seguinte set-type-configurationcomando, junto com o JSON arquivo que você criou, para aplicar a configuração. Substitua os espaços reservados por seus valores específicos.

   aws cloudformation set-type-configuration \
     --configuration file://config.json \
     --type-arn "arn:aws:cloudformation:us-west-2:123456789012:type/hook/MyTestHook" \
     --region us-west-2

Recursos relacionados

Fornecemos exemplos de modelos que você pode usar para entender como declarar um Lambda Hook em CloudFormation um modelo de pilha. Para ter mais informações, consulte AWS::CloudFormation::LambdaHook no AWS CloudFormation Guia do usuário.