API-Gateway-Stufenvariablenreferenz für REST-APIs in API Gateway

Sie können die API Gateway-Stufenvariablen in folgenden Fällen verwenden.

Parameter-Mapping-Ausdrücke

Eine Stufenvariable kann in einem Parameter-Mapping-Ausdruck für den Header-Parameter einer API-Methodenanforderung oder -antwort genutzt werden, und zwar ohne Teilsubstitution. 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>}"}

HTTP-Integrations-URIs

Eine Stufenvariable kann als Teil einer HTTP-Integrations-URL verwendet werden, wie in den folgenden Beispielen dargestellt:

• Eine vollständige 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-Integrations-URIs

Eine Stufenvariable kann als Teil einer AWS-URI-Aktion oder von Pfadkomponenten verwendet werden, wie im folgenden Beispiel dargestellt.

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

AWS-Integrations-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 wie die API befinden. Stufenvariablen unterstützen keine kontoübergreifenden Lambda-Funktionen.

Amazon-Cognito-Benutzerpool

Eine Stufenvariable kann anstelle eines Amazon-Cognito-Benutzerpools für einen COGNITO_USER_POOLS-Genehmiger verwendet werden.

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

AWS-Integrationsanmeldeinformationen

Eine Stufenvariable kann als Teil des ARN der AWS-Benutzer/Rollenanmeldeinformationen verwendet werden, wie im folgenden Beispiel dargestellt.

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