CloudFormation para diagrama

Como funciona

1. 01

   Cole ou solte seu template

   Um template.yaml ou template.json do jeito que você faz o deploy, com tags curtas como !Ref e !Sub, ou o template que o cdk synth gera. Comentários e as formas longas Fn:: funcionam normalmente.

2. 02

   Veja sua stack

   Cada recurso vira um cartão do seu serviço da AWS. VPCs e sub-redes viram molduras em volta do que roda nelas, e referências entre recursos viram conexões.

3. 03

   Abra no Archboard

   Salve como um novo diagrama para reorganizar os cartões, adicionar notas, compartilhar um link ou exportar em SVG e PNG. Para se cadastrar basta uma conta Google ou GitHub.

O que é desenhado a partir de um template do CloudFormation

O diagrama é montado a partir da seção Resources do seu template e destas propriedades:

• ResourcesType

  As entradas de Resources, como cartões do seu Type, por exemplo AWS::Lambda::Function ou AWS::RDS::DBInstance. Tipos de ligação, como event source mappings, assinaturas do SNS e regras de entrada de grupos de segurança, viram conexões, e recursos personalizados aparecem como cartões genéricos.

• !Ref!GetAtt!Sub

  Uma conexão sempre que uma propriedade aponta para outro recurso com Ref, Fn::GetAtt ou um nome dentro de Fn::Sub, na forma curta ou longa. Referências dentro de Fn::If ficam tracejadas, porque uma condição decide sobre elas.

• DependsOn

  As entradas de DependsOn, seja com um único recurso ou com uma lista, como conexões tracejadas, a menos que uma referência já ligue os mesmos dois recursos. Um DependsOn para um recurso que não é desenhado, como AWS::EC2::VPCGatewayAttachment, não adiciona conexão.

• VpcIdSubnetId

  VPCs como molduras que contêm suas sub-redes, e recursos posicionados por VpcId, SubnetId, SubnetIds ou VpcConfig: dentro da sua sub-rede, ou na moldura da VPC quando ocupam várias sub-redes.

• EventsConnectors

  Eventos das funções SAM como conexões a partir da rota da API, rotulada por exemplo POST /orders, ou da fila, do bucket, do stream ou da regra que inicia a função. Agendamentos viram cartões de gatilho, e Connectors viram conexões Read ou Write.

• aws:cdk:path

  Na saída do cdk synth, os cartões recebem nomes legíveis a partir de aws:cdk:path em vez dos IDs lógicos gerados, constructs com dois ou mais recursos viram molduras, e CDKMetadata e os recursos auxiliares do próprio CDK ficam ocultos.

• AWS::CloudFormation::Stack

  Cada stack aninhada como um único cartão, ligada a partir dos recursos passados como parâmetros e até os recursos que leem suas saídas.

Templates do AWS SAM

Um template com Transform: AWS::Serverless-2016-10-31 é lido como está escrito, sem rodar sam build. Funções, APIs, APIs HTTP, tabelas simples, máquinas de estado e aplicações aninhadas ganham cartões próprios, uma API que o SAM cria a partir de um evento de função também aparece como cartão, e recursos referenciados em Policies são ligados à sua função. Globals só guarda configurações compartilhadas, então não é desenhado.

O que um diagrama do CloudFormation deixa de fora

• Valores e padrões de parâmetros, Mappings, Outputs e o resultado de Conditions: todo recurso é desenhado, mesmo um que uma condição pularia, e valores de propriedades não aparecem.
• Recursos dentro de uma stack aninhada ou de uma aplicação SAM, porque o template filho indicado em TemplateURL ou Location não é buscado. Valores importados de outras stacks com Fn::ImportValue são contados, não desenhados.
• Macros e transformações que não sejam do SAM, e loops Fn::ForEach: nada é expandido, então um loop ForEach aparece como um único cartão de espaço reservado.
• O status da stack, drift, custos ou quais serviços chamam uns aos outros em tempo de execução. O diagrama mostra como o template liga os recursos, não o tráfego real.