Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Vous pouvez utiliser les variables d’étape API Gateway dans les cas suivants.
Expressions de mappage de paramètres
Une variable d’étape peut être utilisée dans une expression de mappage de paramètres pour un paramètre d’en-tête de demande ou de réponse d’une méthode d’API, sans aucune substitution partielle. Dans l’exemple suivant, la variable d’étape est référencée sans le caractère $ et sans être indiquée entre accolades {...}.
-
stageVariables.<variable_name>
Modèles de mappage
Une variable d’étape peut être utilisée n’importe où dans un modèle de mappage, comme illustré dans les exemples suivants.
-
{ "name" : "$stageVariables.<variable_name>"} -
{ "name" : "${stageVariables.<variable_name>}"}
Intégration HTTP URIs
Une variable d’étape peut être utilisée dans une URL d’intégration HTTP, comme illustré dans les exemples suivants :
-
URI complet sans protocole –
http://${stageVariables.<variable_name>} -
Domaine complet –
http://${stageVariables.<variable_name>}/resource/operation -
Sous-domaine –
http://${stageVariables.<variable_name>}.example.com/resource/operation -
Chemin –
http://example.com/${stageVariables.<variable_name>}/bar -
Chaîne de requête –
http://example.com/foo?q=${stageVariables.<variable_name>}
AWS intégration URIs
Une variable d'étape peut être utilisée dans le cadre d'une action d' AWS URI ou de composants de chemin, comme illustré dans l'exemple suivant.
-
arn:aws:apigateway:<region>:<service>:${stageVariables.<variable_name>}
AWS intégration URIs (fonctions Lambda)
Une variable d’étape peut être utilisée à la place d’un nom de fonction Lambda, ou de sa version/son alias, comme illustré dans les exemples suivants.
-
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
Note
Pour utiliser une variable d’étape pour une fonction Lambda, la fonction doit se trouver dans le même compte que l’API. Les variables d’étape ne prennent pas en charge les fonctions Lambda inter-comptes.
Groupe d’utilisateurs Amazon Cognito
Une variable d’étape peut être utilisée à la place d’un groupe d’utilisateurs Amazon Cognito pour un mécanisme d’autorisation COGNITO_USER_POOLS.
-
arn:aws:cognito-idp:<region>:<account_id>:userpool/${stageVariables.<variable_name>}
AWS informations d'identification d'intégration
Une variable d'étape peut être utilisée dans le cadre de l'ARN des informations d'identification AWS utilisateur/rôle, comme indiqué dans l'exemple suivant.
-
arn:aws:iam::<account_id>:${stageVariables.<variable_name>}
