class Aws::Synthetics::Types::CanaryRunConfigInput

A structure that contains input information for a canary run.

@note When making an API call, you may pass CanaryRunConfigInput

data as a hash:

    {
      timeout_in_seconds: 1,
      memory_in_mb: 1,
      active_tracing: false,
      environment_variables: {
        "EnvironmentVariableName" => "EnvironmentVariableValue",
      },
    }

@!attribute [rw] timeout_in_seconds

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.
@return [Integer]

@!attribute [rw] memory_in_mb

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

@!attribute [rw] active_tracing

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][1].

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

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html
@return [Boolean]

@!attribute [rw] 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][1].

[1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
@return [Hash<String,String>]

@see docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunConfigInput AWS API Documentation

Constants

SENSITIVE