Values.CanarySourceThis structure contains all information about one canary in your account.
type nonrec t = {id : UUID.t option;The unique ID of this canary.
*)name : CanaryName.t option;The name of the canary.
*)code : CanaryCodeOutput.t option;executionRoleArn : RoleArn.t option;The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.
*)schedule : CanaryScheduleOutput.t option;A structure that contains information about how often the canary is to run, and when these runs are to stop.
*)runConfig : CanaryRunConfigOutput.t option;successRetentionPeriodInDays : MaxSize1024.t option;The number of days to retain data about successful runs of this canary. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
*)failureRetentionPeriodInDays : MaxSize1024.t option;The number of days to retain data about failed runs of this canary. This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
*)status : CanaryStatus.t option;A structure that contains information about the canary's status.
*)timeline : CanaryTimeline.t option;A structure that contains information about when the canary was created, modified, and most recently run.
*)artifactS3Location : String_.t option;The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
*)engineArn : FunctionArn.t option;The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.
*)runtimeVersion : String_.t option;Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
*)vpcConfig : VpcConfigOutput.t option;visualReference : VisualReferenceOutput.t option;If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
*)provisionedResourceCleanup : ProvisionedResourceCleanupSetting.t option;Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
*)browserConfigs : BrowserConfigs.t option;A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers. If not specified, browserConfigs defaults to Chrome.
*)engineConfigs : EngineConfigs.t option;A list of engine configurations for the canary, one for each browser type that the canary is configured to run on. All runtime versions syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, use engineConfigs only. You can no longer use engineArn in these versions. Runtime versions older than syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 continue to support engineArn to ensure backward compatibility.
*)visualReferences : VisualReferencesOutput.t option;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.
*)artifactConfig : ArtifactConfigOutput.t option;A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
*)dryRunConfig : DryRunConfigOutput.t option;Returns the dry run configurations for a canary.
*)}val make :
?id:??? ->
?name:??? ->
?code:??? ->
?executionRoleArn:??? ->
?schedule:??? ->
?runConfig:??? ->
?successRetentionPeriodInDays:??? ->
?failureRetentionPeriodInDays:??? ->
?status:??? ->
?timeline:??? ->
?artifactS3Location:??? ->
?engineArn:??? ->
?runtimeVersion:??? ->
?vpcConfig:??? ->
?visualReference:??? ->
?provisionedResourceCleanup:??? ->
?browserConfigs:??? ->
?engineConfigs:??? ->
?visualReferences:??? ->
?tags:??? ->
?artifactConfig:??? ->
?dryRunConfig:??? ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `Integer of MaxSize1024.t
| `List of
[> `Structure of
(string
* [> `Enum of string
| `List of
[> `Structure of
(string
* [> `List of
[> `String of
BaseScreenshotConfigIgnoreCoordinate.t ]
list
| `String of String_.t ])
list ]
list
| `String of FunctionArn.t ])
list ]
list
| `Map of
([> `String of TagKey.t ] * [> `String of TagValue.t ]) list
| `String of UUID.t
| `Structure of
(string
* [> `Boolean of NullableBoolean.t
| `Enum of string
| `Integer of MaxFifteenMinutesInSeconds.t
| `List of
[> `String of BlueprintType.t
| `Structure of
(string
* [> `Enum of string
| `List of
[> `String of BaseScreenshotConfigIgnoreCoordinate.t ]
list
| `String of String_.t ])
list ]
list
| `Long of MaxOneYearInSeconds.t
| `String of String_.t
| `Structure of
(string
* [> `Enum of string
| `Integer of MaxRetries.t
| `String of KmsKeyArn.t ])
list
| `Timestamp of Timestamp.t ])
list ])
list ]