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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb

Overview

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",
  },
}

A structure that contains input information for a canary run.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_tracingBoolean

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)


323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 323

class CanaryRunConfigInput < Struct.new(
  :timeout_in_seconds,
  :memory_in_mb,
  :active_tracing,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#environment_variablesHash<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>)


323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 323

class CanaryRunConfigInput < Struct.new(
  :timeout_in_seconds,
  :memory_in_mb,
  :active_tracing,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#memory_in_mbInteger

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)


323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 323

class CanaryRunConfigInput < Struct.new(
  :timeout_in_seconds,
  :memory_in_mb,
  :active_tracing,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_secondsInteger

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)


323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 323

class CanaryRunConfigInput < Struct.new(
  :timeout_in_seconds,
  :memory_in_mb,
  :active_tracing,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end