Class: Aws::Synthetics::Types::CanaryCodeInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Synthetics::Types::CanaryCodeInput
- Defined in:
- gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb
Overview
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
-
#handler ⇒ 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 bucket name here.
-
#s3_key ⇒ String
The S3 key of your script.
-
#s3_version ⇒ 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 base64-encoded contents of the .zip file that contains the script.
Instance Attribute Details
#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
.
294 295 296 297 298 299 300 301 302 |
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 294 class CanaryCodeInput < Struct.new( :s3_bucket, :s3_key, :s3_version, :zip_file, :handler) SENSITIVE = [] include Aws::Structure end |
#s3_bucket ⇒ 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.
294 295 296 297 298 299 300 301 302 |
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 294 class CanaryCodeInput < Struct.new( :s3_bucket, :s3_key, :s3_version, :zip_file, :handler) SENSITIVE = [] include Aws::Structure end |
#s3_key ⇒ String
The S3 key of your script. For more information, see Working with Amazon S3 Objects.
294 295 296 297 298 299 300 301 302 |
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 294 class CanaryCodeInput < Struct.new( :s3_bucket, :s3_key, :s3_version, :zip_file, :handler) SENSITIVE = [] include Aws::Structure end |
#s3_version ⇒ String
The S3 version ID of your script.
294 295 296 297 298 299 300 301 302 |
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 294 class CanaryCodeInput < Struct.new( :s3_bucket, :s3_key, :s3_version, :zip_file, :handler) SENSITIVE = [] include Aws::Structure end |
#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 base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.
For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.
294 295 296 297 298 299 300 301 302 |
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 294 class CanaryCodeInput < Struct.new( :s3_bucket, :s3_key, :s3_version, :zip_file, :handler) SENSITIVE = [] include Aws::Structure end |