Uso de variáveis de ambiente em uma aplicação Amplify

As variáveis de ambiente são pares de valores-chave que é possível adicionar às configurações do seu aplicativo para disponibilizá-las para o Amplify Hosting. Como uma melhor prática, é possível usar variáveis de ambiente para expor dados de configuração do aplicativo. Todas as variáveis de ambiente que você adiciona são criptografadas para impedir o acesso não autorizado.

O Amplify impõe as seguintes restrições às variáveis de ambiente que você cria.

• O Amplify não permite que você crie nomes de variáveis de ambiente com um prefixo AWS. Esse prefixo está reservado somente para uso interno do Amplify.

• O valor de uma variável de ambiente não pode exceder 5500 caracteres.

Importante

Não use variáveis de ambiente para armazenar segredos. Para uma aplicação Gen 2, use o atributo Gerenciamento secreto no console do Amplify. Para obter mais informações, consulte Segredos e variáveis de ambiente na documentação do Amplify. Para um aplicativo de primeira geração, armazene segredos em um segredo de ambiente criado usando o AWS Systems Manager Parameter Store. Para obter mais informações, consulte Gerenciamento de segredos de ambiente.

Referência de variáveis de ambiente do Amplify

As seguintes variáveis de ambiente podem ser acessadas por padrão no console do Amplify.

