Variáveis de ambiente

As variáveis de ambiente são pares chave-valor que estão disponíveis no momento da criação. Essas configurações podem ser qualquer coisa, incluindo as seguintes:

• Detalhes da conexão do banco de dados

• Chaves de API de terceiros

• Parâmetros de personalização diferentes

• Segredos

Como uma melhor prática, é possível usar variáveis de ambiente para expor essas configurações. Todas as variáveis de ambiente que você adiciona são criptografadas para impedir o acesso não autorizado, para que você possa usá-las para armazenar informações secretas.

nota

As variáveis de ambiente são visíveis no menu de configurações do aplicativo do console Amplify somente quando um aplicativo está configurado para implantação contínua e conectado a um repositório git. Para obter instruções sobre esse tipo de implantação, consulte Introdução ao código existente.

Definição de variáveis de ambiente

Para definir variáveis de ambiente

1. Faça login noAWS Management Console e abra o console do Amplify.

2. No console do Amplify, escolha Configurações do aplicativo e escolha Variáveis de ambiente.

3. Na seção Variáveis de ambiente, escolha Gerenciar variáveis.

4. Na seção Gerenciar variáveis, em Variável, insira sua chave. Em Valor, insira seu valor. Por padrão, o Amplify aplica as variáveis de ambiente em todas as ramificações, para que você não precise inserir as variáveis novamente ao conectar uma nova ramificação.

   

5. (Opcional) Para personalizar uma variável de ambiente especificamente para uma ramificação, adicione uma substituição de ramificação da seguinte forma:

   1. Escolha Ações e, em seguida, escolha Adicionar substituição de variável.

   2. Agora, você tem um conjunto de variáveis de ambiente específicas para sua ramificação.

   

6. Escolha Save (Salvar).

Acessar variáveis de ambiente

Para acessar uma variável de ambiente durante uma criação, edite as configurações da criação para incluir a variável de ambiente nos comandos de criação.

Para editar as configurações de compilação para incluir uma variável de ambiente

1. Faça login noAWS Management Console e abra o console do Amplify.

2. No console do Amplify, escolha Configurações do aplicativo e escolha Criar configurações.

3. Na seção Especificação de criação do aplicativo, escolha Editar.

4. Adicione a variável de ambiente ao comando de criação. Agora você deve ser capaz de acessar a variável de ambiente durante a próxima criação. Este exemplo altera o comportamento do npm (BUILD_ENV) e adiciona um token de API (TWITCH_CLIENT_ID) para um serviço externo a um arquivo de ambiente para uso posterior:

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

Cada comando em sua configuração de compilação é executado dentro de um shell Bash. Para obter mais informações sobre como trabalhar com variáveis de ambiente no Bash, consulte Expansões do Shell no Manual do GNU Bash.

Crie um novo ambiente de back-end com parâmetros de autenticação para login social

Para conectar uma filial a um aplicativo

1. Faça login noAWS Management Console e abra o console do Amplify.

2. O procedimento para conectar uma ramificação a um aplicativo varia dependendo se você está conectando uma ramificação a um novo aplicativo ou a um aplicativo existente.

   • Conectando uma filial a um novo aplicativo

     1. Ao conectar uma ramificação a um novo aplicativo, na etapa Definir configurações de compilação do assistente, escolha Criar novo ambiente e insira o nome do seu ambiente de back-end. A captura de tela a seguir mostra a seção de implantações de back-end do console Amplify com o nome do ambiente de back-endbackend inserido.

        

     2. Expanda a seção Configurações avançadas no assistente de configuração de configurações de compilação e adicione variáveis de ambiente às chaves de login social. Por exemplo,AMPLIFY_FACEBOOK_CLIENT_SECRET é uma variável de ambiente válida. Para ver a lista de variáveis de ambiente do sistema Amplify que estão disponíveis por padrão, consulte a tabela emAmplify variáveis de ambiente.

   • Conectando uma filial a um aplicativo existente

     1. Se você estiver conectando uma nova ramificação a um aplicativo existente, defina as variáveis do ambiente de login social antes de conectar a ramificação. No painel de navegação, escolha Configurações do aplicativo, Variáveis de ambiente.

     2. Na seção Variáveis de ambiente, escolha Gerenciar variáveis.

     3. Na seção Gerenciar variáveis, em Variável (chave), insira seu ID de cliente. Em Value, insira o segredo do seu cliente. Para ver a lista de variáveis de ambiente do sistema Amplify que estão disponíveis por padrão, consulte a tabela emAmplify variáveis de ambiente.

Variáveis de ambiente de estrutura de front-end

Se você estiver desenvolvendo seu aplicativo com uma estrutura de front-end 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 (prefixo REACT_APP) e Gatsby (prefixado GATSBY) permitem que você crie variáveis de ambiente de tempo de execução que essas estruturas agrupam automaticamente em sua compilação de produção de front-end. Para entender os efeitos do uso dessas variáveis de ambiente para armazenar valores, consulte a documentação da estrutura de front-end que você está usando.

Armazenar valores confidenciais, como chaves de API, dentro dessas variáveis de ambiente prefixadas da estrutura de front-end não é uma prática recomendada e é altamente desencorajado. Para obter um exemplo do uso das variáveis de ambiente de tempo de construção do Amplify para essa finalidade, consulteAcessar variáveis de ambiente.

Amplify variáveis de ambiente

Você pode usar as seguintes variáveis de ambiente que são acessíveis por padrão no console do Amplify.

