Package software.amazon.awscdk.services.synthetics

Interface CfnCanary.BaseScreenshotProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCanary.BaseScreenshotProperty.Jsii$Proxy

Enclosing class:

CfnCanary

@Stability(Stable)
public static interface CfnCanary.BaseScreenshotProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.synthetics.*;
 BaseScreenshotProperty baseScreenshotProperty = BaseScreenshotProperty.builder()
         .screenshotName("screenshotName")
         // the properties below are optional
         .ignoreCoordinates(List.of("ignoreCoordinates"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCanary.BaseScreenshotProperty.Builder	builder()
default List<String>	getIgnoreCoordinates()	Coordinates that define the part of a screen to ignore during screenshot comparisons.
String	getScreenshotName()	The name of the screenshot.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScreenshotName

@Stability(Stable)
@NotNull
String getScreenshotName()

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.

getIgnoreCoordinates

@Stability(Stable)
@Nullable
default List<String> getIgnoreCoordinates()

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 .

builder

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

Returns:

a CfnCanary.BaseScreenshotProperty.Builder of CfnCanary.BaseScreenshotProperty