Connecting Amazon API Gateway
Connect Amazon API gateway with federated API management.
Amazon API gateway can establish connection with federated API management using an agent SDK, which is available for download from the Download resources page in federated API management UI.
It leverages the following Amazon services:
- AWS SDK – for connection management and authentication
- Amazon CloudWatch – for retrieving API metrics
- Amazon CloudTrail – for retrieving API activity
Note: This agent implementation is compatible with
federated API management
version 11.1.7 and currently supports only the REST APIs of Amazon API Gateway.
AWS agent can be deployment using one of the following ways:
- Docker
- AWS Lambda
The following table lists the differences between the Docker and functions (AWS lambda) flavor:
| Key Points | Docker | Functions (AWS Lambda) |
|---|---|---|
| Deployment | Deployed like a regular server. | Deployed as Function as a Service (FaaS) on AWS Lambda |
| Maintenance and Availability | High maintenance. User must manage deployment for full availability. | Low maintenance for FaaS flavors, cloud hosting service providers such as AWS handles availability once deployed. |
| Resource Consumption and Cost | Server runs 24x7, even with sparse utilization. | AWS provider manages and runs the code only when invoked. Charges are incurred only based on number of invocations and runtime. More cost effective compared to regular hosted solutions. |
| Implementation | A single implementation of spring boot application handles all three use cases of an agent: assets synchronization, heartbeats synchronization, and metrics synchronization. | Each Lambda function handles one use case of an agent. To achieve assets synchronization, heartbeats synchronization, and metrics synchronization, deploy three separate Lambda functions. |
| Schedule | The frequency of the synchronization of heartbeats, assets, and metrics from the runtime to API Control Plane is maintained by the agent application code. Each activity gets triggered based on the configured synchronization intervals. | The schedule of the Lambda function is maintained in AWS component, Amazon EventBridge. The Lambda function gets triggered based on the intervals configured in EventBridge. The schedule configured in EventBridge should match with with the synchronization intervals configured in the Lambda environment properties for smooth functioning. |
| Suitability | Ideal for on-prem deployment flavor. | Suitable for hosted solutions. Best in terms of maintenance and cost compared to other hosted flavors. |
To learn more about how the Amazon API Gateway agent is implemented, see AWS agents core implementation logic.