Variables de entorno - AWS Amplify

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Variables de entorno

Las variables de entorno son pares clave-valor que están disponibles en el momento de la compilación. Estas configuraciones pueden ser de todo tipo, entre las que se incluyen las siguientes:

  • Detalles de la conexión de base de datos

  • Claves de API de terceros

  • Distintos parámetros de personalización

  • Secrets

Como práctica recomendada, puede utilizar variables de entorno para exponer estas configuraciones. Todas las variables de entorno que añada se cifran para evitar el acceso no autorizado por lo que puede utilizarlas para almacenar información secreta.

nota

Environment variables (Variables de entorno):solo se puede ver en el menú de configuración de aplicaciones de Amplify Console cuando una aplicación está configurada para una implementación continua y conectada a un repositorio git. Para obtener instrucciones sobre este tipo de implementación, consulteIntroducción a el código existente.

Configuración de las variables de entorno

Para establecer variables de entorno

  1. Inicie sesión en la consola de administración de AWS y abra laConsola de Amplify.

  2. En la consola de Amplify, elijaConfiguración de aplicaciónHaga clic en y luego enEnvironment variables (Variables de entorno):.

  3. En el navegadorEnvironment variables (Variables de entorno):En la sección, elijaAdministración de variables.

  4. En el navegadorAdministración de variablessección, enVariable, escriba su clave. ParaValor, escriba su valor. De manera predeterminada, la consola de Amplify aplica las variables de entorno en todas las ramas, de manera que no tenga que reingresar las variables cuando se conecta a una nueva ramificación.

    
                  Captura de pantalla de la sección Administrar variables.
  5. (Opcional) Para personalizar una variable de entorno específicamente para una ramificación, añada una anulación de ramificación de la siguiente manera:

    1. SeleccionarActionsHaga clic en y luego enAgregar anulación de variables.

    2. Ahora tiene un conjunto de variables de entorno específicas de su ramificación.

    
                  Un gif animado que muestra cómo agregar una anulación de rama.
  6. Elija Save (Guardar).

Variables de entorno

Para acceder a una variable de entorno durante una compilación, edite la configuración de la compilación para incluir la variable de entorno en los comandos de compilación.

Para editar la configuración de compilación para incluir una variable de entorno

  1. Inicie sesión en la consola de administración de AWS y abra laConsola de Amplify.

  2. En la consola de Amplify, elijaConfiguración de aplicaciónHaga clic en y luego enConfiguración de compilación.

  3. En el navegadorEspecificación de compilación de aplicacionesEn la sección, elijaEditar.

  4. Añada la variable de entorno a su comando de compilación. Ahora debe poder acceder a la variable de entorno durante la siguiente compilación. Este ejemplo cambia el comportamiento de npm (BUILD_ENV) y agrega un token de API (TWITCH_CLIENT_ID) para un servicio externo a un archivo de entorno para su uso posterior:

    build: commands: - npm run build:$BUILD_ENV - echo "TWITCH_CLIENT_ID=$TWITCH_CLIENT_ID" >> backend/.env

Cada comando en su configuración de compilación se ejecuta dentro de un shell de Bash. Para obtener más información acerca de cómo trabajar con variables de entorno en Bash, consulteExpansiones de shellen el Manual de Bash de GNU.

Crear un nuevo entorno back-end con parámetros de autenticación para el inicio de sesión en redes sociales

