Erste Schritte mit der AWS CDK - AWS Cloud Development Kit (AWS CDK) v2

Dies ist der AWS CDK v2-Entwicklerhandbuch. Das ältere CDK v1 wurde am 1. Juni 2022 gewartet 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.

Erste Schritte mit der AWS CDK

Beginnen Sie mit der , AWS Cloud Development Kit (AWS CDK) indem Sie die AWS CDK CLI installieren und Ihre erste CDK-App erstellen.

Voraussetzungen

Empfohlene Ressourcen

Bevor Sie mit der beginnen AWS CDK, empfehlen wir ein grundlegendes Verständnis der folgenden Punkte:

  • Eine Einführung in die AWS CDK. Weitere Informationen hierzu finden Sie unter Was ist der AWS CDK?.

  • Kernkonzepte hinter dem AWS CDK. Weitere Informationen hierzu finden Sie unter Lernen Sie die AWS CDK Kernkonzepte kennen.

  • Die AWS-Services , die Sie mit der verwalten möchten AWS CDK.

  • AWS Identity and Access Management. Weitere Informationen finden Sie unter Was ist IAM? und Was ist IAM Identity Center?

  • AWS CloudFormation da den - AWS CloudFormation Service zur Bereitstellung von Ressourcen AWS CDK verwendet, die im CDK erstellt wurden. Weitere Informationen finden Sie unter Was ist AWS CloudFormation?

  • Die unterstützte Programmiersprache, die Sie mit dem verwenden möchten AWS CDK.

Vorbereiten Ihrer lokalen Umgebung

Alle AWS CDK Entwickler benötigen unabhängig von Ihrer bevorzugten Sprache Node.js 14.15.0 oder höher. Alle unterstützten Programmiersprachen verwenden dasselbe Backend, das auf ausgeführt wirdNode.js. Wir empfehlen eine -Version mit aktiver langfristiger Unterstützung. Ihre Organisation hat möglicherweise eine andere Empfehlung.

Wichtig

Die Node.js-Versionen 13.0.0 bis 13.6.0 sind AWS CDK aufgrund von Kompatibilitätsproblemen mit ihren Abhängigkeiten nicht mit dem kompatibel.

Andere Voraussetzungen hängen von der Sprache ab, in der Sie AWS CDK Anwendungen entwickeln, und lauten wie folgt.

TypeScript
  • TypeScript 3.8 oder höher (npm -g install typescript)

JavaScript

Keine zusätzlichen Anforderungen

Python
  • Python 3.7 oder höher, einschließlich pip und virtualenv

Java
  • Java Development Kit (JDK) 8 (a.k.a. 1.8) oder höher

  • Apache Maven 3.5 oder höher

Java IDE empfohlen (in einigen Beispielen in diesem Handbuch verwenden wir Eclipse). Die IDE muss Maven-Projekte importieren können. Überprüfen Sie, ob Ihr Projekt für die Verwendung von Java 1.8 festgelegt ist. Legen Sie die Umgebungsvariable JAVA_HOME auf den Pfad fest, in dem Sie das JDK installiert haben.

C#

.NET Core 3.1 oder höher oder .NET 6.0 oder höher.

Visual Studio 2019 (jede Edition) oder Visual Studio Code empfohlen.

Go

Go 1.1.8 oder höher.

Ausführlichere Informationen finden Sie im Abschnitt Voraussetzungen für Ihre Sprache:

Sprachveralterung von Drittanbietern

Jede Sprachversion wird nur unterstützt, bis sie EOL (End of Life) ist, und kann sich ohne vorherige Ankündigung ändern.

Schritt 1: Erstellen eines AWS-Konto

Wenn Sie noch nicht mit vertraut sind AWS, müssen Sie sich für ein registrieren AWS-Konto und einen Administratorbenutzer erstellen. Weitere Informationen finden Sie unter Einrichtung von IAM im IAM-Benutzerhandbuch.

Wenn Sie mit interagieren AWS, geben Sie Ihre AWS Sicherheitsanmeldeinformationen an, um zu überprüfen, wer Sie sind und ob Sie die Berechtigung zum Zugriff auf die Ressourcen haben, die Sie anfordern. AWS verwendet die Sicherheitsanmeldeinformationen, um Ihre Anforderungen zu authentifizieren und zu autorisieren. Weitere Informationen finden Sie unter -AWS Sicherheitsanmeldeinformationen im IAM-Benutzerhandbuch.

Schritt 2: Programmgesteuerten Zugriff konfigurieren

