interface BaseScreenshotProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Synthetics.CfnCanary.BaseScreenshotProperty |
 Java | software.amazon.awscdk.services.synthetics.CfnCanary.BaseScreenshotProperty |
 Python | aws_cdk.aws_synthetics.CfnCanary.BaseScreenshotProperty |
 TypeScript | @aws-cdk/aws-synthetics » CfnCanary » BaseScreenshotProperty |
A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as synthetics from '@aws-cdk/aws-synthetics';
const baseScreenshotProperty: synthetics.CfnCanary.BaseScreenshotProperty = {
screenshotName: 'screenshotName',
// the properties below are optional
ignoreCoordinates: ['ignoreCoordinates'],
};
Properties
| Name | Type | Description |
|---|---|---|
| screenshot | string | The name of the screenshot. |
| ignore | string[] | Coordinates that define the part of a screen to ignore during screenshot comparisons. |
screenshotName
Type:
string
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.
ignoreCoordinates?
Type:
string[]
(optional)
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 .