CloudFormation als Diagramm

So funktioniert es

1. 01

   Vorlage einfügen oder ablegen

   Eine template.yaml oder template.json so, wie Sie sie bereitstellen, mit Kurzformen wie !Ref und !Sub, oder die Vorlage, die cdk synth erzeugt. Kommentare und die langen Fn::-Formen sind kein Problem.

2. 02

   Stack ansehen

   Jede Ressource wird zu einer Karte für ihren AWS-Dienst. VPCs und Subnetze werden zu Rahmen um das, was darin läuft, und Referenzen zwischen Ressourcen werden zu Verbindungen.

3. 03

   In Archboard öffnen

   Speichern Sie es als neues Diagramm, um Karten umzuordnen, Notizen zu ergänzen, einen Link zu teilen oder als SVG und PNG zu exportieren. Für die Registrierung genügt ein Google- oder GitHub-Konto.

Was aus einer CloudFormation-Vorlage gezeichnet wird

Das Diagramm entsteht aus dem Abschnitt Resources Ihrer Vorlage und diesen Eigenschaften:

• ResourcesType

  Einträge unter Resources als Karten für ihren Type, etwa AWS::Lambda::Function oder AWS::RDS::DBInstance. Verbindende Typen wie Event-Source-Mappings, SNS-Abonnements und Ingress-Regeln von Sicherheitsgruppen werden zu Verbindungen, und Custom Resources erscheinen als generische Karten.

• !Ref!GetAtt!Sub

  Eine Verbindung überall dort, wo eine Eigenschaft mit Ref, Fn::GetAtt oder einem Namen in Fn::Sub auf eine andere Ressource verweist, in Kurz- oder Langform. Referenzen in Fn::If sind gestrichelt, weil eine Bedingung über sie entscheidet.

• DependsOn

  DependsOn-Einträge, ob sie eine Ressource nennen oder mehrere auflisten, als gestrichelte Verbindungen, außer wenn schon eine Referenz dieselben zwei Ressourcen verbindet. DependsOn auf eine Ressource, die nicht gezeichnet wird, etwa AWS::EC2::VPCGatewayAttachment, ergibt keine Verbindung.

• VpcIdSubnetId

  VPCs als Rahmen mit ihren Subnetzen, und Ressourcen, die über VpcId, SubnetId, SubnetIds oder VpcConfig platziert werden: in ihrem Subnetz oder im VPC-Rahmen, wenn sie mehrere Subnetze umfassen.

• EventsConnectors

  SAM-Funktionsereignisse als Verbindungen von der API-Route, beschriftet etwa mit POST /orders, oder von der Queue, dem Bucket, dem Stream oder der Regel, die die Funktion startet. Zeitpläne werden zu Trigger-Karten, und Connectors werden zu Read- oder Write-Verbindungen.

• aws:cdk:path

  Bei Ausgabe von cdk synth erhalten Karten lesbare Namen aus aws:cdk:path statt generierter logischer IDs, Constructs mit zwei oder mehr Ressourcen werden zu Rahmen, und CDKMetadata sowie die CDK-eigenen Hilfsressourcen werden ausgeblendet.

• AWS::CloudFormation::Stack

  Jeder verschachtelte Stack als eine Karte, verbunden von den Ressourcen, die als Parameter übergeben werden, und zu den Ressourcen, die seine Ausgaben lesen.

AWS-SAM-Vorlagen

Eine Vorlage mit Transform: AWS::Serverless-2016-10-31 wird so gelesen, wie sie geschrieben ist, ohne sam build auszuführen. Funktionen, APIs, HTTP-APIs, einfache Tabellen, State Machines und verschachtelte Anwendungen erhalten eigene Karten, eine API, die SAM aus einem Funktionsereignis erzeugt, erscheint ebenfalls als Karte, und in Policies referenzierte Ressourcen werden mit ihrer Funktion verbunden. Globals enthält nur gemeinsame Einstellungen und wird daher nicht gezeichnet.

Was ein CloudFormation-Diagramm weglässt

• Parameterwerte und Standardwerte, Mappings, Outputs und das Ergebnis von Conditions: Jede Ressource wird gezeichnet, auch eine, die eine Bedingung überspringen würde, und Eigenschaftswerte werden nicht angezeigt.
• Ressourcen in einem verschachtelten Stack oder einer SAM-Anwendung, weil die Child-Vorlage aus TemplateURL oder Location nicht geladen wird. Mit Fn::ImportValue aus anderen Stacks importierte Werte werden gezählt, nicht gezeichnet.
• Makros und Transforms außer SAM sowie Fn::ForEach-Schleifen: Nichts davon wird expandiert, daher erscheint eine ForEach-Schleife als eine einzige Platzhalterkarte.
• Stack-Status, Drift, Kosten oder welche Services sich zur Laufzeit gegenseitig aufrufen. Das Diagramm zeigt, wie die Vorlage Ressourcen verknüpft, nicht den Live-Traffic.