Este tópico explica como usar módulos em modelos do CloudFormation. Pense nos módulos como pacotes predefinidos de recursos que você pode adicionar aos seus modelos.
Para usar um módulo, as etapas são as seguintes:
-
Registre o módulo: registre módulos no registro do CloudFormation como extensões privadas. Verifique se ele está registrado na região e na Conta da AWS em que você está trabalhando. Para ter mais informações, consulte Conceitos do registro do CloudFormation.
-
Inclua-o em seu modelo: adicione o módulo à seção Resources do seu modelo do CloudFormation, assim como você faria com outros recursos. Você também precisará fornecer todas as propriedades necessárias para o módulo.
-
Crie ou atualize a pilha: quando você inicia uma operação de pilha, o CloudFormation gera um modelo processado que resolve todos os módulos incluídos nos recursos apropriados.
-
Pré-visualize as alterações: antes de fazer alterações, você pode usar um conjunto de alterações para ver quais recursos serão adicionados ou alterados. Para ter mais informações, consulte Atualizar pilhas do CloudFormation usando conjuntos de alterações.
Considere o exemplo a seguir: você tem um modelo que contém recursos e módulos. O modelo contém um recurso individual, ResourceA, e um módulo, ModuleParent. Esse módulo contém dois recursos, ResourceB e ResourceC, bem como um módulo aninhado, ModuleChild. ModuleChild contém um único recurso, ResourceD. Se você criar uma pilha com base nesse modelo, o CloudFormation o processará e resolverá os módulos para os recursos apropriados. A pilha resultante tem quatro recursos: ResourceA, ResourceB, ResourceC e ResourceD.
O CloudFormation acompanha quais recursos em uma pilha foram criados com base em módulos. Você pode visualizar essas informações nas guias Events (Eventos), Resources (Recursos) e Drifts (Desvios) de uma determinada pilha. Elas também estão incluídas nas visualizações do conjunto de alterações.
É possível fazer a distinção entre módulos e recursos em um modelo porque eles aderem à seguinte convenção de nomenclatura com quatro partes, em contraste com a convenção habitual de três partes usada por recursos:
organization::service::use-case::MODULE
