CanaryCodeInput - Amazon CloudWatch Synthetics

CanaryCodeInput

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 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.

Contents

Handler

The entry point to use for the source code when running the canary. This value must end with the string .handler.

Type: String

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

Required: Yes

S3Bucket

If your canary script is located in S3, specify the full bucket name here. The bucket must already exist. Specify the full bucket name, including s3:// as the start of the bucket name.

Type: String

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

Required: No

S3Key

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

Type: String

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

Required: No

S3Version

The S3 version ID of your script.

Type: String

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

Required: No

ZipFile

If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the .zip file that contains the script. It can be up to 5 MB.

Type: Base64-encoded binary data object

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: