Utilisation de variables d'environnement dans une application Amplify - AWS Amplify Hébergement

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Utilisation de variables d'environnement dans une application Amplify

Les variables d'environnement sont des paires clé-valeur que vous pouvez ajouter aux paramètres de votre application pour les mettre à la disposition d'Amplify Hosting. La meilleure pratique consiste à utiliser des variables d'environnement pour exposer les données de configuration des applications. Toutes les variables d'environnement que vous ajoutez sont chiffrées pour empêcher tout accès non autorisé.

Amplify applique les contraintes suivantes aux variables d'environnement que vous créez.

  • Amplify ne vous permet pas de créer des noms de variables d'environnement avec un AWS préfixe. Ce préfixe est réservé à un usage interne d'Amplify uniquement.

  • La valeur d'une variable d'environnement ne peut pas dépasser 5 500 caractères.

Important

N'utilisez pas de variables d'environnement pour stocker des secrets. Pour une application Gen 2, utilisez la fonction de gestion des secrets de la console Amplify. Pour plus d'informations, consultez la section Secrets et variables d'environnement dans la documentation Amplify. Pour une application Gen 1, stockez les secrets dans un secret d'environnement créé à l'aide du AWS Systems Manager Parameter Store. Pour de plus amples informations, veuillez consulter Gestion des secrets environnementaux.

Amplifier la référence des variables d'environnement

Les variables d'environnement suivantes sont accessibles par défaut dans la console Amplify.

Nom de variable Description Exemple de valeur

_BUILD_TIMEOUT

Durée du délai de construction en minutes

30

_LIVE_UPDATES

L'outil sera mis à niveau vers la dernière version.

[{"name":"Amplify CLI","pkg":"@aws-amplify/cli","type":"npm","version":"latest"}]

USER_DISABLE_TESTS

L'étape de test est ignorée lors d'une génération. Vous pouvez désactiver les tests pour toutes les branches ou pour des branches spécifiques d'une application.

Cette variable d'environnement est utilisée pour les applications qui effectuent des tests pendant la phase de création. Pour plus d'informations sur la définition de cette variable, consultezDésactiver les tests pour une application ou une branche Amplify.

true

AWS_APP_ID

ID d'application du build actuel

abcd1234

AWS_BRANCH

Nom de branche du build actuel

main, develop, beta, v2.0

AWS_BRANCH_ARN

La branche Amazon Resource Name (ARN) de la version actuelle

aws:arn:amplify:us-west-2:123456789012:appname/branch/...

AWS_CLONE_URL

Le clone URL utilisé pour récupérer le contenu du dépôt git

git@github.com:<user-name>/<repo-name>.git

AWS_COMMIT_ID

L'ID de validation de la version actuelle

« HEAD » pour les reconstructions

abcd1234

AWS_JOB_ID

ID de tâche du build actuel.

Cela inclut un rembourrage de « 0 » afin qu'il ait toujours la même longueur.

0000000001

AWS_PULL_REQUEST_ID

L'ID de pull request de la version préliminaire Web de la pull request.

Cette variable d'environnement n'est pas disponible lorsque vous l'utilisez en AWS CodeCommit tant que fournisseur de référentiel.

1

AWS_PULL_REQUEST_SOURCE_BRANCH

Nom de la branche de fonctionnalité pour un aperçu de pull request soumis à une branche d'application dans la console Amplify.

featureA

AWS_PULL_REQUEST_DESTINATION_BRANCH

Nom de la branche d'application de la console Amplify à laquelle une pull request de branche de fonctionnalité est soumise.

main

AMPLIFY_AMAZON_CLIENT_ID

L'identifiant du client Amazon

123456

AMPLIFY_AMAZON_CLIENT_SECRET

Le secret du client Amazon

example123456

AMPLIFY_FACEBOOK_CLIENT_ID

L'identifiant du client Facebook

123456

AMPLIFY_FACEBOOK_CLIENT_SECRET

Le secret du client Facebook

example123456

AMPLIFY_GOOGLE_CLIENT_ID

L'identifiant du client Google

123456

AMPLIFY_GOOGLE_CLIENT_SECRET

Le secret du client de Google

example123456

AMPLIFY_DIFF_DEPLOY