Bei der Entwicklung mit der AWS CDK in Ihrer lokalen Umgebung verlassen Sie sich auf die AWS CDK CLI , um mit Ihren - AWS Ressourcen zu interagieren AWS-Services und diese zu verwalten. Um die verwenden zu können AWS CDK CLI, müssen Sie den programmgesteuerten Zugriff konfigurieren. Weitere Informationen zu den verschiedenen Möglichkeiten, wie Sie den programmgesteuerten Zugriff konfigurieren können, finden Sie unter Authentifizierung und Zugriff im AWS Referenzhandbuch zu -SDKs und Tools.

Für neue Benutzer, denen von ihrem Arbeitgeber keine Authentifizierungsmethode zugewiesen wurde, empfehlen wir die Verwendung von AWS IAM Identity Center. Diese Methode umfasst die Installation der AWS Command Line Interface (AWS CLI) und deren Verwendung für die Konfiguration und Anmeldung beim - AWS Zugriffsportal. Informationen zum Konfigurieren des programmgesteuerten Zugriffs mit IAM Identity Center finden Sie unter IAM-Identity-Center-Authentifizierung im AWS Referenzhandbuch zu -SDKs und Tools. Nach Abschluss sollte Ihre Umgebung die folgenden Elemente enthalten:

  • Die AWS CLI, mit der Sie eine AWS -Zugriffsportalsitzung starten, bevor Sie Ihre Anwendung ausführen.

  • Eine AWSconfigfreigegebene Datei mit einem [default] Profil mit einer Reihe von Konfigurationswerten, auf die über die verwiesen werden kann AWS CDK. Den Speicherort dieser Datei finden Sie unter Speicherort der freigegebenen Dateien im Referenzhandbuch für AWS SDKs und Tools.

  • Die freigegebene config Datei legt die region Einstellung fest. Dadurch wird der Standardwert festgelegt, den AWS-Region die für - AWS Anforderungen AWS CDK verwendet.

  • Die AWS CDK verwendet die SSO-Token-Anbieterkonfiguration des Profils, um Anmeldeinformationen zu erhalten, bevor Anfragen an gesendet werden AWS. Der sso_role_name Wert, bei dem es sich um eine IAM-Rolle handelt, die mit einem IAM-Identity-Center-Berechtigungssatz verbunden ist, sollte den Zugriff auf die in Ihrer Anwendung AWS-Services verwendeten ermöglichen.

    Die folgende config Beispieldatei zeigt ein Standardprofil, das mit der Konfiguration des SSO-Token-Anbieters eingerichtet wurde. Die sso_session Einstellung des Profils bezieht sich auf den benannten sso-session Abschnitt . Der sso-session Abschnitt enthält Einstellungen zum Initiieren einer AWS -Zugriffsportalsitzung.

    [default] sso_session = my-sso sso_account_id = 111122223333 sso_role_name = SampleRole region = us-east-1 output = json [sso-session my-sso] sso_region = us-east-1 sso_start_url = https://provided-domain.awsapps.com/start sso_registration_scopes = sso:account:access

Starten einer - AWS Zugriffsportalsitzung

Bevor Sie auf zugreifen AWS-Services können, benötigen Sie eine aktive - AWS Zugriffsportalsitzung für die , AWS CDK um die IAM-Identity-Center-Authentifizierung zum Auflösen von Anmeldeinformationen verwenden zu können. Abhängig von Ihren konfigurierten Sitzungslängen läuft Ihr Zugriff schließlich ab und bei AWS CDK tritt ein Authentifizierungsfehler auf. Führen Sie den folgenden Befehl in der aus AWS CLI , um sich beim - AWS Zugriffsportal anzumelden.

aws sso login

Wenn Ihre Konfiguration des SSO-Token-Anbieters ein benanntes Profil anstelle des Standardprofils verwendet, lautet der Befehl aws sso login --profile NAME. Geben Sie dieses Profil auch an, wenn Sie cdk Befehle mit der ---profileOption oder der -AWS_PROFILEUmgebungsvariablen ausgeben.

Führen Sie den folgenden AWS CLI Befehl aus, um zu testen, ob Sie bereits über eine aktive Sitzung verfügen.

aws sts get-caller-identity

In der Antwort auf diesen Befehl sollten das in der freigegebenen config-Datei konfigurierte IAM-Identity-Center-Konto und der Berechtigungssatz angegeben werden.

Anmerkung

Wenn Sie bereits über eine aktive - AWS Zugriffsportalsitzung verfügen und ausführenaws sso login, müssen Sie keine Anmeldeinformationen angeben.

