Interface CfnCanary.VisualReferenceProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnCanary.VisualReferenceProperty.Jsii$Proxy
Enclosing class:
CfnCanary

@Stability(Stable) public static interface CfnCanary.VisualReferenceProperty extends software.amazon.jsii.JsiiSerializable
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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.synthetics.*;
 VisualReferenceProperty visualReferenceProperty = VisualReferenceProperty.builder()
         .baseCanaryRunId("baseCanaryRunId")
         // the properties below are optional
         .baseScreenshots(List.of(BaseScreenshotProperty.builder()
                 .screenshotName("screenshotName")
                 // the properties below are optional
                 .ignoreCoordinates(List.of("ignoreCoordinates"))
                 .build()))
         .build();
 

See Also: