AWS::Synthetics::Canary VisualReference - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Synthetics::Canary VisualReference

Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BaseCanaryRunId" : String,
  "BaseScreenshots" : [ BaseScreenshot, ... ],
  "BrowserType" : String
}

Properties

BaseCanaryRunId

Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run before this update was made, or the value of Id in the CanaryRun from any past run of this canary.

Required: Yes

Type: String

Update requires: No interruption

BaseScreenshots

An array of screenshots that are used as the baseline for comparisons during visual monitoring.

Required: No

Type: Array of BaseScreenshot

Update requires: No interruption

BrowserType

The browser type associated with this visual reference configuration. Valid values are CHROME and FIREFOX.

Required: No

Type: String

Allowed values: CHROME | FIREFOX

Update requires: No interruption