Referencia de variables de etapa de Amazon API Gateway

Puede utilizar variables de etapa de API Gateway en los siguientes casos.

Expresiones de mapeo de parámetros

Una variable de etapa se puede usar en una expresión de asignación de parámetros para un parámetro de encabezado de solicitud o respuesta de un método de la API sin ninguna sustitución parcial. En el siguiente ejemplo, se hace referencia a la variable de etapa sin $ y sin utilizar {...}.

• stageVariables.<variable_name>

Plantillas de mapeo

Una variable de etapa se puede utilizar en cualquier lugar de una plantilla de asignación, tal y como se muestra en los siguientes ejemplos.

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

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

URI de integración HTTP

Una variable de etapa se puede utilizar como parte de una URL de integración HTTP, tal y como se muestra en los siguientes ejemplos:

• Una URI completa sin protocol – http://${stageVariables.<variable_name>}

• Un dominio complet – http://${stageVariables.<variable_name>}/resource/operation

• Un subdomini – http://${stageVariables.<variable_name>}.example.com/resource/operation

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

• Una cadena de consult – http://example.com/foo?q=${stageVariables.<variable_name>}

AWSURI de integración de

Una variable de etapa se puede utilizar como parte de los componentes de acción o ruta de un URI de AWS, tal y como se muestra en el siguiente ejemplo.

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

AWSURI de integración con (funciones de Lambda)

Las variables de etapa pueden utilizarse en lugar de un nombre de función de Lambda o versión/alias, tal y como se muestra en los siguientes ejemplos.

• 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

nota

Para utilizar una variable de etapa para una función de Lambda, la función debe estar en la misma cuenta que la API. Las variables de etapa no admiten funciones de Lambda entre cuentas.

Grupo de usuarios de Amazon Cognito

Se puede usar una variable de etapa en lugar de un grupo de usuarios de Amazon Cognito como autorizador de COGNITO_USER_POOLS.

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

AWSCredenciales de integración de

Una variable de etapa se puede utilizar como parte del ARN de credenciales de roles/usuarios de AWS, tal y como se muestra en el siguiente ejemplo.

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