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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb

Overview

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
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#handlerString

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

Returns:

  • (String)


174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 174

class CanaryCodeInput < Struct.new(
  :s3_bucket,
  :s3_key,
  :s3_version,
  :zip_file,
  :handler)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucketString

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)


174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 174

class CanaryCodeInput < Struct.new(
  :s3_bucket,
  :s3_key,
  :s3_version,
  :zip_file,
  :handler)
  SENSITIVE = []
  include Aws::Structure
end

#s3_keyString

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

Returns:

  • (String)


174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 174

class CanaryCodeInput < Struct.new(
  :s3_bucket,
  :s3_key,
  :s3_version,
  :zip_file,
  :handler)
  SENSITIVE = []
  include Aws::Structure
end

#s3_versionString

The S3 version ID of your script.

Returns:

  • (String)


174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 174

class CanaryCodeInput < Struct.new(
  :s3_bucket,
  :s3_key,
  :s3_version,
  :zip_file,
  :handler)
  SENSITIVE = []
  include Aws::Structure
end

#zip_fileString

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)


174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 174

class CanaryCodeInput < Struct.new(
  :s3_bucket,
  :s3_key,
  :s3_version,
  :zip_file,
  :handler)
  SENSITIVE = []
  include Aws::Structure
end