Versions Compared

Key

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

...

Excerpt
nameCreate a new Environment

Create a new Environment

To get started, simply open your API Control Plane instance and follow the instructions below.

Add an Environment

  • Navigate to “Environments” in the menu on the left side

  • Click on the “Create New Environment” button in the top right corner

  • Choose your provider by clicking on it

  • Confirm by clicking on the "Next" button

Image RemovedImage Added

Add Environment Information

  • Fill in the form (as exemplarily shown below)

  • Confirm by clicking on the "Register Environment" button

  • Click Next here to start the Connection Wizard.

(tick) You’ve completed the first step!

...

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

Gateway Configuration

You have two options to grant your agent access to your AWS API Gateway, depending on wheter you plan to host the agent inside AWS itself or elsewhere.

Agents running outside AWS

This is the default, where you run the agent container outside of AWS, e.g. inside your local network or within another cloud provider. For the agent to be able to access the AWS API Gateway, you must provide credentials in form of Access Key and Secret Access Key.

...

Agents running inside AWS

For agents running within one of the AWS container services (e.g. ECS or EKS) you can choose to
'Use AWS Internal

...

Acess' instead of providing explicit credentials. In this case you must configure a task execution role for your container in AWS that has the necessary permissions to access the API Gateway.

...

  • Use AWS Internal Access: Enable this if you intend to run your agent container inside AWS and want to use a task execution role instead of providing accessKey and secretAccessKey.

  • 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

...