Class CfnCanary.VisualReferenceProperty
Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Synthetics
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class VisualReferenceProperty : Object, CfnCanary.IVisualReferenceProperty
Syntax (vb)
Public Class VisualReferenceProperty
Inherits Object
Implements CfnCanary.IVisualReferenceProperty
Remarks
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
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Synthetics;
var visualReferenceProperty = new VisualReferenceProperty {
BaseCanaryRunId = "baseCanaryRunId",
// the properties below are optional
BaseScreenshots = new [] { new BaseScreenshotProperty {
ScreenshotName = "screenshotName",
// the properties below are optional
IgnoreCoordinates = new [] { "ignoreCoordinates" }
} }
};
Synopsis
Constructors
VisualReferenceProperty() |
Properties
BaseCanaryRunId | Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. |
BaseScreenshots | An array of screenshots that are used as the baseline for comparisons during visual monitoring. |
Constructors
VisualReferenceProperty()
public VisualReferenceProperty()
Properties
BaseCanaryRunId
Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary.
public string BaseCanaryRunId { get; set; }
Property Value
System.String
Remarks
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.
BaseScreenshots
An array of screenshots that are used as the baseline for comparisons during visual monitoring.
public object BaseScreenshots { get; set; }
Property Value
System.Object