APIRiferimento alle variabili di fase Gateway per REST APIs in Gateway API - Amazon API Gateway

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

APIRiferimento alle variabili di fase Gateway per REST APIs in Gateway API

È possibile utilizzare le variabili di fase API Gateway nei seguenti casi.

Espressioni di mappatura dei parametri

Una variabile di fase può essere utilizzata in un'espressione di mappatura dei parametri per il parametro di intestazione della richiesta o della risposta di un API metodo, senza alcuna sostituzione parziale. Nell'esempio che segue si fa riferimento alla variabile di fase senza il simbolo $ e il simbolo {...} di chiusura.

  • stageVariables.<variable_name>

Modelli di mappatura

Una variabile di fase può essere utilizzata ovunque in un modello di mappatura, come mostrato negli esempi seguenti.

  • { "name" : "$stageVariables.<variable_name>"}

  • { "name" : "${stageVariables.<variable_name>}"}

HTTPintegrazione URIs

Una variabile di fase può essere utilizzata come parte di un'HTTPintegrazioneURL, come illustrato negli esempi seguenti:

  • Un completo URI senza protocollo — http://${stageVariables.<variable_name>}

  • Un dominio completo – http://${stageVariables.<variable_name>}/resource/operation

  • Un sottodominio – http://${stageVariables.<variable_name>}.example.com/resource/operation

  • Un percorso – http://example.com/${stageVariables.<variable_name>}/bar

  • Una stringa di query – http://example.com/foo?q=${stageVariables.<variable_name>}

AWS integrazione URIs

Una variabile di fase può essere utilizzata come parte dei componenti dell' AWS URIazione o del percorso, come illustrato nell'esempio seguente.

  • arn:aws:apigateway:<region>:<service>:${stageVariables.<variable_name>}

AWS integrazione URIs (funzioni Lambda)

Una variabile di fase può essere utilizzata al posto del nome o della versione/dell'alias di una funzione Lambda, come mostrato negli esempi seguenti.

  • 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

Per utilizzare una variabile stage per una funzione Lambda, la funzione deve trovarsi nello stesso account di. API Le variabili di fase non supportano le funzioni Lambda tra più account.

Bacino d'utenza di Amazon Cognito

Una variabile stage può essere utilizzata al posto di un pool di utenti Amazon Cognito per un COGNITO_USER_POOLS autorizzatore.

  • arn:aws:cognito-idp:<region>:<account_id>:userpool/${stageVariables.<variable_name>}

AWS credenziali di integrazione

Una variabile di fase può essere utilizzata come parte della credenziale AWS utente/ruoloARN, come illustrato nell'esempio seguente.

  • arn:aws:iam::<account_id>:${stageVariables.<variable_name>}