Verwenden von Umgebungsvariablen in einer Amplify-Anwendung

Umgebungsvariablen sind Schlüssel-Wert-Paare, die Sie zu den Einstellungen Ihrer Anwendung hinzufügen können, um sie für Amplify Hosting verfügbar zu machen. Als bewährte Methode können Sie Umgebungsvariablen verwenden, um Anwendungskonfigurationsdaten verfügbar zu machen. Alle Umgebungsvariablen, die Sie hinzufügen, sind verschlüsselt, um unbefugten Zugriff zu verhindern.

Amplify erzwingt die folgenden Einschränkungen für die von Ihnen erstellten Umgebungsvariablen.

• Amplify erlaubt Ihnen nicht, Umgebungsvariablennamen mit einem AWS Präfix zu erstellen. Dieses Präfix ist nur für den internen Gebrauch von Amplify reserviert.

• Der Wert einer Umgebungsvariablen darf 5500 Zeichen nicht überschreiten.

Wichtig

Verwenden Sie keine Umgebungsvariablen zum Speichern von Geheimnissen. Verwenden Sie für eine Gen 2-App die Secret-Verwaltungsfunktion in der Amplify-Konsole. Weitere Informationen finden Sie unter Secrets and environment vars in der Amplify-Dokumentation. Speichern Sie für eine Gen-1-App Geheimnisse in einem Umgebungsgeheimnis, das mit dem AWS Systems Manager Parameter Store erstellt wurde. Weitere Informationen finden Sie unter Verwaltung von Umgebungsgeheimnissen.

Umgebungsvariablenreferenz Amplify

Auf die folgenden Umgebungsvariablen kann standardmäßig in der Amplify-Konsole zugegriffen werden.

