Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
APIReferenz für REST APIs Gateway-Stufenvariablen in Gateway API
In den folgenden Fällen können Sie API Gateway-Stufenvariablen verwenden.
Parameter-Mapping-Ausdrücke
Eine Stufenvariable kann in einem Parameterzuordnungsausdruck für den Anforderungs- oder Antwortheaderparameter einer API Methode verwendet werden, ohne dass eine teilweise Ersetzung erforderlich ist. Im folgenden Beispiel wird die Stufenvariable ohne $
und umschließende {...}
referenziert.
-
stageVariables.<variable_name>
Mapping-Vorlagen
Eine Stufenvariable kann überall in einer Mapping-Vorlage verwendet werden, wie in den folgenden Beispielen dargestellt.
-
{ "name" : "$stageVariables.<variable_name>"}
-
{ "name" : "${stageVariables.<variable_name>}"}
HTTPIntegration URIs
Eine Stufenvariable kann als Teil einer HTTP Integration verwendet werdenURL, wie in den folgenden Beispielen gezeigt:
-
Eine vollständige Version URI ohne Protokoll —
http://${stageVariables.<variable_name>}
-
Eine vollständige Domäne –
http://${stageVariables.<variable_name>}/resource/operation
-
Eine Unterdomäne –
http://${stageVariables.<variable_name>}.example.com/resource/operation
-
Ein Pfad –
http://example.com/${stageVariables.<variable_name>}/bar
-
Eine Abfragezeichenfolge –
http://example.com/foo?q=${stageVariables.<variable_name>}
AWS Integration URIs
Eine Stufenvariable kann als Teil von AWS URI Aktions- oder Pfadkomponenten verwendet werden, wie im folgenden Beispiel gezeigt.
-
arn:aws:apigateway:<region>:<service>:${stageVariables.<variable_name>}
AWS Integration URIs (Lambda-Funktionen)
Eine Stufenvariable kann anstelle des Lambda-Funktionsnamens (oder Version/Alias) verwendet werden, wie in den folgenden Beispielen dargestellt.
-
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
Anmerkung
Um eine Stufenvariable für eine Lambda-Funktion zu verwenden, muss sich die Funktion im selben Konto befinden wie dieAPI. Stufenvariablen unterstützen keine kontoübergreifenden Lambda-Funktionen.
Amazon-Cognito-Benutzerpool
Eine Stufenvariable kann anstelle eines Amazon Cognito Cognito-Benutzerpools für einen COGNITO_USER_POOLS
Autorisierer verwendet werden.
-
arn:aws:cognito-idp:<region>:<account_id>:userpool/${stageVariables.<variable_name>}
AWS Anmeldeinformationen für die Integration
Eine Stufenvariable kann als Teil der AWS Benutzer-/Rollenanmeldedaten verwendet werdenARN, wie im folgenden Beispiel gezeigt.
-
arn:aws:iam::<account_id>:${stageVariables.<variable_name>}