Referensi variabel tahap API Gateway

Anda dapat menggunakan variabel tahap API Gateway dalam kasus berikut.

Ekspresi pemetaan parameter

Variabel tahap dapat digunakan dalam ekspresi pemetaan parameter untuk permintaan metode API atau parameter header respon, tanpa substitusi sebagian. Dalam contoh berikut, variabel tahap direferensikan tanpa $ dan {...} melampirkan.

• stageVariables.<variable_name>

Templat pemetaan

Variabel tahap dapat digunakan di mana saja dalam template pemetaan, seperti yang ditunjukkan pada contoh berikut.

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

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

URI integrasi HTTP

Variabel tahap dapat digunakan sebagai bagian dari URL integrasi HTTP, seperti yang ditunjukkan pada contoh berikut:

• URI lengkap tanpa protokol — http://${stageVariables.<variable_name>}

• Domain lengkap — http://${stageVariables.<variable_name>}/resource/operation

• Sebuah subdomain — http://${stageVariables.<variable_name>}.example.com/resource/operation

• Sebuah jalan — http://example.com/${stageVariables.<variable_name>}/bar

• Sebuah string kueri - http://example.com/foo?q=${stageVariables.<variable_name>}

AWS URI integrasi

Variabel tahap dapat digunakan sebagai bagian dari tindakan AWS URI atau komponen jalur, seperti yang ditunjukkan pada contoh berikut.

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

AWS URI integrasi (fungsi Lambda)

Variabel tahap dapat digunakan sebagai pengganti nama fungsi Lambda, atau versi/alias, seperti yang ditunjukkan pada contoh berikut.

• 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

catatan

Untuk menggunakan variabel stage untuk fungsi Lambda, fungsi harus berada di akun yang sama dengan API. Variabel tahap tidak mendukung fungsi Lambda lintas akun.

Kolam pengguna Amazon Cognito

Variabel tahap dapat digunakan sebagai pengganti kumpulan pengguna Amazon Cognito untuk otorisasi. COGNITO_USER_POOLS

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

AWS kredensi integrasi

Variabel tahap dapat digunakan sebagai bagian dari ARN kredensi AWS pengguna/peran, seperti yang ditunjukkan pada contoh berikut.

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