Defining a security scheme compatible with AWS API Gateway - Cloud

Talend Cloud API Designer User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs

When exporting a definition from Talend Cloud API Designer and importing it into AWS API Gateway, your security can be propagated if it is defined properly.

Procedure

  1. Open your API and go to the general information page.
  2. Go to the SECURITY SCHEMES section and click Add.
  3. In the Type drop-down list, select Custom / API key.
  4. Enter a name.
  5. Click Add to the right of HEADERS to create a new header.
  6. In the Name field, enter x-api-key.
  7. Click Save.

Results

You have defined a security scheme which is compatible with AWS API Gateway. You can use it globally or on the resource or operation level.