Struct CanaryCodeInput 

#[non_exhaustive]
pub struct CanaryCodeInput {
    pub s3_bucket: Option<String>,
    pub s3_key: Option<String>,
    pub s3_version: Option<String>,
    pub zip_file: Option<Blob>,
    pub handler: String,
    pub dependencies: Option<Vec<Dependency>>,
}

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 Amazon 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.

If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.

• For Node.js canaries, the folder structure must be nodejs/node_modules/myCanaryFilename.js For more information, see Packaging your Node.js canary files

• For Python canaries, the folder structure must be python/myCanaryFilename.py or python/myFolder/myCanaryFilename.py For more information, see Packaging your Python canary files

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

s3_bucket: Option<String>

If your canary script is located in Amazon S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

s3_key: Option<String>

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

s3_version: Option<String>

The Amazon S3 version ID of your script.

zip_file: Option<Blob>

If you input your canary script directly into the canary instead of referring to an Amazon 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 Amazon S3 location instead of inputting it directly with this parameter.

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 .

dependencies: Option<Vec<Dependency>>

A list of dependencies that should be used for running this canary. Specify the dependencies as a key-value pair, where the key is the type of dependency and the value is the dependency reference.

Implementations

impl CanaryCodeInput

pub fn s3_bucket(&self) -> Option<&str>

If your canary script is located in Amazon S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

pub fn s3_key(&self) -> Option<&str>

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

pub fn s3_version(&self) -> Option<&str>

The Amazon S3 version ID of your script.

pub fn zip_file(&self) -> Option<&Blob>

If you input your canary script directly into the canary instead of referring to an Amazon 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 Amazon S3 location instead of inputting it directly with this parameter.

pub fn handler(&self) -> &str

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 .

pub fn dependencies(&self) -> &[Dependency]

A list of dependencies that should be used for running this canary. Specify the dependencies as a key-value pair, where the key is the type of dependency and the value is the dependency reference.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dependencies.is_none().

impl CanaryCodeInput

pub fn builder() -> CanaryCodeInputBuilder

Creates a new builder-style object to manufacture CanaryCodeInput.

Trait Implementations

impl Clone for CanaryCodeInput

fn clone(&self) -> CanaryCodeInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CanaryCodeInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CanaryCodeInput

fn eq(&self, other: &CanaryCodeInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CanaryCodeInput