Dies ist der AWS CDK v2-Entwicklerhandbuch. Das ältere CDK v1 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.
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 CDK-Stacks. 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 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.
-
Die AWS Umgebung muss gebootet werden.
-
Sie AWS CDK müssen die Bootstrap-Ressourcen kennen, in die Ressourcen hochgeladen werden sollen.
Voraussetzungen für CDK-Bereitstellungen
Bevor Sie eine AWS CDK Anwendung bereitstellen können, müssen Sie die folgenden Schritte ausführen:
-
Konfigurieren Sie die Sicherheitsanmeldedaten für das CDK CLI.
-
Bootstrap für Ihre Umgebung AWS .
-
Konfigurieren Sie eine AWS Umgebung für jeden Ihrer CDK-Stacks.
-
Entwickeln Sie Ihre CDK-App.
Konfigurieren Sie Sicherheitsanmeldedaten
Um das CDK zu verwenden CLI Um damit interagieren zu können AWS, müssen Sie Sicherheitsanmeldedaten auf Ihrem lokalen Computer konfigurieren. Detaillierte Anweisungen finden Sie unter Konfigurieren Sie Sicherheitsanmeldedaten für AWS CDK CLI.
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 das CDK zur Durchführung und Verwaltung von Bereitstellungen verwendet. Zu diesen Ressourcen gehören ein Amazon Simple Storage Service (Amazon S3) -Bucket und ein Amazon Elastic Container Registry (Amazon ECR) -Repository zum Speichern und Verwalten von Ressourcen. Zu diesen Ressourcen gehören auch AWS Identity and Access Management (IAM) -Rollen, die zur Erteilung von Berechtigungen während der Entwicklung und Bereitstellung verwendet werden.
Wir empfehlen die Verwendung der AWS CDK Befehlszeilenschnittstelle (AWS CDK CLI) cdk bootstrap Befehl, 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 dem 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 AWS CDK.
Entwickeln Sie Ihre CDK-App
Im Rahmen eines CDK-Projekts erstellen und entwickeln Sie Ihre CDK-App. In deiner App erstellst du einen oder mehrere CDK-Stacks. In Ihren Stacks importieren und verwenden Sie Konstrukte aus der Construct-Bibliothek, um Ihre AWS Infrastruktur zu definieren. Bevor Sie sie bereitstellen können, muss Ihre CDK-App mindestens einen Stack enthalten.
CDK-App-Synthese
Für die Synthese empfehlen wir die Verwendung des CDK CLI cdk synthBefehl. 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 CDK-Stack-Synthese konfigurieren und durchführen.
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 das CDK-Verhalten anpassen, z. B. Bootstrapping oder Synthese, kann das CDK-Bereitstellungsverhalten variieren.
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
prepareMethode 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
validateMethode 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(), durchquert den Konstruktbaum und ruft diesynthesizeMethode für alle Konstrukte auf. Implementierte Konstruktesynthesizekönnen an der Synthese teilnehmen und Bereitstellungsartefakte für die resultierende Cloud-Assembly erzeugen. Zu diesen Artefakten gehören CloudFormation Vorlagen, AWS Lambda Anwendungspakete, Dateien und Docker Image-Ressourcen und andere Bereitstellungsartefakte. In den meisten Fällen müssen Sie diesynthesizeMethode nicht implementieren.
Ihre App ausführen
Das CDK CLI muss 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.
{
"app": "npx ts-node --prefer-ts-exts bin/my-app.ts"
}Wenn Sie Ihr Projekt nicht mit dem CDK erstellt haben CLI, 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...
Der executable 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 cdk-command ist ein Unterbefehl wie synth oderdeploy, der dem CDK mitteilt CLI was du mit deiner App machen möchtest. Fügen Sie anschließend alle zusätzlichen Optionen hinzu, die für diesen Unterbefehl benötigt werden.
Das CDK CLI kann 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-assemblyls
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 normalerweise 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
Für die Bereitstellung Ihrer Anwendung empfehlen wir Ihnen, das CDK zu verwenden CLI cdk deployBefehl zum Initiieren von Bereitstellungen oder zum Konfigurieren automatisierter Bereitstellungen.
Wenn Sie das CDK ausführen cdk deploy CLI leitet ein, cdk synth um sich auf die Bereitstellung vorzubereiten. Das folgende Diagramm veranschaulicht den Lebenszyklus einer App im Kontext einer Bereitstellung:
Während der Bereitstellung wird das CDK CLI nimmt die durch Synthese erzeugte Cloud-Assembly und stellt sie in einer AWS Umgebung bereit. Die Ressourcen werden auf Amazon S3 und Amazon ECR hochgeladen 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 noch 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 einenTokenWert. 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 mithilfe des CDK initiiert CLI. Ein Schauspieler kann entweder eine Person sein, oder eine Dienstleistung wie AWS CodePipeline.
Falls erforderlich, das CDK CLI läuft
cdk synth, wenn ducdk deployrennst. Während der Synthese geht die AWS Identität davon aus, dassLookupRolesie Kontext-Lookups in der AWS Umgebung durchführt. - Berechtigungen sind eingerichtet
-
Zunächst werden die Sicherheitsanmeldedaten des Akteurs verwendet, um sich bei der ersten IAM-Identität zu authentifizieren AWS und diese 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 CDK CLI. Für Serviceakteure wird CodePipeline beispielsweise eine IAM-Ausführungsrolle übernommen und verwendet.
Als Nächstes werden die beim Bootstrapping in Ihrer AWS Umgebung erstellten IAM-Rollen verwendet, um Berechtigungen für die Durchführung der für die Bereitstellung erforderlichen Aktionen einzurichten. Weitere Informationen zu diesen Rollen und dazu, wofür sie Berechtigungen gewähren, finden Sie unter. Beim Bootstrapping erstellte IAM-Rollen Dieser Prozess umfasst Folgendes:
-
Die AWS Identität übernimmt die
DeploymentActionRoleRolle und gibt dieCloudFormationExecutionRoleRolle an sie weiter. Dabei wird sichergestellt CloudFormation, dass sie die Rolle CloudFormation übernimmt, wenn sie Aktionen in Ihrer AWS Umgebung ausführt.DeploymentActionRoleerteilt die Erlaubnis zur Durchführung von Bereitstellungen in Ihrer Umgebung undCloudFormationExecutionRolelegt 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 Amazon ECR-Repository ausgeführt werden können, das beim Bootstrapping erstellt wurde. -
Falls erforderlich, geht die AWS Identität davon aus, dass
LookupRolesie 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 wird das CDK CLI liest 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.
