Dies ist der AWS CDK v2-Entwicklerhandbuch. Die ältere CDK Version 1 wurde am 1. Juni 2022 in die Wartung aufgenommen und der Support wurde am 1. Juni 2023 eingestellt.
Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
AWS CDK Anwendungen bereitstellen
Eine AWS Cloud Development Kit (AWS CDK) Bereitstellung ist der Prozess der Bereitstellung Ihrer Infrastruktur auf AWS.
Wie funktionieren AWS CDK Bereitstellungen
Der AWS CDK nutzt den AWS CloudFormation Dienst zur Durchführung von Bereitstellungen. Vor der Bereitstellung synthetisieren Sie Ihre Stacks. CDK Dadurch werden eine CloudFormation Vorlage und Bereitstellungsartefakte für jeden CDK Stack in Ihrer App erstellt. Bereitstellungen werden von einem lokalen Entwicklungscomputer oder von einer CI/CD-Umgebung (Continuous Integration and Continuous Delivery) aus initiiert. Während der Bereitstellung werden die Ressourcen auf die Bootstrap-Ressourcen hochgeladen, und die CloudFormation Vorlage wird zur CloudFormation Bereitstellung Ihrer Ressourcen eingereicht. AWS
Damit eine Bereitstellung erfolgreich ist, ist Folgendes erforderlich:
-
Die AWS CDK Befehlszeilenschnittstelle (AWS CDK CLI) muss mit gültigen Berechtigungen ausgestattet sein.
-
Für die AWS Umgebung muss ein Bootstrapping durchgeführt werden.
-
Sie AWS CDK müssen die Bootstrap-Ressourcen kennen, in die Ressourcen hochgeladen werden sollen.
Voraussetzungen für Bereitstellungen CDK
Bevor Sie eine AWS CDK Anwendung bereitstellen können, müssen Sie die folgenden Schritte ausführen:
-
Konfigurieren Sie Sicherheitsanmeldedaten für die CDKCLI.
-
Führen Sie ein Bootstrapping für Ihre AWS Umgebung durch.
-
Konfiguriere eine AWS Umgebung für jeden deiner CDK Stacks.
-
Entwickeln Sie Ihre CDK App.
Konfigurieren Sie Sicherheitsanmeldedaten
Um mit dem CDK CLI zu interagieren AWS, müssen Sie Sicherheitsanmeldedaten auf Ihrem lokalen Computer konfigurieren. Detaillierte Anweisungen finden Sie unter Konfigurieren Sie Sicherheitsanmeldedaten für AWS CDKCLI.
Bootstrap für Ihre Umgebung AWS
Eine Bereitstellung ist immer mit einer oder mehreren AWS Umgebungen verknüpft. Bevor Sie die Bereitstellung durchführen können, muss die Umgebung zuerst gebootet werden. Bootstrapping stellt Ressourcen in Ihrer Umgebung bereit, die dann zur Durchführung und Verwaltung von Bereitstellungen CDK verwendet werden. Zu diesen Ressourcen gehören ein Amazon Simple Storage Service (Amazon S3) -Bucket und ein Amazon Elastic Container Registry (AmazonECR) -Repository zum Speichern und Verwalten von Ressourcen. Zu diesen Ressourcen gehören auch Rollen AWS Identity and Access Management (IAM), die zur Erteilung von Berechtigungen während der Entwicklung und Bereitstellung verwendet werden.
Wir empfehlen, dass Sie den AWS CDK Befehl Command Line Interface (AWS CDK CLI) cdk bootstrap
verwenden, um Ihre Umgebung zu booten. Sie können das Bootstrapping anpassen oder diese Ressourcen bei Bedarf manuell in Ihrer Umgebung erstellen. Detaillierte Anweisungen finden Sie unter Bootstrap Ihre Umgebung für die Verwendung mit AWS CDK.
Umgebungen konfigurieren AWS
Jeder CDK Stack muss einer Umgebung zugeordnet sein, um zu bestimmen, wo der Stack bereitgestellt wird. Detaillierte Anweisungen finden Sie unter Konfigurieren Sie Umgebungen für die Verwendung mit dem AWS CDK.
Entwickeln Sie Ihre CDK App
Innerhalb eines CDK Projekts erstellen und entwickeln Sie Ihre CDK App. In Ihrer App erstellen Sie einen oder mehrere CDK Stapel. In Ihren Stacks importieren und verwenden Sie Konstrukte aus der AWS Construct-Bibliothek, um Ihre Infrastruktur zu definieren. Bevor Sie sie bereitstellen können, muss Ihre CDK App mindestens einen Stack enthalten.
CDKApp-Synthese
Um die Synthese durchzuführen, empfehlen wir, den CDK CLI cdk synth
Befehl zu verwenden. Der cdk
deploy
Befehl führt auch eine Synthese durch, bevor die Bereitstellung initiiert wird. Mit der Verwendung cdk
synth
können Sie Ihre CDK App jedoch validieren und Fehler catch bevor Sie mit der Bereitstellung beginnen.
Das Syntheseverhalten wird durch den Stack-Synthesizer bestimmt, den Sie für Ihren CDK Stack konfigurieren. Wenn Sie keinen Synthesizer konfigurieren, DefaultStackSynthesizer
wird dieser verwendet. Sie können die Synthese auch konfigurieren und an Ihre Bedürfnisse anpassen. Detaillierte Anweisungen finden Sie unter Konfiguration und Anpassung der CDK Stack-Synthese.
Damit Ihre synthetisierte CloudFormation Vorlage erfolgreich in Ihrer Umgebung bereitgestellt werden kann, muss sie mit dem Bootstrapping Ihrer Umgebung kompatibel sein. In Ihrer CloudFormation Vorlage muss beispielsweise der richtige Amazon S3 S3-Bucket angegeben werden, in dem Ressourcen bereitgestellt werden sollen. Wenn Sie die Standardmethode für das Bootstrapping Ihrer Umgebung verwenden, funktioniert der Standard-Stack-Synthesizer. Wenn Sie CDK das Verhalten anpassen, z. B. das Bootstrapping oder die Synthese anpassen, kann das Bereitstellungsverhalten variieren. CDK
Der App-Lebenszyklus
Wenn Sie die Synthese durchführen, durchläuft Ihre CDK App die folgenden Phasen, die als App-Lebenszyklus bezeichnet werden:
- Konstruktion (oder Initialisierung)
-
Ihr Code instanziiert alle definierten Konstrukte und verknüpft sie dann miteinander. In dieser Phase werden alle Konstrukte (App, Stacks und ihre untergeordneten Konstrukte) instanziiert und die Konstruktorkette ausgeführt. Der größte Teil Ihres App-Codes wird in dieser Phase ausgeführt.
- Vorbereitung
-
Alle Konstrukte, die die
prepare
Methode implementiert haben, werden einer letzten Änderungsrunde unterzogen, um ihren endgültigen Status festzulegen. Die Vorbereitungsphase erfolgt automatisch. Als Benutzer erhalten Sie kein Feedback aus dieser Phase. Es kommt selten vor, dass der Hook „Prepare“ verwendet werden muss, und wird generell nicht empfohlen. Seien Sie in dieser Phase sehr vorsichtig, wenn Sie den Konstruktionsbaum mutieren, da die Reihenfolge der Operationen das Verhalten beeinflussen könnte.Während dieser Phase, sobald der Konstruktionsbaum erstellt wurde, werden alle Aspekte, die Sie konfiguriert haben, ebenfalls angewendet.
- Validierung
-
Alle Konstrukte, die die
validate
Methode implementiert haben, können sich selbst validieren, um sicherzustellen, dass sie sich in einem Zustand befinden, der korrekt bereitgestellt werden kann. Sie werden über alle Validierungsfehler informiert, die während dieser Phase auftreten. Im Allgemeinen empfehlen wir, die Validierung so schnell wie möglich durchzuführen (normalerweise, sobald Sie Informationen erhalten) und so früh wie möglich Ausnahmen auszulösen. Eine frühzeitige Validierung erhöht die Zuverlässigkeit, da Stack-Traces genauer sind, und stellt sicher, dass Ihr Code weiterhin sicher ausgeführt werden kann. - Synthese
-
Dies ist die letzte Phase der Ausführung Ihrer CDK App. Es wird durch einen Aufruf von ausgelöst
app.synth()
, durchläuft den Konstruktbaum und ruft diesynthesize
Methode für alle Konstrukte auf. Implementierte Konstruktesynthesize
können an der Synthese teilnehmen und Bereitstellungsartefakte für die resultierende Cloud-Assembly erzeugen. Zu diesen Artefakten gehören CloudFormation Vorlagen, AWS Lambda Anwendungspakete, Datei- und Docker Image-Ressourcen und andere Bereitstellungsartefakte. In den meisten Fällen müssen Sie diesynthesize
Methode nicht implementieren.
Ihre App ausführen
Sie CDK CLI müssen wissen, wie Sie Ihre CDK App ausführen. Wenn Sie das Projekt mithilfe des cdk init
Befehls aus einer Vorlage erstellt haben, enthält die cdk.json
Datei Ihrer App einen app
Schlüssel. Dieser Schlüssel gibt den erforderlichen Befehl für die Sprache an, in der die App geschrieben ist. Wenn für Ihre Sprache eine Kompilierung erforderlich ist, führt die Befehlszeile diesen Schritt aus, bevor die App automatisch ausgeführt wird.
Wenn Sie Ihr Projekt nicht mit dem CDK CLI erstellt haben oder wenn Sie die unter angegebene Befehlszeile überschreiben möchtencdk.json
, können Sie die --app
Option bei der Ausführung des cdk
Befehls angeben.
$
cdk --app 'executable
'cdk-command
...
Das Tool executable
Ein Teil des Befehls gibt den Befehl an, der ausgeführt werden sollte, um Ihre CDK Anwendung auszuführen. Verwenden Sie Anführungszeichen wie in der Abbildung gezeigt, da solche Befehle Leerzeichen enthalten. Das Tool cdk-command
ist ein Unterbefehl wie synth
oderdeploy
, der angibt, CDK CLI was Sie mit Ihrer App machen möchten. Folgen Sie dem mit allen zusätzlichen Optionen, die für diesen Unterbefehl benötigt werden.
CDKCLISie können auch direkt mit einer bereits synthetisierten Cloud-Assembly interagieren. Übergeben Sie dazu das Verzeichnis, in dem die Cloud-Assembly gespeichert ist. --app
Das folgende Beispiel listet die Stacks auf, die in der Cloud-Assembly definiert sind, die unter ./my-cloud-assembly
gespeichert ist.
$
cdk --app./my-cloud-assembly
ls
Cloud-Assemblys
Der Call to app.synth()
weist an, eine Cloud-Assembly aus einer App AWS CDK zu synthetisieren. Normalerweise interagieren Sie nicht direkt mit Cloud-Assemblys. Es handelt sich um Dateien, die alles enthalten, was für die Bereitstellung Ihrer App in einer Cloud-Umgebung erforderlich ist. Es enthält beispielsweise eine AWS CloudFormation Vorlage für jeden Stapel in Ihrer App. Es enthält auch eine Kopie aller Datei-Assets oder Docker Bilder, auf die Sie in Ihrer App verweisen.
Einzelheiten zur Formatierung von Cloud-Assemblys finden Sie in der Cloud-Assembly-Spezifikation
Um mit der Cloud-Assembly zu interagieren, die Ihre AWS CDK App erstellt, verwenden Sie in der Regel die AWS CDK CLI. Für die Bereitstellung Ihrer App kann jedoch jedes Tool verwendet werden, das das Cloud-Assembly-Format lesen kann.
Bereitstellen der Anwendung
Um Ihre Anwendung bereitzustellen, empfehlen wir Ihnen, den CDK CLI cdk deploy
Befehl zum Initiieren von Bereitstellungen oder zum Konfigurieren automatisierter Bereitstellungen zu verwenden.
Wenn Sie ihn ausführencdk deploy
, wird er CDK CLI initiiert, cdk synth
um sich auf die Bereitstellung vorzubereiten. Das folgende Diagramm veranschaulicht den Lebenszyklus einer App im Kontext einer Bereitstellung:
Während der Bereitstellung CDK CLI nimmt der die durch Synthese erzeugte Cloud-Assembly und stellt sie in einer AWS Umgebung bereit. Die Ressourcen werden auf Amazon S3 und Amazon hochgeladen ECR und die CloudFormation Vorlage wird AWS CloudFormation zur Bereitstellung eingereicht.
Zu Beginn der AWS CloudFormation Bereitstellungsphase ist Ihre CDK App bereits fertig ausgeführt und wurde beendet. Dies hat folgende Auswirkungen:
-
Die CDK App kann nicht auf Ereignisse reagieren, die während der Bereitstellung auftreten, z. B. auf die Erstellung einer Ressource oder den Abschluss der gesamten Bereitstellung. Um Code während der Bereitstellungsphase auszuführen, müssen Sie ihn als benutzerdefinierte Ressource in die AWS CloudFormation Vorlage einfügen. Weitere Informationen zum Hinzufügen einer benutzerdefinierten Ressource zu Ihrer App finden Sie im AWS CloudFormation Modul oder im Beispiel für eine benutzerdefinierte Ressource
. Sie können das Triggers-Modul auch so konfigurieren, dass Code während der Bereitstellung ausgeführt wird. -
Die CDK App muss möglicherweise mit Werten arbeiten, die zum Zeitpunkt der Ausführung nicht bekannt sind. Wenn die AWS CDK App beispielsweise einen Amazon S3 S3-Bucket mit einem automatisch generierten Namen definiert und Sie das
bucket.bucketName
(Python:bucket_name
) -Attribut abrufen, ist dieser Wert nicht der Name des bereitgestellten Buckets. Stattdessen erhalten Sie einenToken
Wert. Um festzustellen, ob ein bestimmter Wert verfügbar ist, rufen Siecdk.isUnresolved(value)
(Python:is_unresolved
) auf. Details dazu finden Sie unter Tokens und die AWS CDK.
Bereitstellungsberechtigungen
Bevor die Bereitstellung durchgeführt werden kann, müssen Berechtigungen eingerichtet werden. Das folgende Diagramm zeigt die Berechtigungen, die während einer Standardbereitstellung verwendet werden, wenn der Standard-Bootstrapping-Prozess und der Stack-Synthesizer verwendet werden:
- Der Akteur initiiert die Bereitstellung
-
Bereitstellungen werden von einem Akteur initiiert, der CDK CLI Ein Akteur kann entweder eine Person oder ein Dienst wie AWS CodePipeline sein.
Falls erforderlich, CDK CLI läuft
cdk synth
er, wenn Sie laufencdk deploy
. Bei der Synthese geht die AWS Identität davon aus, dassLookupRole
sie Kontext-Lookups in der AWS Umgebung durchführt. - Die Berechtigungen sind eingerichtet
-
Zunächst werden die Sicherheitsanmeldedaten des Akteurs verwendet, um sich zu authentifizieren AWS und die erste IAM Identität im Prozess zu erhalten. Wie Sicherheitsnachweise konfiguriert und abgerufen werden, hängt für menschliche Akteure davon ab, wie Sie oder Ihr Unternehmen Benutzer verwalten. Weitere Informationen finden Sie unter Konfigurieren Sie Sicherheitsanmeldedaten für AWS CDKCLI. Für Serviceakteure wird CodePipeline beispielsweise eine IAM Ausführungsrolle übernommen und verwendet.
Als Nächstes werden die IAM Rollen, die während des Bootstrappings in Ihrer AWS Umgebung erstellt wurden, verwendet, um Berechtigungen für die Durchführung der für die Bereitstellung erforderlichen Aktionen einzurichten. Weitere Informationen zu diesen Rollen und zu den Funktionen, für die sie Berechtigungen gewähren, finden Sie unter. IAMRollen, die beim Bootstrapping erstellt wurden Dieser Prozess umfasst Folgendes:
-
Die AWS Identität übernimmt die
DeploymentActionRole
Rolle und gibt dieCloudFormationExecutionRole
Rolle an sie weiter. Dabei wird sichergestellt CloudFormation, dass sie die Rolle CloudFormation übernimmt, wenn sie Aktionen in Ihrer AWS Umgebung ausführt.DeploymentActionRole
erteilt die Erlaubnis zur Durchführung von Bereitstellungen in Ihrer Umgebung undCloudFormationExecutionRole
legt fest, welche Aktionen ausgeführt CloudFormation werden können. -
Die AWS Identität nimmt die an
FilePublishingRole
, die bestimmt, welche Aktionen auf dem Amazon S3 S3-Bucket ausgeführt werden können, der beim Bootstrapping erstellt wurde. -
Die AWS Identität nimmt die an
ImagePublishingRole
, die bestimmt, welche Aktionen auf dem ECR Amazon-Repository ausgeführt werden können, das beim Bootstrapping erstellt wurde. -
Falls erforderlich, geht die AWS Identität davon aus, dass
LookupRole
sie Kontext-Lookups in der Umgebung durchführt. AWS Diese Aktion kann auch während der Template-Synthese durchgeführt werden.
-
- Die Bereitstellung wird durchgeführt
-
Während der Bereitstellung CDK CLI liest der den Bootstrap-Versionsparameter, um die Bootstrap-Versionsnummer zu bestätigen. AWS CloudFormation liest diesen Parameter zur Bestätigung auch bei der Bereitstellung. Wenn die Berechtigungen für den gesamten Bereitstellungs-Workflow gültig sind, wird die Bereitstellung durchgeführt. Die Ressourcen werden auf die Bootstrap-Ressourcen hochgeladen und die bei der Synthese erstellte CloudFormation Vorlage wird bereitgestellt, wobei der CloudFormation Service als CloudFormation Stack für die Bereitstellung Ihrer Ressourcen verwendet wird.