AWS cli documentation change
Summary
Added documentation for multibrowser canary configuration options including browserConfigs and visual-references parameters, expanded JSON syntax with BrowserType, and detailed visual monitoring baseline management
Security assessment
The changes introduce new configuration options for multi-browser support and visual reference baselines but do not address any specific security vulnerabilities. While visual monitoring can aid in detecting UI changes, the documentation does not explicitly frame this as a security feature or reference security vulnerabilities.
Diff
diff --git a/cli/latest/reference/synthetics/update-canary.md b/cli/latest/reference/synthetics/update-canary.md index 8f53ada8e..30fe2b838 100644 --- a//cli/latest/reference/synthetics/update-canary.md +++ b//cli/latest/reference/synthetics/update-canary.md @@ -15 +15 @@ - * [AWS CLI 2.28.15 Command Reference](../../index.html) » + * [AWS CLI 2.28.16 Command Reference](../../index.html) » @@ -61,0 +62,7 @@ Updates the configuration of a canary that has already been created. +For multibrowser canaries, you can add or remove browsers by updating the browserConfig list in the update call. For example: + + * To add Firefox to a canary that currently uses Chrome, specify browserConfigs as [CHROME, FIREFOX] + * To remove Firefox and keep only Chrome, specify browserConfigs as [CHROME] + + + @@ -87,0 +95,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/synthe + [--visual-references <value>] + [--browser-configs <value>] @@ -386,0 +396,4 @@ JSON Syntax: +> +> BrowserType -> (string) +> +>> The browser type associated with this visual reference. @@ -399 +412,2 @@ JSON Syntax: - "BaseCanaryRunId": "string" + "BaseCanaryRunId": "string", + "BrowserType": "CHROME"|"FIREFOX" @@ -462,0 +477,96 @@ JSON Syntax: +`--visual-references` (list) + +> A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons. +> +>> `syn-nodejs-puppeteer-11.0` and above, and `syn-nodejs-playwright-3.0` and above, only supports `visualReferences` . `visualReference` field is not supported. +> +> Versions older than `syn-nodejs-puppeteer-11.0` supports both `visualReference` and `visualReferences` for backward compatibility. It is recommended to use `visualReferences` for consistency and future compatibility. +> +> For multibrowser visual monitoring, you can update the baseline for all configured browsers in a single update call by specifying a list of VisualReference objects, one per browser. Each VisualReference object maps to a specific browser configuration, allowing you to manage visual baselines for multiple browsers simultaneously. +> +> For single configuration canaries using Chrome browser (default browser), use visualReferences for `syn-nodejs-puppeteer-11.0` and above, and `syn-nodejs-playwright-3.0` and above canaries. The browserType in the visualReference object is not mandatory. +> +> (structure) +> +>> 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html) and [Visual monitoring blueprint](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html) +>> +>> BaseScreenshots -> (list) +>> +>>> 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. +>>> +>>> (structure) +>>> +>>>> A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary. +>>>> +>>>> ScreenshotName -> (string) +>>>> +>>>>> 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. +>>>> +>>>> IgnoreCoordinates -> (list) +>>>> +>>>>> 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 [Editing or deleting a canary](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html) +>>>>> +>>>>> (string) +>> +>> BaseCanaryRunId -> (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](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html) from a run of this a canary in the past 31 days. If you specify the `Id` of a canary run older than 31 days, the operation returns a 400 validation exception error.. +>> +>> BrowserType -> (string) +>> +>>> The browser type associated with this visual reference. + +JSON Syntax: + + + [ + { + "BaseScreenshots": [ + { + "ScreenshotName": "string", + "IgnoreCoordinates": ["string", ...] + } + ... + ], + "BaseCanaryRunId": "string", + "BrowserType": "CHROME"|"FIREFOX" + } + ... + ] + + +`--browser-configs` (list) + +> A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both `CHROME` and `FIREFOX` browsers. +> +> ### Note +> +> If not specified, `browserConfigs` defaults to Chrome. +> +> (structure) +> +>> A structure that specifies the browser type to use for a canary run. +>> +>> BrowserType -> (string) +>> +>>> The browser type associated with this browser configuration. + +Shorthand Syntax: + + + BrowserType=string ... + + +JSON Syntax: + + + [ + { + "BrowserType": "CHROME"|"FIREFOX" + } + ... + ] + + @@ -596 +706 @@ None - * [AWS CLI 2.28.15 Command Reference](../../index.html) » + * [AWS CLI 2.28.16 Command Reference](../../index.html) »