You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Synthetics::Types::CanaryRunConfigInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CanaryRunConfigInput as input to an Aws::Client method, you can use a vanilla Hash:

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

A structure that contains input information for a canary run.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#active_tracing ⇒ Boolean

Specifies whether this canary is to use active AWS 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.

Returns:

  • (Boolean) —

    Specifies whether this canary is to use active AWS X-Ray tracing when it runs.

#environment_variables ⇒ Hash<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.

Returns:

  • (Hash<String,String>) —

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

#memory_in_mb ⇒ Integer

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

Returns:

  • (Integer) —

    The maximum amount of memory available to the canary while it is running, in MB.

#timeout_in_seconds ⇒ Integer

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.

Returns:

  • (Integer) —

    How long the canary is allowed to run before it must stop.