Canary
This structure contains all information about one canary in your account.
Types
Properties
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.
Returns the dry run configurations for a canary.
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.
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.
The number of days to retain data about failed runs of this canary.
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.
A structure that contains information about a canary run.
Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
A structure that contains information about how often the canary is to run, and when these runs are to stop.
A structure that contains information about the canary's status.
The number of days to retain data about successful runs of this canary.
A structure that contains information about when the canary was created, modified, and most recently run.
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.
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.