software.amazon.awscdk.services.synthetics

Class CfnCanary.BaseScreenshotProperty.Builder

java.lang.Object

software.amazon.awscdk.services.synthetics.CfnCanary.BaseScreenshotProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCanary.BaseScreenshotProperty>

Enclosing interface:

CfnCanary.BaseScreenshotProperty

@Stability(value=Stable)
public static final class CfnCanary.BaseScreenshotProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCanary.BaseScreenshotProperty>

A builder for CfnCanary.BaseScreenshotProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnCanary.BaseScreenshotProperty	build() Builds the configured instance.
CfnCanary.BaseScreenshotProperty.Builder	ignoreCoordinates(List<String> ignoreCoordinates) Sets the value of CfnCanary.BaseScreenshotProperty.getIgnoreCoordinates()
CfnCanary.BaseScreenshotProperty.Builder	screenshotName(String screenshotName) Sets the value of CfnCanary.BaseScreenshotProperty.getScreenshotName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

screenshotName

@Stability(value=Stable)
public CfnCanary.BaseScreenshotProperty.Builder screenshotName(String screenshotName)

Sets the value of CfnCanary.BaseScreenshotProperty.getScreenshotName()

Parameters:

screenshotName - The name of the screenshot. This parameter is required. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

Returns:

this

ignoreCoordinates

@Stability(value=Stable)
public CfnCanary.BaseScreenshotProperty.Builder ignoreCoordinates(List<String> ignoreCoordinates)

Sets the value of CfnCanary.BaseScreenshotProperty.getIgnoreCoordinates()

Parameters:

ignoreCoordinates - Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Returns:

this

build

@Stability(value=Stable)
public CfnCanary.BaseScreenshotProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCanary.BaseScreenshotProperty>

Returns:

a new instance of CfnCanary.BaseScreenshotProperty

Throws:

NullPointerException - if any required attribute was not provided