Noções básicas sobre extensões do AWS AppConfig
Este tópico apresenta conceitos e terminologia de extensão do AWS AppConfig. As informações são discutidas no contexto de cada etapa necessária para configurar e usar extensões do AWS AppConfig.
Tópicos
Etapa 1: determine o que você deseja fazer com as extensões
Você quer receber uma notificação para um webhook que envia mensagens para o Slack sempre que uma implantação do AWS AppConfig for concluída? Deseja fazer backup de um perfil de configuração em um bucket do Amazon Simple Storage Service (Amazon S3) antes de uma configuração ser implantada? Deseja limpar os dados de configuração em busca de informações confidenciais antes da implantação da configuração? Você pode usar extensões para realizar esses tipos de tarefas e muito mais. Você pode criar extensões personalizadas ou usar as extensões criadas pela AWS incluídas com o AWS AppConfig.
nota
Para a maioria dos casos de uso, para criar uma extensão personalizada, você deve criar uma função do AWS Lambda para realizar qualquer computação e processamento definido na extensão. Para ter mais informações, consulte Passo a passo: criação de extensões do AWS AppConfig personalizadas.
As extensões criadas pela AWS a seguir podem ajudar você a integrar rapidamente as implantações de configuração com outros serviços. Você pode usar essas extensões no console do AWS AppConfig ou chamando ações da API de extensão diretamente na AWS CLI, AWS Tools for PowerShell ou SDK.
| Extensão | Descrição |
|---|---|
|
Esta extensão permite que o aplicativo atribua variações às sessões de usuário localmente, em vez de chamar a operação EvaluateFeature. Para ter mais informações, consulte Usar a extensão Amazon CloudWatch Evidently. |
|
|
Esta extensão envia eventos para o barramento de eventos padrão do EventBridge quando uma configuração é implantada. |
|
|
Eventos de implantação do AWS AppConfig no Amazon Simple Notification Service (Amazon SNS) |
Esta extensão envia mensagens para um tópico do Amazon SNS que você especifica quando uma configuração é implantada. |
|
Eventos de implantação do AWS AppConfig no Amazon Simple Queue Service (Amazon SQS) |
Esta extensão enfileira mensagens em sua fila do Amazon SQS quando uma configuração é implantada. |
|
Esta extensão permite que o AWS AppConfig crie e atualize ocorrências sempre que você fizer alterações em um sinalizador de recurso. |
Etapa 2: determine quando você deseja que a extensão seja executada
Uma extensão define uma ou mais ações que ela executa durante um fluxo de trabalho do AWS AppConfig. Por exemplo, a extensão AWS criada pela AWS AppConfig deployment events to Amazon SNS inclui uma ação para enviar uma notificação para um tópico do Amazon SNS. Cada ação é invocada quando você interage com o AWS AppConfig ou quando o AWS AppConfig está executando um processo em seu nome. Eles são chamados de pontos de ação. As extensões do AWS AppConfig são compatíveis com os seguintes pontos de ação:
-
PRE_CREATE_HOSTED_CONFIGURATION_VERSION -
PRE_START_DEPLOYMENT -
ON_DEPLOYMENT_START -
ON_DEPLOYMENT_STEP -
ON_DEPLOYMENT_BAKING -
ON_DEPLOYMENT_COMPLETE -
ON_DEPLOYMENT_ROLLED_BACK
As ações de extensão configuradas em pontos de ação PRE_* são aplicadas após a validação da solicitação, mas antes de o AWS AppConfig realizar a atividade que corresponde ao nome do ponto de ação. Essas invocações de ação são processadas ao mesmo tempo da solicitação. Se mais de uma solicitação for feita, as invocações de ação serão executadas sequencialmente. Observe também que os pontos de ação PRE_* recebem e podem alterar o conteúdo de uma configuração. Os pontos de ação PRE_* também podem responder a um erro e impedir que uma ação aconteça.
Uma extensão também pode ser executada paralelamente a um fluxo de trabalho do AWS AppConfig usando um ponto de ação ON_*. Os pontos de ação ON_* são invocados de forma assíncrona. Os pontos de ação ON_* não recebem o conteúdo de uma configuração. Se uma extensão apresentar um erro durante um ponto de ação ON_*, o serviço ignorará o erro e continuará o fluxo de trabalho.
Etapa 3: crie uma associação de extensão
Para criar uma extensão ou configurar uma extensão criada pela AWS, defina os pontos de ação que invocam uma extensão quando um recurso específico do AWS AppConfig for usado. Por exemplo, você pode optar por executar a extensão AWS AppConfig deployment events to Amazon SNS e receber notificações sobre um tópico do Amazon SNS sempre que uma implantação de configuração for iniciada para um aplicativo específico. A definição de quais pontos de ação invocam uma extensão para um recurso específico do AWS AppConfig é chamada de associação de extensão. Uma associação de extensão é uma relação especificada entre uma extensão e um recurso AWS AppConfig, como uma aplicação ou um perfil de configuração.
Um único aplicativo do AWS AppConfig pode incluir vários ambientes e perfis de configuração. Se você associar uma extensão a um aplicativo ou ambiente, o AWS AppConfig invocará a extensão para qualquer fluxo de trabalho relacionado ao aplicativo ou aos recursos do ambiente, se aplicável.
Por exemplo, digamos que você tenha um aplicativo do AWS AppConfig chamado MobileApps que inclua um perfil de configuração chamado AccessList. E digamos que o aplicativo MobileApps inclua ambientes beta, de integração e produção. Você cria uma associação de extensão para a extensão de notificação do Amazon SNS criada pela AWS e associa a extensão ao aplicativo MobileApps. A extensão de notificação do Amazon SNS é invocada sempre que a configuração é implantada para o aplicativo em qualquer um dos três ambientes.
nota
Você não precisa criar uma extensão para usar extensões criadas pela AWS, mas precisa criar uma associação de extensão.
Etapa 4: implante uma configuração e verifique se as ações da extensão são executadas
Depois de criar uma associação, quando uma configuração hospedada é criada ou uma configuração é implantada, o AWS AppConfig invoca a extensão e executa as ações especificadas. Quando uma extensão é invocada, se o sistema apresentar um erro durante um ponto de ação PRE-*, o AWS AppConfig retornará informações sobre esse erro.