Nome da variável	Descrição	Valor de exemplo
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 de recurso da Amazon (ARN) da versão atual do	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 reconstruções	abcd1234
AWS_JOB_ID	O ID de trabalho da compilação atual. Isso inclui um pouco de preenchimento de '0' para que sempre tenha o mesmo comprimento.	0000000001
_LIVE_UPDATES	A ferramenta será atualizada para a versão mais recente.	[{“name”:”Amplify CLI”,”pkg”:”@aws-amplify/cli”,”type”:”npm”,”version”:”latest”}]
AMPLIFY_FACEBOOK_CLIENT_ID	O do cliente do Facebook	123456
AMPLIFY_FACEBOOK_CLIENT_SECRET	O segredo do cliente do Facebook	example123456
AMPLIFY_GOOGLE_CLIENT_ID	O Google do cliente do	123456
AMPLIFY_GOOGLE_CLIENT_SECRET	O segredo do cliente do Google	example123456
AMPLIFY_AMAZON_CLIENT_ID	O Amazon do cliente da Amazon	123456
AMPLIFY_AMAZON_CLIENT_SECRET	O segredo do cliente da Amazon	example123456
AMPLIFY_DIFF_DEPLOY	Ative ou desative a implantação de front-end baseada em diff. Para obter mais informações, consulte Habilitar ou desabilitar a criação e implantação de front-end baseadas em diff.	true
AMPLIFY_DIFF_DEPLOY_ROOT	O caminho a ser usado para comparações de implantação de front-end baseadas em diff, em relação à raiz do seu repositório.	dist
AMPLIFY_DIFF_BACKEND	Ative ou desative compilações de back-end baseadas em diff. Para obter mais informações, consulte Habilitar ou desabilitar compilações de back-end baseadas em diff.	true
AMPLIFY_BACKEND_PULL_ONLY	O Amplify gerencia essa variável de ambiente. Para obter mais informações, consulte Edite um front-end existente para apontar para um back-end diferente.	true
AMPLIFY_BACKEND_APP_ID	O Amplify gerencia essa variável de ambiente. Para obter mais informações, consulte Edite um front-end existente para apontar para um back-end diferente.	abcd1234
AMPLIFY_SKIP_BACKEND_BUILD	Se você não tiver uma seção de back-end em sua especificação de compilação e quiser desabilitar as compilações de back-end, defina essa variável de ambiente comotrue.	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
_BUILD_TIMEOUT	A duração do tempo limite de construção em minutos	30
AMPLIFY_USERPOOL_ID	O ID do grupo de usuários do Amazon Cognito, importado para a autenticação do	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 grupo de identidades do Amazon Cognito	example-identitypool-id
AMPLIFY_PERMISSIONS_BOUNDARY_ARN	O ARN da política do IAM a ser usado como um limite de permissões que se aplica a todas as funções do IAM criadas pelo Amplify. Para obter mais informações, consulte Limite de permissões do IAM para funções geradas pelo Amplify.	arn:aws:iam::123456789012:policy/example-policy
AMPLIFY_DESTRUCTIVE_UPDATES	Defina essa variável de ambiente como true para permitir que uma API GraphQL seja atualizada com operações de esquema que podem causar perda de dados. Para obter mais informações, consulte Atualizar o esquema.	true

nota

As variáveis deAMPLIFY_AMAZON_CLIENT_SECRET ambienteAMPLIFY_AMAZON_CLIENT_ID e são tokens OAuth, não uma chave deAWS acesso e uma chave secreta.

Segredos de ambiente

Os segredos de ambiente são semelhantes às variáveis de ambiente, mas são pares de valores-chave do Parameter StoreAWS Systems Manager (SSM) que podem ser criptografados. Alguns valores devem ser criptografados, como a chave privada Sign in with Apple para Amplify.

Defina os segredos do ambiente

Use as instruções a seguir para definir um segredo de ambiente para um aplicativo Amplify usando oAWS Systems Manager console.

Para definir um segredo ambiental

1. Faça login no AWS Management Console e abra o AWS Systems Manager console.

2. No painel de navegação, escolha Applications (Parameter Store, depois depois depois depois escolha Parameter Store, depois escolha Parameter Store

3. Na página AWS Systems Manager Parameter Store, escolha Criar parâmetro.

4. Na página Criar parâmetro, na seção Detalhes do parâmetro, faça o seguinte:

   1. Em Nome, insira um parâmetro no formato/amplify/{your_app_id}/{your_backend_environment_name}/{your_parameter_name}.

   2. Em Type (Tipo), escolha SecureString.

   3. Em Fonte da chave KMS, escolha Minha conta atual para usar a chave padrão para sua conta.

   4. Em Valor, insira seu valor secreto para criptografar.

5. Escolha Criar parâmetro.

nota

O Amplify só tem acesso às chaves abaixo do/amplify/{your_app_id}/{your_backend_environment_name} para a construção do ambiente específico. Você deve especificar o padrãoAWS KMS key para permitir que o Amplify decodifique o valor.

Acessar os segredos do ambiente

Acessar um segredo de ambiente durante uma compilação é semelhante ao acesso a variáveis de ambiente, exceto que os segredos de ambiente são armazenadosprocess.env.secrets como uma string JSON.

Amplify os segredos do ambiente

Especifique um parâmetro do Systems Manager no formato/amplify/{your_app_id}/{your_backend_environment_name}/AMPLIFY_SIWA_CLIENT_ID.

Você pode usar os seguintes segredos de ambiente que podem ser acessados por padrão no console do Amplify.

Nome da variável	Descrição	Valor de exemplo
AMPLIFY_SIWA_CLIENT_ID	O Sign with Apple	com.yourapp.auth
AMPLIFY_SIWA_TEAM_ID	O Sign with Apple	ABCD123
AMPLIFY_SIWA_KEY_ID	O Sign with Apple	ABCD123
AMPLIFY_SIWA_PRIVATE_KEY	O Sign with Apple	-----INICIAR A CHAVE PRIVADA----- ****...... -----FIM DA CHAVE PRIVADA-----