AWS::Synthetics::Canary BaseScreenshot - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Synthetics::Canary BaseScreenshot

A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.

Syntax

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

JSON

{
  "IgnoreCoordinates" : [ String, ... ],
  "ScreenshotName" : String
}

YAML

  IgnoreCoordinates: 
    - String
  ScreenshotName: String

Properties

IgnoreCoordinates

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Edit or delete a canary.

Required: No

Type: Array of String

Update requires: No interruption

ScreenshotName

The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

Required: Yes

Type: String

Update requires: No interruption