Para conectar una sucursal a una aplicación

  1. Inicie sesión en la consola de administración de AWS y abra laConsola de Amplify.

  2. El procedimiento para conectar una sucursal a una aplicación varía en función de si está conectando una sucursal a una aplicación nueva o a una aplicación existente.

    • Conectar una sucursal a una nueva aplicación

      1. Al conectar una sucursal a una nueva aplicación, en elConfigurar la configuración de compilaciónSeleccione el paso del asistente, elijaCreación de un nuevo entornoe introduzca el nombre de su entorno back-end. La siguiente captura de pantalla muestra laImplementaciones de back-endde la consola de Amplify conbackendintroducido para el nombre del entorno back-end.

        
                              Captura de pantalla de la sección de implementaciones de backend en Amplify Console.
      2. Expanda laConfiguración avanzadaen el asistente de configuración de configuración de compilación y agregue variables de entorno para claves de inicio de sesión en redes sociales. Por ejemplo,AMPLIFY_FACEBOOK_CLIENT_SECRETes una variable de entorno válida. Para obtener la lista de variables de entorno del sistema Amplify que están disponibles de forma predeterminada, consulte la tabla enAmplify Console.

    • Conectar una sucursal a una aplicación existente

      1. Si está conectando una nueva sucursal a una aplicación existente, configure las variables de entorno de inicio de sesión social antes de conectar la rama. En el panel de navegación, elijaConfiguración de aplicación,Environment variables (Variables de entorno):.

      2. En el navegadorEnvironment variables (Variables de entorno):En la sección, elijaAdministración de variables.

      3. En el navegadorAdministración de variablessección, paraVariable(clave), ingrese su ID de cliente. ParaValor, escriba el secreto del cliente. Para obtener la lista de variables de entorno del sistema Amplify que están disponibles de forma predeterminada, consulte la tabla enAmplify Console.

Variables de entorno

Si está desarrollando su aplicación con un framework frontend que admita sus propias variables de entorno, es importante entender que estas no son las mismas que las variables de entorno que configura en Amplify Console. Por ejemplo, React (prefijo REACT_APP) y Gatsby (prefijo GATSBY), le permiten crear variables de entorno de tiempo de ejecución que esos marcos agrupan automáticamente en su compilación de producción de frontend. Para comprender los efectos del uso de estas variables de entorno para almacenar valores, consulte la documentación del framework frontend que está utilizando.

Almacenar valores sensibles, como claves API, dentro de estas variables de entorno con prefijos de marco frontend no es una práctica recomendada y se desaconseja mucho. Para obtener un ejemplo del uso de las variables de entorno de tiempo de compilación de la Consola Amplify para este propósito, consulteVariables de entorno.

Amplify Console

Puede usar las siguientes variables de entorno a las que se pueda acceder de manera predeterminada en la consola de Amplify.

Nombre de variable Descripción Ejemplo de valor

AWS_APP_ID

ID de aplicación de la compilación actual

abcd123

AWS_BRANCH

Nombre de ramificación de la compilación actual

main, develop, beta, v2.0

AWS_BRANCH_ARN

ARN de ramificación de la compilación actual

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

AWS_CLONE_URL

URL clonada usada para recuperar el contenido del repositorio de Git

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

AWS_COMMIT_ID

ID de confirmación de la compilación actual. «HEAD» para reconstrucciones

xxxxxxxxxxxxxxxxxx

AWS_JOB_ID

ID de trabajo de la compilación actual. Esto incluye relleno de «0", por lo que siempre tiene la misma longitud.

0000000001

_LIVE_UPDATES

La herramienta se actualizará a la versión más reciente.

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

AMPLIFY_FACEBOOK_CLIENT_ID

El ID de cliente de Facebook.

123456

AMPLIFY_FACEBOOK_CLIENT_SECRET

El secreto del cliente de Facebook.

ejemplo123456

AMPLIFY_GOOGLE_CLIENT_ID

El ID de cliente de Google.

123456

AMPLIFY_GOOGLE_CLIENT_SECRET

El secreto del cliente de Google.

ejemplo123456

AMPLIFY_AMAZON_CLIENT_ID

El ID de cliente de Amazon.

123456

AMPLIFY_AMAZON_CLIENT_SECRET

El secreto del cliente de Amazon.

ejemplo123456

AMPLIFY_DIFF_DEPLOY

Habilite o deshabilite la implementación de interfaz basada en diferencias. Para obtener más información, consulte Habilitar o deshabilitar la creación e implementación de frontend basados en diff.

true

AMPLIFY_DIFF_DEPLOY_ROOT

Ruta de acceso que se utiliza para las comparaciones de implementación de frontend basadas en diff, en relación con la raíz del repositorio.

dist

_BUILD_TIMEOUT

La duración del tiempo de espera de compilación en minutos.

30

nota

LaAMPLIFY_AMAZON_CLIENT_IDyAMPLIFY_AMAZON_CLIENT_SECRETLas variables de entorno son tokens de OAuth, no una clave de acceso y una clave secreta de AWS.