Class: AWSCDK::Synthetics::CfnCanary::VisualReferenceProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
synthetics/cfn_canary.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_canary_run_id:, base_screenshots: nil, browser_type: nil) ⇒ VisualReferenceProperty

Returns a new instance of VisualReferenceProperty.

Parameters:

  • 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 (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Synthetics::CfnCanary::BaseScreenshotProperty>, nil) (defaults to: nil) —

    An array of screenshots that are used as the baseline for comparisons during visual monitoring.

  • browser_type (String, nil) (defaults to: nil) —

    The browser type associated with this visual reference configuration.



1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'synthetics/cfn_canary.rb', line 1403

def initialize(base_canary_run_id:, base_screenshots: nil, browser_type: nil)
  @base_canary_run_id = base_canary_run_id
  Jsii::Type.check_type(@base_canary_run_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "baseCanaryRunId")
  @base_screenshots = base_screenshots
  Jsii::Type.check_type(@base_screenshots, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3ludGhldGljcy5DZm5DYW5hcnkuQmFzZVNjcmVlbnNob3RQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "baseScreenshots") unless @base_screenshots.nil?
  @browser_type = browser_type
  Jsii::Type.check_type(@browser_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "browserType") unless @browser_type.nil?
end

Instance Attribute Details

#base_canary_run_id ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



1418
1419
1420
 
# File 'synthetics/cfn_canary.rb', line 1418

def base_canary_run_id
  @base_canary_run_id
end

#base_screenshots ⇒ AWSCDK::IResolvable, ... (readonly)

An array of screenshots that are used as the baseline for comparisons during visual monitoring.

Returns:

See Also:



1423
1424
1425
 
# File 'synthetics/cfn_canary.rb', line 1423

def base_screenshots
  @base_screenshots
end

#browser_type ⇒ String? (readonly)

The browser type associated with this visual reference configuration.

Valid values are CHROME and FIREFOX .

Returns:

  • (String, nil)

See Also:



1430
1431
1432
 
# File 'synthetics/cfn_canary.rb', line 1430

def browser_type
  @browser_type
end

Class Method Details

.jsii_properties ⇒ Object 



1432
1433
1434
1435
1436
1437
1438
 
# File 'synthetics/cfn_canary.rb', line 1432

def self.jsii_properties
  {
    :base_canary_run_id => "baseCanaryRunId",
    :base_screenshots => "baseScreenshots",
    :browser_type => "browserType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'synthetics/cfn_canary.rb', line 1440

def to_jsii
  result = {}
  result.merge!({
    "baseCanaryRunId" => @base_canary_run_id,
    "baseScreenshots" => @base_screenshots,
    "browserType" => @browser_type,
  })
  result.compact
end