Struct aws_sdk_synthetics::model::CanaryRunConfigInput

#[non_exhaustive]
pub struct CanaryRunConfigInput {
    pub timeout_in_seconds: Option<i32>,
    pub memory_in_mb: Option<i32>,
    pub active_tracing: Option<bool>,
    pub environment_variables: Option<HashMap<String, String>>,
}

A structure that contains input information for a canary run.

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.

timeout_in_seconds: Option<i32>

How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary.

If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.

memory_in_mb: Option<i32>

The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

active_tracing: Option<bool>

Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing.

You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.

environment_variables: Option<HashMap<String, String>>

Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:

{ "key1" : "value1", "key2" : "value2", ...}

Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.

Implementations

impl CanaryRunConfigInput

pub fn timeout_in_seconds(&self) -> Option<i32>

How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary.

If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.

pub fn memory_in_mb(&self) -> Option<i32>

The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

pub fn active_tracing(&self) -> Option<bool>

Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing.

You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.

pub fn environment_variables(&self) -> Option<&HashMap<String, String>>

Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:

{ "key1" : "value1", "key2" : "value2", ...}

Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.

impl CanaryRunConfigInput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CanaryRunConfigInput

Trait Implementations

impl Clone for CanaryRunConfigInput

fn clone(&self) -> CanaryRunConfigInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanaryRunConfigInput

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

Formats the value using the given formatter.

impl PartialEq<CanaryRunConfigInput> for CanaryRunConfigInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for CanaryRunConfigInput