API Gateway의 REST API용 API Gateway의 스테이지 변수 참조 - Amazon API Gateway
파라미터 매핑 표현식매핑 템플릿HTTP 통합 URIAWS 통합 URIAWS 통합 URI(Lambda 함수)Amazon Cognito 사용자 풀AWS 통합 자격 증명

API Gateway의 REST API용 API Gateway의 스테이지 변수 참조

다음과 같은 경우에 API Gateway 단계 변수를 사용할 수 있습니다.

파라미터 매핑 표현식

API 메서드의 요청 또는 응답 헤더 파라미터를 부분적으로 바꾸지 않고도 파라미터 매핑 표현식에 단계 변수를 사용할 수 있습니다. 다음 예에서는 $ 및 {...}로 묶지 않고 단계 변수를 참조합니다.

  • stageVariables.<variable_name>

매핑 템플릿

다음 예에서 보듯 단계 변수는 매핑 템플릿 어디에서나 사용할 수 있습니다.

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

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

HTTP 통합 URI

다음 예제에서 보듯 스테이지 변수를 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 통합 URI

다음 예에서 보듯 단계 변수를 경로 구성 요소 또는 AWS URI의 일부로 사용할 수 있습니다.

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

AWS 통합 URI(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>}