interface VisualReferenceProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Synthetics.CfnCanary.VisualReferenceProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#CfnCanary_VisualReferenceProperty |
![]() | software.amazon.awscdk.services.synthetics.CfnCanary.VisualReferenceProperty |
![]() | aws_cdk.aws_synthetics.CfnCanary.VisualReferenceProperty |
![]() | aws-cdk-lib » aws_synthetics » CfnCanary » VisualReferenceProperty |
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 { aws_synthetics as synthetics } from 'aws-cdk-lib';
const visualReferenceProperty: synthetics.CfnCanary.VisualReferenceProperty = {
baseCanaryRunId: 'baseCanaryRunId',
// the properties below are optional
baseScreenshots: [{
screenshotName: 'screenshotName',
// the properties below are optional
ignoreCoordinates: ['ignoreCoordinates'],
}],
};
Properties
Name | Type | Description |
---|---|---|
base | string | Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. |
base | IResolvable | IResolvable | Base [] | An array of screenshots that are used as the baseline for comparisons during visual monitoring. |
baseCanaryRunId
Type:
string
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.
baseScreenshots?
Type:
IResolvable
|
IResolvable
|
Base
[]
(optional)
An array of screenshots that are used as the baseline for comparisons during visual monitoring.