Versions Compared

Version Old Version 9 New Version 10
Changes made by

Mirco Hoffmann (Unlicensed)

Mirco Hoffmann (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this page you will learn how to connect your AWS API Gateway to APIIDA´s API Control Plane step-by-step.

Prerequisites

The following is required to proceed:

Include Page
Create Environemnt
Create Environemnt

Provide the Gateway Information

The following describes how to create the gateway configuration for an AWS API Gateway Agent.

Gateway Configuration

  • accessKey/secretAccessKey: Insert your AWS access keys

  • region: Insert the region that is assigned to your APIs in AWS

  • stage: Insert the stage where you deployed the APIs in AWS

Info

See our Q&A below if you want to learn more about how to get these values.

Note

Currently, each AWS agent is specific to one region and one stage.
If you want to manage multiple stages or regions, you will require an agent instance for each combination.

  • Click on “Download” to download your configuration file

  • Confirm by clicking on the "Next" button

(tick) You’ve completed the second step!

Include Page
Create Agent
Create Agent

Check the Agent's Status

  • Head over to your API Control Plane instance

  • Select “Environments” in the menu on the left side

    • Your AWS Agent should now be connected to API Control Plane

  • Click on the tile or the entry in the table to get more detailed information about the status of the connection. This can be very useful in case of an error.

(tick) You’ve completed the last step!

You can now interact with your AWS Gateway through APIIDA´s API Control Plane.

Try it right now and discover your APIs!

💡 Tip: It is easy to add more agents!

Repeat this guide or that of another gateway and simply add the agents to the existing Docker compose file.

Q&A

Expand
titleHow do I get my accessKey and secretAccessKey?
Expand
titleWhere can I find the region assigned to my API in AWS?

  • Go to the API Overview in the AWS API Gateway Service

    • The region identifier of your API can be found in the region tab (see screenshot)

    • The region identifier is also part of your overview URL
      https://{region-identifier}.console.aws...

Expand
titleWhere can I find the stage(s) in which my API is deployed?

  • Go to the API Overview and choose Stages (from the left menu page)

    • The stages in which your API is deployed will be displayed in the second column