Activez ou désactivez le déploiement frontal basé sur les différences. Pour de plus amples informations, veuillez consulter Configuration de la création et du déploiement d'un frontend basé sur Diff.

true

AMPLIFY_DIFF_DEPLOY_ROOT

Le chemin à utiliser pour les comparaisons de déploiements frontaux basées sur les différences, par rapport à la racine de votre référentiel.

dist

AMPLIFY_DIFF_BACKEND

Activez ou désactivez les versions de backend basées sur les différences. Cela s'applique uniquement aux applications Gen 1. Pour plus d’informations, consultez Configuration de versions de backend basées sur les différences pour une application de première génération.

true

AMPLIFY_BACKEND_PULL_ONLY

Amplify gère cette variable d'environnement. Cela s'applique uniquement aux applications Gen 1. Pour plus d’informations, consultez Modifier un frontend existant pour qu'il pointe vers un autre backend.

true

AMPLIFY_BACKEND_APP_ID

Amplify gère cette variable d'environnement. Cela s'applique uniquement aux applications Gen 1. Pour plus d’informations, consultez Modifier un frontend existant pour qu'il pointe vers un autre backend.

abcd1234

AMPLIFY_SKIP_BACKEND_BUILD

Si votre spécification de build ne contient aucune section de backend et que vous souhaitez désactiver les builds de backend, définissez cette variable d'environnement sur. true Cela s'applique uniquement aux applications Gen 1.

true

AMPLIFY_ENABLE_DEBUG_OUTPUT

Définissez cette variable sur true pour imprimer une trace de pile dans les journaux. Cela est utile pour corriger les erreurs de compilation du backend.

true

AMPLIFY_MONOREPO_APP_ROOT

Le chemin à utiliser pour spécifier la racine d'une application monorepo, par rapport à la racine de votre dépôt.

apps/react-app

AMPLIFY_USERPOOL_ID

L'ID du groupe d'utilisateurs Amazon Cognito importé pour l'authentification

us-west-2_example

AMPLIFY_WEBCLIENT_ID

L'ID du client d'application à utiliser par les applications Web

Le client de l'application doit être configuré pour accéder au groupe d'utilisateurs Amazon Cognito spécifié par la variable d'environnement AMPLIFY _ USERPOOL _ID.

123456

AMPLIFY_NATIVECLIENT_ID

L'ID du client d'application à utiliser par les applications natives

Le client de l'application doit être configuré pour accéder au groupe d'utilisateurs Amazon Cognito spécifié par la variable d'environnement AMPLIFY _ USERPOOL _ID.

123456

AMPLIFY_IDENTITYPOOL_ID

L'ID du pool d'identités Amazon Cognito

example-identitypool-id

AMPLIFY_PERMISSIONS_BOUNDARY_ARN

ARNPour que la IAM politique soit utilisée comme limite d'autorisation applicable à tous les IAM rôles créés par Amplify.

arn:aws:iam::123456789012:policy/example-policy

AMPLIFY_DESTRUCTIVE_UPDATES

Définissez cette variable d'environnement sur true pour permettre à un GraphQL d'être mis API à jour avec des opérations de schéma susceptibles de provoquer une perte de données.

true

Note

Les variables d'AMPLIFY_AMAZON_CLIENT_SECRETenvironnement AMPLIFY_AMAZON_CLIENT_ID et sont OAuth des jetons, et non une clé d' AWS accès ou une clé secrète.

Variables d'environnement du framework frontal

Si vous développez votre application avec un framework frontal qui prend en charge ses propres variables d'environnement, il est important de comprendre que celles-ci ne sont pas identiques aux variables d'environnement que vous configurez dans la console Amplify. Par exemple, React (préfixé REACT _APP) et Gatsby (préfixéGATSBY) vous permettent de créer des variables d'environnement d'exécution que ces frameworks intègrent automatiquement dans votre version de production frontale. Pour comprendre les effets de l'utilisation de ces variables d'environnement pour stocker des valeurs, reportez-vous à la documentation du framework d'interface que vous utilisez.

Le stockage de valeurs sensibles, telles que API des clés, dans ces variables d'environnement préfixées par le framework frontal n'est pas une bonne pratique et est fortement déconseillé. Pour un exemple d'utilisation des variables d'environnement de temps de construction d'Amplify à cette fin, voirAccès aux variables d'environnement au moment de la construction.