Skip to content

CanaryCodeOutput

Source code in docs_src/capo_synthetics/types/canary_code_output.py 
13
14
15
16
17
18
19
20
21
class CanaryCodeOutput(TypedDict, closed=True):
    source_location_arn: NotRequired["capo_synthetics.types.string.String"]
    """<p>The ARN of the Lambda layer where Synthetics stores the canary script code.</p>"""
    handler: NotRequired["capo_synthetics.types.string.String"]
    """<p>The entry point to use for the source code when running the canary.</p> <p>This field is required when you don't specify <code>BlueprintTypes</code> and is not allowed when you specify <code>BlueprintTypes</code>.</p>"""
    blueprint_types: NotRequired["capo_synthetics.types.blueprint_types.BlueprintTypes"]
    """<p> <code>BlueprintTypes</code> is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is <code>multi-checks</code>.</p> <p>Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify <code>BlueprintTypes</code>, the <code>Handler</code> field cannot be specified since the blueprint provides a pre-defined entry point.</p> <p> <code>BlueprintTypes</code> is supported only on canaries for syn-nodejs-3.0 runtime or later.</p>"""
    dependencies: NotRequired["capo_synthetics.types.dependencies.Dependencies"]
    """<p>A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.</p>"""

blueprint_types instance-attribute 

blueprint_types: NotRequired[BlueprintTypes]

BlueprintTypes is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is multi-checks.

Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify BlueprintTypes, the Handler field cannot be specified since the blueprint provides a pre-defined entry point.

BlueprintTypes is supported only on canaries for syn-nodejs-3.0 runtime or later.

dependencies instance-attribute 

dependencies: NotRequired[Dependencies]

A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.

handler instance-attribute 

handler: NotRequired[String]

The entry point to use for the source code when running the canary.

This field is required when you don't specify BlueprintTypes and is not allowed when you specify BlueprintTypes.

source_location_arn instance-attribute 

source_location_arn: NotRequired[String]

The ARN of the Lambda layer where Synthetics stores the canary script code.