Interface CfnCanary.VisualReferenceProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

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


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 VisualReferenceProperty visualReferenceProperty = VisualReferenceProperty.builder()
         // the properties below are optional
                 // the properties below are optional
  • 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()
      a CfnCanary.VisualReferenceProperty.Builder of CfnCanary.VisualReferenceProperty