Referência de variáveis de estágio do API Gateway para APIs REST no API Gateway
Você pode usar variáveis de estágio do API Gateway nos seguintes casos.
Expressões de mapeamento de parâmetros
Uma variável de estágio pode ser usada em uma expressão de mapeamento de parâmetros para o parâmetro de cabeçalho de solicitação ou resposta de um método de API, sem substituição parcial. No exemplo a seguir, a variável de estágio é referenciada sem o $ e o delimitador {...}.
-
stageVariables.<variable_name>
Modelos de mapeamento
Uma variável de estágio pode ser usada em qualquer lugar de um modelo de mapeamento, conforme mostrado nos exemplos a seguir.
-
{ "name" : "$stageVariables.<variable_name>"} -
{ "name" : "${stageVariables.<variable_name>}"}
URIs de integração HTTP
Uma variável de estágio pode ser usada como parte de um URL de integração HTTP, como mostram os exemplos a seguir:
-
Um URI completo sem protocol –
http://${stageVariables.<variable_name>} -
Um domínio complet –
http://${stageVariables.<variable_name>}/resource/operation -
Um subdomíni –
http://${stageVariables.<variable_name>}.example.com/resource/operation -
Um caminh –
http://example.com/${stageVariables.<variable_name>}/bar -
Uma string de consult –
http://example.com/foo?q=${stageVariables.<variable_name>}
AWSURIs de integração da
Uma variável de estágio pode ser usada como parte de componentes de caminho ou ação de URI da AWS, como mostra o exemplo a seguir.
-
arn:aws:apigateway:<region>:<service>:${stageVariables.<variable_name>}
AWSURIs de integração da (funções do Lambda)
Uma variável de estágio pode ser usada no lugar de um nome de função do Lambda, ou de uma versão/alias, como mostram os exemplos a seguir.
-
arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/arn:aws:lambda:<region>:<account_id>:function:${stageVariables.<function_variable_name>}/invocations -
arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/arn:aws:lambda:<region>:<account_id>:function:<function_name>:${stageVariables.<version_variable_name>}/invocations
nota
Para usar uma variável de estágio para uma função do Lambda, a função deve estar na mesma conta que a API. As variáveis de estágio não suportam funções do Lambda entre contas.
Grupo de usuários do Amazon Cognito
Uma variável de estágio pode ser usada no lugar de um grupo de usuários do Amazon Cognito para um autorizador COGNITO_USER_POOLS.
-
arn:aws:cognito-idp:<region>:<account_id>:userpool/${stageVariables.<variable_name>}
AWSCredenciais de integração da
Uma variável de estágio pode ser usada como parte do ARN de credencial de usuário/função da AWS, como mostra o exemplo a seguir.
-
arn:aws:iam::<account_id>:${stageVariables.<variable_name>}
