Class: Aws::Synthetics::Types::VisualReferenceInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Synthetics::Types::VisualReferenceInput
- Defined in:
- gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb
Overview
An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.
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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#base_canary_run_id ⇒ String
Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary.
-
#base_screenshots ⇒ Array<Types::BaseScreenshot>
An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary.
Instance Attribute Details
#base_canary_run_id ⇒ 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.
1930 1931 1932 1933 1934 1935 |
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1930 class VisualReferenceInput < Struct.new( :base_screenshots, :base_canary_run_id) SENSITIVE = [] include Aws::Structure end |
#base_screenshots ⇒ Array<Types::BaseScreenshot>
An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.
1930 1931 1932 1933 1934 1935 |
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1930 class VisualReferenceInput < Struct.new( :base_screenshots, :base_canary_run_id) SENSITIVE = [] include Aws::Structure end |