You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Synthetics::Types::CanaryCodeInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CanaryCodeInput as input to an Aws::Client method, you can use a vanilla Hash:

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

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#handler ⇒ String

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

Returns:

  • (String) —

    The entry point to use for the source code when running the canary.

#s3_bucket ⇒ String

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.

Returns:

  • (String) —

    If your canary script is located in S3, specify the full bucket name here.

#s3_key ⇒ String

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

Returns:

  • (String) —

    The S3 key of your script.

#s3_version ⇒ String

The S3 version ID of your script.

Returns:

  • (String) —

    The S3 version ID of your script.

#zip_file ⇒ String

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.

Returns:

  • (String) —

    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.