Package software.amazon.awscdk.services.synthetics

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCanary.VisualReferenceProperty.Builder	A builder for CfnCanary.VisualReferenceProperty
static final class	CfnCanary.VisualReferenceProperty.Jsii$Proxy	An implementation for CfnCanary.VisualReferenceProperty

Method Summary

Modifier and Type	Method	Description
static CfnCanary.VisualReferenceProperty.Builder	builder()
String	getBaseCanaryRunId()	Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary.
default Object	getBaseScreenshots()	An array of screenshots that are used as the baseline for comparisons during visual monitoring.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBaseCanaryRunId

@Stability(Stable)
@NotNull
String getBaseCanaryRunId()

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.

getBaseScreenshots

@Stability(Stable)
@Nullable
default Object getBaseScreenshots()

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

builder

@Stability(Stable)
static CfnCanary.VisualReferenceProperty.Builder builder()

Returns:

a CfnCanary.VisualReferenceProperty.Builder of CfnCanary.VisualReferenceProperty