Nome da variável	Descrição	Valor de exemplo
_BUILD_TIMEOUT	A duração do tempo limite de construção em minutos. O valor mínimo é 5. O valor máximo é 120.	30
_LIVE_UPDATES	A ferramenta será atualizada para a versão mais recente.	[{"name":"Amplify CLI","pkg":"@aws-amplify/cli","type":"npm","version":"latest"}]
USER_DISABLE_TESTS	A etapa de teste é ignorada durante uma compilação. É possível desativar os testes para todas as ramificações ou ramificações específicas em um aplicativo. Essa variável de ambiente é usada para aplicativos que realizam testes durante a fase de compilação. Para obter mais informações sobre a configuração dessa variável, consulte Desativação de testes para uma aplicação ou ramificação do Amplify.	true
AWS_APP_ID	O ID da compilação atual	abcd1234
AWS_BRANCH	O nome da ramificação da compilação atual	main, develop, beta, v2.0
AWS_BRANCH_ARN	O nome do recurso da Amazon (ARN) da ramificação da versão atual	aws:arn:amplify:us-west-2:123456789012:appname/branch/...
AWS_CLONE_URL	O URL de clone usado para buscar o conteúdo do repositório Git	[e-mail]:<user-name>/<repo-name>.git
AWS_COMMIT_ID	O ID de confirmação da compilação atual “HEAD” para recompilações	abcd1234
AWS_JOB_ID	O ID de trabalho da compilação atual. Isso inclui algum preenchimento com "0" para que sempre tenha o mesmo comprimento.	0000000001
AWS_PULL_REQUEST_ID	O ID da solicitação de pull da compilação de pré-visualização na Web. Essa variável de ambiente não está disponível ao ser usada AWS CodeCommit como seu provedor de repositório.	1
AWS_PULL_REQUEST_SOURCE_BRANCH	O nome da ramificação de recursos de uma pré-visualização de solicitação de pull enviada para uma ramificação da aplicação no console do Amplify.	featureA
AWS_PULL_REQUEST_DESTINATION_BRANCH	O nome da ramificação da aplicação no console do Amplify para a qual uma solicitação de pull de ramificação da aplicação recursos está sendo enviada.	main
AMPLIFY_AMAZON_CLIENT_ID	O ID do cliente da Amazon	123456
AMPLIFY_AMAZON_CLIENT_SECRET	O segredo do cliente da Amazon	example123456
AMPLIFY_FACEBOOK_CLIENT_ID	O ID do cliente do Facebook	123456
AMPLIFY_FACEBOOK_CLIENT_SECRET	O segredo do cliente do Facebook	example123456
AMPLIFY_GOOGLE_CLIENT_ID	O ID do cliente do Google	123456
AMPLIFY_GOOGLE_CLIENT_SECRET	O segredo do cliente do Google	example123456
AMPLIFY_DIFF_DEPLOY	Ative ou desative a implantação de frontend baseada em diff. Para obter mais informações, consulte Configuração de compilação e implantação de frontend baseado em diff.	true
AMPLIFY_DIFF_DEPLOY_ROOT	O caminho a ser usado para comparações de implantação de frontend baseadas em diff, em relação à raiz do seu repositório.	dist
AMPLIFY_DIFF_BACKEND	Ative ou desative as compilações de backend baseadas em diff. Isso se aplica somente às aplicações Gen 1. Para ter mais informações, consulte Configuração de compilações de backend baseadas em diff para uma aplicação Gen 1	true
AMPLIFY_BACKEND_PULL_ONLY	O Amplify gerencia essa variável de ambiente. Isso se aplica somente às aplicações Gen 1. Para ter mais informações, consulte Edite um frontend existente para apontar para um backend diferente	true
AMPLIFY_BACKEND_APP_ID	O Amplify gerencia essa variável de ambiente. Isso se aplica somente às aplicações Gen 1. Para ter mais informações, consulte Edite um frontend existente para apontar para um backend diferente	abcd1234
AMPLIFY_SKIP_BACKEND_BUILD	Se você não tiver uma seção de backend em sua especificação de compilação e quiser desativar as compilações de backend, defina essa variável de ambiente como true. Isso se aplica somente às aplicações Gen 1.	true
AMPLIFY_ENABLE_DEBUG_OUTPUT	Defina essa variável como true para imprimir um rastreamento de pilha nos logs. Isso é útil para depurar erros de compilação do backend.	true
AMPLIFY_MONOREPO_APP_ROOT	O caminho a ser usado para especificar a raiz do aplicativo monorepo, em relação à raiz do seu repositório.	apps/react-app
AMPLIFY_USERPOOL_ID	O ID do grupo de usuários do Amazon Cognito importado para autenticação	us-west-2_example
AMPLIFY_WEBCLIENT_ID	O ID do cliente do aplicativo a ser usado por aplicativos da web O cliente do aplicativo deve ser configurado com acesso ao grupo de usuários do Amazon Cognito especificado pela variável de ambiente AMPLIFY_USERPOOL_ID.	123456
AMPLIFY_NATIVECLIENT_ID	O ID do cliente do aplicativo a ser usado por aplicativos nativos O cliente do aplicativo deve ser configurado com acesso ao grupo de usuários do Amazon Cognito especificado pela variável de ambiente AMPLIFY_USERPOOL_ID.	123456
AMPLIFY_IDENTITYPOOL_ID	O ID do banco de identidades do Amazon Cognito	example-identitypool-id
AMPLIFY_PERMISSIONS_BOUNDARY_ARN	O ARN para uso da política do IAM como limite de permissões que se aplica a todas os perfis do IAM criados pelo Amplify.	arn:aws:iam::123456789012:policy/example-policy
AMPLIFY_DESTRUCTIVE_UPDATES	Defina essa variável de ambiente como verdadeiro para permitir que uma API GraphQL seja atualizada com operações de esquema que podem potencialmente causar perda de dados.	true

nota

As variáveis de AMPLIFY_AMAZON_CLIENT_SECRET ambiente AMPLIFY_AMAZON_CLIENT_ID e são OAuth tokens, não uma chave de AWS acesso e uma chave secreta.

Variáveis de ambiente da estrutura de frontend

Se você estiver desenvolvendo seu aplicativo com uma estrutura de frontend que suporta suas próprias variáveis de ambiente, é importante entender que elas não são iguais às variáveis de ambiente que você configura no console do Amplify. Por exemplo, React (prefixado REACT_APP) e Gatsby (prefixado GATSBY) permitem que você crie variáveis de ambiente de runtime que essas estruturas agrupam automaticamente em sua compilação de produção de frontend. Para entender os efeitos do uso dessas variáveis de ambiente para armazenar valores, consulte a documentação da estrutura de frontend que você está usando.

Armazenar valores confidenciais, como chaves de API, dentro dessas variáveis de ambiente prefixadas da estrutura de frontend não é uma prática recomendada e é altamente desencorajado. Para obter um exemplo de uso das variáveis de ambiente de tempo de compilação do Amplify para essa finalidade, consulte Acesso a variáveis de ambiente no momento da compilação.