class Aws::Synthetics::Types::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`.

@note When making an API call, you may pass CanaryCodeInput

data as a hash:

    {
      s3_bucket: "String",
      s3_key: "String",
      s3_version: "String",
      zip_file: "data",
      handler: "String", # required
    }

@!attribute [rw] s3_bucket

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

@!attribute [rw] s3_key

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

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html
@return [String]

@!attribute [rw] s3_version

The S3 version ID of your script.
@return [String]

@!attribute [rw] zip_file

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 256 Kb.
@return [String]

@!attribute [rw] handler

The entry point to use for the source code when running the canary.
This value must end with the string `.handler`. The string is
limited to 29 characters or fewer.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryCodeInput AWS API Documentation

Constants

SENSITIVE