synthetics/aws.sdk.kotlin.services.synthetics.model/CanaryCodeInput

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.

Types

Builder

class Builder

Companion

object Companion

Properties

handler

val handler: String

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 .

s3Bucket

val s3Bucket: String?

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

s3Key

val s3Key: String?

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

s3Version

val s3Version: String?

The S3 version ID of your script.

zipFile

val zipFile: ByteArray?

If you input your canary script directly into the canary instead of referring to an 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.

Functions

copy

inline fun copy(block: CanaryCodeInput.Builder.() -> Unit = {}): CanaryCodeInput

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String