Während des Anmeldevorgangs werden Sie möglicherweise aufgefordert, den AWS CLI Zugriff auf Ihre Daten zu erlauben. Da die auf dem SDK für Python AWS CLI aufbaut, können Berechtigungsnachrichten Variationen des botocore Namens enthalten.

Schritt 3: Installieren der AWS CDKCLI

Installieren Sie den AWS CDK CLI global mit dem folgenden Node Package Manager-Befehl.

npm install -g aws-cdk
Anmerkung

Wenn Sie einen Berechtigungsfehler erhalten und Administratorzugriff auf Ihr System haben, versuchen Sie es mit sudo npm install -g aws-cdk.

Führen Sie den folgenden Befehl aus, um eine erfolgreiche Installation zu überprüfen. Der AWS CDK CLI sollte die Versionsnummer ausgeben:

cdk --version

Wenn Sie eine Fehlermeldung erhalten, versuchen Sie, zu AWS CDK CLI deinstallieren, indem Sie Folgendes ausführen:

npm uninstall -g aws-cdk

Wiederholen Sie dann die Schritte, um die neu zu installieren AWS CDK CLI.

Wenn Sie immer noch eine Fehlermeldung erhalten, löschen Sie den node-modules Ordner aus dem aktuellen Projekt und auch aus dem globalen node-modules Ordner. Um diesen Ordner zu finden, führen Sie ausnpm config get prefix.

Der AWS CDK CLI erhält Sicherheitsanmeldeinformationen von Quellen, die Sie in den vorherigen Schritten konfiguriert haben.

Anmerkung

CDK Toolkit v2 funktioniert mit vorhandenen CDK-v1-Projekten. Es kann jedoch keine neuen CDK-v1-Projekte initialisieren. Überprüfen Sie, Neue Voraussetzungen ob Sie dies tun müssen.

Schritt 4: Bootstrappen Ihrer Umgebung

Jede AWS Umgebung, in der Sie Ressourcen bereitstellen möchten, muss bootstrappen.

Führen Sie zum Bootstrappen Folgendes aus:

cdk bootstrap aws://ACCOUNT-NUMBER/REGION
Tipp

Wenn Sie Ihre AWS Kontonummer nicht zur Hand haben, erhalten Sie sie über die AWS Management Console. Oder, wenn Sie die AWS CLI installiert haben, zeigt der folgende Befehl Ihre Standardkontoinformationen an, einschließlich der Kontonummer.

aws sts get-caller-identity

Wenn Sie benannte Profile in Ihrer lokalen AWS Konfiguration erstellt haben, können Sie die --profile Option verwenden, um die Kontoinformationen für ein bestimmtes Profil anzuzeigen. Das folgende Beispiel zeigt, wie Kontoinformationen für das prod-Profil angezeigt werden.

aws sts get-caller-identity --profile prod

Um die Standardregion anzuzeigen, verwenden Sie aws configure get.

aws configure get region aws configure get region --profile prod

Optionale AWS CDK Tools

Das AWS Toolkit for Visual Studio Code ist ein Open-Source-Plug-In für Visual Studio Code, mit dem Sie Anwendungen auf erstellen, debuggen und bereitstellen können AWS. Das Toolkit bietet eine integrierte Erfahrung für die Entwicklung von AWS CDK Anwendungen. Sie enthält die AWS CDK-Explorer-Funktion, um Ihre AWS CDK Projekte aufzulisten und die verschiedenen Komponenten der CDK-Anwendung zu durchsuchen. Installieren Sie das -Plug-In und erfahren Sie mehr über die Verwendung von AWS CDK Explorer .

Nächste Schritte

Nachdem Sie die installiert haben AWS CDK CLI, verwenden Sie sie, um Ihre erste AWS CDK App zu erstellen.

Weitere Informationen zur Verwendung der AWS CDK in Ihrer bevorzugten Programmiersprache finden Sie unter Arbeiten mit AWS CDK in unterstützten Programmiersprachen.

ist AWS CDK ein Open-Source-Projekt. Informationen zum Beitragen finden Sie unter Beitragen zum AWS Cloud Development Kit (AWS CDK).

Weitere Informationen

Weitere Informationen über finden AWS CDK Sie hier:

  • CDK-Workshop – Detaillierter praxisbezogener Workshop.

  • API-Referenz – Erkunden Sie Konstrukte, die für die verfügbar sind AWS-Services , die Sie verwenden werden.

  • Construct Hub – Finden Sie Konstrukte aus der CDK-Community.

  • -AWS CDK Beispiele – Erkunden Sie Codebeispiele von - AWS CDK Projekten.