Struct aws_sdk_synthetics::model::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: Option<String>,
}

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.

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 S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.

s3_key: Option<String>

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

s3_version: Option<String>

The 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 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 256 Kb.

handler: Option<String>

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

Implementations

impl CanaryCodeInput

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

If your canary script is located in 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 S3 key of your script. For more information, see Working with Amazon S3 Objects.

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

The 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 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 256 Kb.

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

The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.

impl CanaryCodeInput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CanaryCodeInput

Trait Implementations

impl Clone for CanaryCodeInput

fn clone(&self) -> CanaryCodeInput

Returns a copy 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<CanaryCodeInput> for CanaryCodeInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for CanaryCodeInput