Amazon CloudWatch Synthetics

aws Monitoringaws-cloudwatch-synthetics

Scheduled canary scripts that probe endpoints and APIs from outside the application.

Provider: aws
Kind: Monitoring
Category: Operations
Official docs: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html

Properties · 5 set by this component

property	type	values	required	kind default	this component
activeTracing · component property	boolean	—	no	false	inherited
alertGrouping	boolean	—	no	false	inherited
browser · component property	enum	chrome \| firefox	no	chrome	inherited
collectorMode	enum	pull \| push	no	pull	▸ pull
independentOfMonitored	boolean	—	no	false	▸ true
managed	boolean	—	no	false	▸ true
provisionedResourceCleanup · component property	enum	automatic \| off	no	automatic	inherited
retentionDays	integer	—	no	—	▸ 31
signal	enum	metrics \| logs \| traces \| alerts \| all	no	metrics	▸ metrics

Rules that apply · 0

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

No rule reads this kind yet. That is a gap, not a guarantee.

Use it in a design

nodes:
  - { id: "cloudwatch-synthetics", component: "aws-cloudwatch-synthetics" }

Other Monitoring products · 174

and 134 more → Monitoring page

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# CloudWatch Synthetics canary: a scheduled script that probes an endpoint from outside the application.
3# "Synthetic monitoring (canaries)" and the CreateCanary API reference: run data is retained 31 days for both
4# successful and failed runs, browserConfigs defaults to Chrome, artifacts go to S3, cleanup defaults to AUTOMATIC.
5schemaVersion: "1"
6type: "component"
7id: "aws-cloudwatch-synthetics"
8kind: "monitoring"
9provider: "aws"
10docs: "https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html"
11defaults:
12  signal: "metrics"
13  collectorMode: "pull"
14  independentOfMonitored: true
15  retentionDays: 31
16  managed: true
17properties:
18  browser:
19    type: "enum"
20    values: ["chrome", "firefox"]
21    default: "chrome"
22  activeTracing:
23    type: "boolean"
24    default: false
25  provisionedResourceCleanup:
26    type: "enum"
27    values: ["automatic", "off"]
28    default: "automatic"

The same page as markdown, for an agent: /catalogue/components/aws-cloudwatch-synthetics.md