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.

Utiliser des variables d'étape pour HTTP APIs dans API Gateway

Les variables d'étape sont des paires clé-valeur que vous pouvez définir pour une étape d'un. HTTP API Ils agissent comme des variables d'environnement et peuvent être utilisés dans votre API configuration.

Les variables d'étape ne sont pas destinées à être utilisées pour des données sensibles, telles que les informations d'identification. Pour transmettre des données sensibles aux intégrations, utilisez un AWS Lambda autorisateur. Vous pouvez transmettre des données sensibles aux intégrations dans la sortie du mécanisme d'autorisation Lambda. Pour en savoir plus, consultez la section Format de réponse du mécanisme d'autorisation Lambda.

Exemple — Utiliser une variable d'étape pour personnaliser le point de terminaison HTTP d'intégration

Par exemple, vous pouvez définir une variable d'étape, puis définir sa valeur comme point de HTTP terminaison pour une intégration HTTP par proxy. Par la suite, vous pouvez référencer le point de terminaison à l'aide du nom de la variable d'étape associée. Ce faisant, vous pouvez utiliser la même API configuration avec un point de terminaison différent à chaque étape. De même, vous pouvez utiliser des variables d'étape pour spécifier une intégration de AWS Lambda fonction différente pour chaque étape de votreAPI.

Pour utiliser une variable d'étape afin de personnaliser le point de terminaison d'HTTPintégration, vous devez d'abord définir le nom et la valeur de la variable d'étape (par exemple,url) avec la valeur deexample.com. Configurez ensuite une intégration de HTTP proxy. Au lieu de saisir le point de terminaisonURL, vous pouvez demander à API Gateway d'utiliser la valeur de la variable d'étape,http://${stageVariables.url}. Cette valeur indique à API Gateway de remplacer votre variable d'étape ${} lors de l'exécution, en fonction de l'étape de votreAPI.

Vous pouvez référencer les variables d'étape de la même manière pour spécifier un nom de fonction Lambda ou un AWS rôle. ARN

Lorsque vous spécifiez un nom de fonction Lambda en tant que valeur de variable d'étape, vous devez configurer les autorisations sur cette fonction Lambda manuellement. Pour ce faire, vous pouvez utiliser la AWS CLI commande suivante.

aws lambda add-permission --function-name arn:aws:lambda:XXXXXX:your-lambda-function-name --source-arn arn:aws:execute-api:us-east-1:YOUR_ACCOUNT_ID:api_id/*/HTTP_METHOD/resource --principal apigateway.amazonaws.com --statement-id apigateway-access --action lambda:InvokeFunction