/AWS1/CL_SYNCANARYCODEINPUT

Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an Amazon S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.

If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.

• For Node.js canaries, the folder structure must be nodejs/node_modules/myCanaryFilename.js For more information, see Packaging your Node.js canary files

• For Python canaries, the folder structure must be python/myCanaryFilename.py or python/myFolder/myCanaryFilename.py For more information, see Packaging your Python canary files

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_s3bucket TYPE /AWS1/SYNSTRING /AWS1/SYNSTRING

If your canary script is located in Amazon S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

iv_s3key TYPE /AWS1/SYNSTRING /AWS1/SYNSTRING

The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects.

iv_s3version TYPE /AWS1/SYNSTRING /AWS1/SYNSTRING

The Amazon S3 version ID of your script.

iv_zipfile TYPE /AWS1/SYNBLOB /AWS1/SYNBLOB

If you input your canary script directly into the canary instead of referring to an Amazon S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.

For large canary scripts, we recommend that you use an Amazon S3 location instead of inputting it directly with this parameter.

iv_handler TYPE /AWS1/SYNCODEHANDLER /AWS1/SYNCODEHANDLER

The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .

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

it_blueprinttypes TYPE /AWS1/CL_SYNBLUEPRINTTYPES_W=>TT_BLUEPRINTTYPES TT_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.

it_dependencies TYPE /AWS1/CL_SYNDEPENDENCY=>TT_DEPENDENCIES TT_DEPENDENCIES

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

---

Queryable Attributes

S3Bucket

If your canary script is located in Amazon S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

Accessible with the following methods

Method	Description
GET_S3BUCKET()	Getter for S3BUCKET, with configurable default
ASK_S3BUCKET()	Getter for S3BUCKET w/ exceptions if field has no value
HAS_S3BUCKET()	Determine if S3BUCKET has a value

S3Key

The Amazon S3 key of your script. For more information, see Working with Amazon S3 Objects.

Accessible with the following methods

Method	Description
GET_S3KEY()	Getter for S3KEY, with configurable default
ASK_S3KEY()	Getter for S3KEY w/ exceptions if field has no value
HAS_S3KEY()	Determine if S3KEY has a value

S3Version

The Amazon S3 version ID of your script.

Accessible with the following methods

Method	Description
GET_S3VERSION()	Getter for S3VERSION, with configurable default
ASK_S3VERSION()	Getter for S3VERSION w/ exceptions if field has no value
HAS_S3VERSION()	Determine if S3VERSION has a value

ZipFile

If you input your canary script directly into the canary instead of referring to an Amazon S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.

For large canary scripts, we recommend that you use an Amazon S3 location instead of inputting it directly with this parameter.

Accessible with the following methods

Method	Description
GET_ZIPFILE()	Getter for ZIPFILE, with configurable default
ASK_ZIPFILE()	Getter for ZIPFILE w/ exceptions if field has no value
HAS_ZIPFILE()	Determine if ZIPFILE has a value

Handler

The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .

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

Accessible with the following methods

Method	Description
GET_HANDLER()	Getter for HANDLER, with configurable default
ASK_HANDLER()	Getter for HANDLER w/ exceptions if field has no value
HAS_HANDLER()	Determine if HANDLER has a value

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.

Accessible with the following methods

Method	Description
GET_BLUEPRINTTYPES()	Getter for BLUEPRINTTYPES, with configurable default
ASK_BLUEPRINTTYPES()	Getter for BLUEPRINTTYPES w/ exceptions if field has no valu
HAS_BLUEPRINTTYPES()	Determine if BLUEPRINTTYPES has a value

Dependencies

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

Accessible with the following methods

Method	Description
GET_DEPENDENCIES()	Getter for DEPENDENCIES, with configurable default
ASK_DEPENDENCIES()	Getter for DEPENDENCIES w/ exceptions if field has no value
HAS_DEPENDENCIES()	Determine if DEPENDENCIES has a value