Interface CanaryCodeInput.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CanaryCodeInput.Builder,
,CanaryCodeInput> SdkBuilder<CanaryCodeInput.Builder,
,CanaryCodeInput> SdkPojo
- Enclosing class:
CanaryCodeInput
-
Method Summary
Modifier and TypeMethodDescriptionThe entry point to use for the source code when running the canary.If your canary script is located in S3, specify the bucket name here.The S3 key of your script.The S3 version ID of your script.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.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
s3Bucket
If your canary script is located in S3, specify the bucket name here. Do not include
s3://
as the start of the bucket name.- Parameters:
s3Bucket
- If your canary script is located in S3, specify the bucket name here. Do not includes3://
as the start of the bucket name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Key
The S3 key of your script. For more information, see Working with Amazon S3 Objects.
- Parameters:
s3Key
- The S3 key of your script. For more information, see Working with Amazon S3 Objects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Version
The S3 version ID of your script.
- Parameters:
s3Version
- The S3 version ID of your script.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
zipFile
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.
- Parameters:
zipFile
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
handler
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 asyn-nodejs.puppeteer
runtime earlier thansyn-nodejs.puppeteer-3.4
, the handler must be specified asfileName.handler
. Forsyn-python-selenium-1.1
,syn-nodejs.puppeteer-3.4
, and later runtimes, the handler can be specified asfileName.functionName
, or you can specify a folder where canary scripts reside asfolder/fileName.functionName
.- Parameters:
handler
- The entry point to use for the source code when running the canary. For canaries that use thesyn-python-selenium-1.0
runtime or asyn-nodejs.puppeteer
runtime earlier thansyn-nodejs.puppeteer-3.4
, the handler must be specified asfileName.handler
. Forsyn-python-selenium-1.1
,syn-nodejs.puppeteer-3.4
, and later runtimes, the handler can be specified asfileName.functionName
, or you can specify a folder where canary scripts reside asfolder/fileName.functionName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-