API閘道RESTAPIs中API的閘道階段變數參考 - Amazon API Gateway
參數對應表達式對應範本HTTP整合 URIsAWS 整合 URIsAWS 整合 URIs (Lambda 函數)Amazon Cognito 使用者集區AWS 整合認證

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

API閘道RESTAPIs中API的閘道階段變數參考

在下列情況下，您可以使用API閘道階段變數。

參數對應表達式

階段變數可用於API方法要求或回應標頭參數的參數對應運算式中，而不需要任何部分取代。在下列範例中，階段變數參考不使用 $ 與包圍的 {...}。

  • stageVariables.<variable_name>

對應範本

階段變數可以用在對應範本的任何位置，如下例所示。

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

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

HTTP整合 URIs

階段變數可作為HTTP整合的一部分使用URL，如下列範例所示：

  • 一個完整的URI沒有協議 — http://${stageVariables.<variable_name>}

  • 完整的網域 – http://${stageVariables.<variable_name>}/resource/operation

  • 子網域 – http://${stageVariables.<variable_name>}.example.com/resource/operation

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

  • 查詢字串 – http://example.com/foo?q=${stageVariables.<variable_name>}

AWS 整合 URIs

階段變數可以用來做為 AWS URI動作或路徑組件的一部分，如下列範例所示。

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

AWS 整合 URIs (Lambda 函數)

階段變數可用來取代 Lambda 函數名稱或版本/別名，如下例所示。

  • 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

注意

若要針對 Lambda 函數使用階段變數，該函數必須與API. 階段變數不支援跨帳戶 Lambda 函數。

Amazon Cognito 使用者集區

階段變數可用來取代COGNITO_USER_POOLS授權者的 Amazon Cognito 使用者集區。

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

AWS 整合認證

階段變數可用作使用 AWS 者/角色認證的一部分ARN，如下列範例所示。

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