interface BaseScreenshotProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Synthetics.CfnCanaryPropsMixin.BaseScreenshotProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awssynthetics#CfnCanaryPropsMixin_BaseScreenshotProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.synthetics.CfnCanaryPropsMixin.BaseScreenshotProperty
Python	aws_cdk.cfn_property_mixins.aws_synthetics.CfnCanaryPropsMixin.BaseScreenshotProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_synthetics » CfnCanaryPropsMixin » BaseScreenshotProperty

A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_synthetics as synthetics } from '@aws-cdk/cfn-property-mixins';
const baseScreenshotProperty: synthetics.CfnCanaryPropsMixin.BaseScreenshotProperty = {
  ignoreCoordinates: ['ignoreCoordinates'],
  screenshotName: 'screenshotName',
};

Properties

Name	Type	Description
ignoreCoordinates?	string[]	Coordinates that define the part of a screen to ignore during screenshot comparisons.
screenshotName?	string	The name of the screenshot.

---

ignoreCoordinates?

Type: string[] (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html#cfn-synthetics-canary-basescreenshot-ignorecoordinates

---

screenshotName?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html#cfn-synthetics-canary-basescreenshot-screenshotname