Variablenname	Beschreibung	Beispielwert
_BUILD_TIMEOUT	Die Dauer des Build-Timeouts in Minuten. Der Mindestwert ist 5. Der Höchstwert ist 120.	30
_LIVE_UPDATES	Das Tool wird auf die neueste Version aktualisiert.	[{"name":"Amplify CLI","pkg":"@aws-amplify/cli","type":"npm","version":"latest"}]
USER_DISABLE_TESTS	Der Testschritt wird während eines Builds übersprungen. Sie können Tests für alle Zweige oder bestimmte Zweige in einer App deaktivieren. Diese Umgebungsvariable wird für Apps verwendet, die während der Buildphase Tests durchführen. Weitere Informationen zum Setzen dieser Variablen finden Sie unterTests für eine Amplify-Anwendung oder einen Amplify-Zweig ausschalten.	true
AWS_APP_ID	Die App-ID des aktuellen Builds	abcd1234
AWS_BRANCH	Der Verzweigungsname des aktuellen Builds	main, develop, beta, v2.0
AWS_BRANCH_ARN	Der Branch Amazon Resource Name (ARN) des aktuellen Builds	aws:arn:amplify:us-west-2:123456789012:appname/branch/...
AWS_CLONE_URL	Der Klon, der zum Abrufen der Inhalte des Git-Repositorys URL verwendet wurde	[e-mail]:<user-name>/<repo-name>.git
AWS_COMMIT_ID	Die Commit-ID des aktuellen Builds „HEAD“ für Neuerstellungen	abcd1234
AWS_JOB_ID	Die Auftrags-ID des aktuellen Builds. Dies beinhaltet eine gewisse Polsterung von '0', sodass es immer dieselbe Länge hat.	0000000001
AWS_PULL_REQUEST_ID	Die Pull-Request-ID des Pull-Request-Webvorschau-Builds. Diese Umgebungsvariable ist nicht verfügbar, wenn Sie sie AWS CodeCommit als Repository-Anbieter verwenden.	1
AWS_PULL_REQUEST_SOURCE_BRANCH	Der Name des Feature-Branches für eine Pull-Request-Vorschau, der an einen Anwendungszweig in der Amplify-Konsole gesendet wird.	featureA
AWS_PULL_REQUEST_DESTINATION_BRANCH	Der Name des Anwendungszweigs in der Amplify-Konsole, an den eine Feature-Branch-Pull-Anfrage gesendet wird.	main
AMPLIFY_AMAZON_CLIENT_ID	Die Amazon-Kunden-ID	123456
AMPLIFY_AMAZON_CLIENT_SECRET	Das Geheimnis des Amazon-Kunden	example123456
AMPLIFY_FACEBOOK_CLIENT_ID	Die Facebook-Kunden-ID	123456
AMPLIFY_FACEBOOK_CLIENT_SECRET	Das geheime Facebook-Kundengeheimnis	example123456
AMPLIFY_GOOGLE_CLIENT_ID	Die Google-Kunden-ID	123456
AMPLIFY_GOOGLE_CLIENT_SECRET	Das Geheimnis des Google-Clients	example123456
AMPLIFY_DIFF_DEPLOY	Aktivieren oder deaktivieren Sie die diff-basierte Frontend-Bereitstellung. Weitere Informationen finden Sie unter Konfiguration von diff-basiertem Frontend, Build und Deployment.	true
AMPLIFY_DIFF_DEPLOY_ROOT	Der Pfad, der für Vergleichsvergleiche von Frontend-Deployments verwendet werden soll, relativ zum Stammverzeichnis Ihres Repositorys.	dist
AMPLIFY_DIFF_BACKEND	Aktiviert oder deaktiviert diff-basierte Backend-Builds. Dies gilt nur für Apps der 1. Generation. Weitere Informationen finden Sie unter Konfiguration von diff-basierten Backend-Builds für eine Gen-1-App	true
AMPLIFY_BACKEND_PULL_ONLY	Amplify verwaltet diese Umgebungsvariable. Dies gilt nur für Apps der 1. Generation. Weitere Informationen finden Sie unter Bearbeiten Sie ein vorhandenes Frontend so, dass es auf ein anderes Backend verweist	true
AMPLIFY_BACKEND_APP_ID	Amplify verwaltet diese Umgebungsvariable. Dies gilt nur für Apps der 1. Generation. Weitere Informationen finden Sie unter Bearbeiten Sie ein vorhandenes Frontend so, dass es auf ein anderes Backend verweist	abcd1234
AMPLIFY_SKIP_BACKEND_BUILD	Wenn Ihre Build-Spezifikation keinen Backend-Abschnitt enthält und Sie Backend-Builds deaktivieren möchten, setzen Sie diese Umgebungsvariable auf. true Dies gilt nur für Apps der 1. Generation.	true
AMPLIFY_ENABLE_DEBUG_OUTPUT	Setzen Sie diese Variable auf, true um einen Stack-Trace in den Protokollen zu drucken. Dies ist hilfreich beim Debuggen von Backend-Build-Fehlern.	true
AMPLIFY_MONOREPO_APP_ROOT	Der Pfad, der verwendet werden soll, um das App-Stammverzeichnis einer Monorepo-App relativ zum Stammverzeichnis Ihres Repositorys anzugeben.	apps/react-app
AMPLIFY_USERPOOL_ID	Die ID für den Amazon Cognito Cognito-Benutzerpool, der für die Authentifizierung importiert wurde	us-west-2_example
AMPLIFY_WEBCLIENT_ID	Die ID für den App-Client, der von Webanwendungen verwendet werden soll Der App-Client muss mit Zugriff auf den Amazon Cognito Cognito-Benutzerpool konfiguriert sein, der durch die Umgebungsvariable AMPLIFY _ USERPOOL _ID angegeben wird.	123456
AMPLIFY_NATIVECLIENT_ID	Die ID für den App-Client, der von systemeigenen Anwendungen verwendet werden soll Der App-Client muss mit Zugriff auf den Amazon Cognito Cognito-Benutzerpool konfiguriert sein, der durch die Umgebungsvariable AMPLIFY _ USERPOOL _ID angegeben wird.	123456
AMPLIFY_IDENTITYPOOL_ID	Die ID für den Amazon Cognito Cognito-Identitätspool	example-identitypool-id
AMPLIFY_PERMISSIONS_BOUNDARY_ARN	Die ARN IAM Richtlinie soll als Berechtigungsgrenze verwendet werden, die für alle von Amplify erstellten IAM Rollen gilt.	arn:aws:iam::123456789012:policy/example-policy
AMPLIFY_DESTRUCTIVE_UPDATES	Setzen Sie diese Umgebungsvariable auf true, damit GraphQL mit Schemaoperationen aktualisiert werden kann, die möglicherweise API zu Datenverlust führen können.	true

Anmerkung

Die Umgebungsvariablen AMPLIFY_AMAZON_CLIENT_ID und die AMPLIFY_AMAZON_CLIENT_SECRET Umgebungsvariablen sind OAuth Token, kein AWS Zugriffsschlüssel und kein geheimer Schlüssel.

Umgebungsvariablen des Frontend-Frameworks

Wenn Sie Ihre App mit einem Frontend-Framework entwickeln, das seine eigenen Umgebungsvariablen unterstützt, ist es wichtig zu verstehen, dass diese nicht mit den Umgebungsvariablen identisch sind, die Sie in der Amplify-Konsole konfigurieren. Mit React (mit dem Präfix REACT _APP) und Gatsby (mit dem PräfixGATSBY) können Sie beispielsweise Laufzeitumgebungsvariablen erstellen, die diese Frameworks automatisch in Ihren Frontend-Produktions-Build bündeln. Informationen zu den Auswirkungen der Verwendung dieser Umgebungsvariablen zum Speichern von Werten finden Sie in der Dokumentation für das von Ihnen verwendete Frontend-Framework.

Das Speichern sensibler Werte, wie API Schlüssel, in diesen Umgebungsvariablen des Frontend-Frameworks mit Präfix ist keine bewährte Methode und es wird dringend davon abgeraten. Ein Beispiel für die Verwendung der Build-Time-Umgebungsvariablen von Amplify für diesen Zweck finden Sie unter. Zugreifen auf Umgebungsvariablen zur Build-Zeit