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:

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

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:

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.

TypeScript

{
  "app": "npx ts-node --prefer-ts-exts bin/my-app.ts"
}

JavaScript

{
  "app": "node bin/my-app.js"
}

Python

{
    "app": "python app.py"
}

Java

{
  "app": "mvn -e -q compile exec:java"
}

C#

{
  "app": "dotnet run -p src/MyApp/MyApp.csproj"
}

Go

{
  "app": "go mod download && go run my-app.go"
}

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:

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: