CloudWatch Synthetics Canary

Docs > DDSQL Reference > Data Directory > CloudWatch Synthetics Canary

CloudWatch Synthetics Canary is an AWS resource that lets you create configurable scripts, called canaries, to monitor your endpoints and APIs. These canaries run on a schedule to simulate user behavior, check availability, measure performance, and detect issues before customers are impacted. They provide detailed logs, screenshots, and metrics that integrate with CloudWatch for alerting and analysis.

aws.synthetics_canary

Fields

ID	Type	Data Type	Description
_key	core	string
account_id	core	string
artifact_config	core	json	A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
artifact_s3_location	core	string	The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
code	core	json	This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.
engine_arn	core	string	The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.
execution_role_arn	core	string	The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.
failure_retention_period_in_days	core	int64	The number of days to retain data about failed runs of this canary. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
id	core	string	The unique ID of this canary.
name	core	string	The name of the canary.
provisioned_resource_cleanup	core	string	Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
run_config	core	json	A structure that contains information about a canary run.
runtime_version	core	string	Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
schedule	core	json	A structure that contains information about how often the canary is to run, and when these runs are to stop.
status	core	json	A structure that contains information about the canary's status.
success_retention_period_in_days	core	int64	The number of days to retain data about successful runs of this canary. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
tags	core	hstore
timeline	core	json	A structure that contains information about when the canary was created, modified, and most recently run.
visual_reference	core	json	If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
vpc_config	core	json	If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.