CanaryCodeOutput

This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [0-9a-zA-Z_\-\.]+

Required: No

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.

Type: Array of Dependency objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: No

Handler

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

SourceLocationArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

CanaryCodeOutput

Contents

See Also