Struct CanaryRunConfigInputBuilder 

#[non_exhaustive]
pub struct CanaryRunConfigInputBuilder { /* private fields */ }

A builder for CanaryRunConfigInput.

Implementations

impl CanaryRunConfigInputBuilder

pub fn timeout_in_seconds(self, input: i32) -> Self

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 set_timeout_in_seconds(self, input: Option<i32>) -> Self

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 get_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, input: i32) -> Self

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 set_memory_in_mb(self, input: Option<i32>) -> Self

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 get_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, input: bool) -> Self

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 set_active_tracing(self, input: Option<bool>) -> Self

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 get_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, k: impl Into<String>, v: impl Into<String>, ) -> Self

Adds a key-value pair to environment_variables.

To override the contents of this collection use set_environment_variables.

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.

Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

pub fn set_environment_variables( self, input: Option<HashMap<String, String>>, ) -> Self

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.

Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

pub fn get_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.

Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

pub fn ephemeral_storage(self, input: i32) -> Self

Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.

pub fn set_ephemeral_storage(self, input: Option<i32>) -> Self

Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.

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

Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.

pub fn build(self) -> CanaryRunConfigInput

Consumes the builder and constructs a CanaryRunConfigInput.

Trait Implementations

impl Clone for CanaryRunConfigInputBuilder

fn clone(&self) -> CanaryRunConfigInputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanaryRunConfigInputBuilder

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

Formats the value using the given formatter.

impl Default for CanaryRunConfigInputBuilder

fn default() -> CanaryRunConfigInputBuilder

Returns the “default value” for a type.

impl PartialEq for CanaryRunConfigInputBuilder

fn eq(&self, other: &CanaryRunConfigInputBuilder) -> 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 CanaryRunConfigInputBuilder