Posted On: Feb 2, 2021

Amazon CloudWatch Synthetics adds support to create canaries for your Amazon API Gateway APIs using the API blueprint. This simplifies your canary setup time and makes it easy to monitor your API Gateway APIs.

Canaries are modular, lightweight scripts that you can configure to run on a schedule in order to monitor your endpoints and APIs from the outside-in. CloudWatch Synthetics provides blueprints to easily create canaries without writing code. The API blueprint allows you to monitor multiple HTTP requests for REST APIs. With the new integration of Amazon API Gateway in the API blueprint, you can select an API Gateway API and stage from the same AWS account and Region as the canary, or you can upload a Swagger template from API Gateway for cross-account and cross-Region API monitoring. Using the Synthetics console, you can configure the details of your API Gateway canary such as resource path, input query parameters, and headers without writing a script from scratch.

This feature is available in the following Regions: US East (N. Virginia), US East (Ohio), US West (N. California), US West (Oregon), Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Mumbai), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Milan), Europe (Paris), Europe (Stockholm), Middle East (Bahrain), South America (São Paulo), AWS GovCloud (US-East), and AWS GovCloud (US-West).

To learn more about this feature, see the CloudWatch Synthetics documentation. For pricing, refer to Amazon CloudWatch pricing. For more information about API Gateway, see What is Amazon API Gateway?