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

Inherits:

Struct

• Object
• Struct
• Aws::Synthetics::Types::CanaryRunConfigInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-synthetics/types.rb

Overview

A structure that contains input information for a canary run.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #active_tracing ⇒ Boolean

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

• #memory_in_mb ⇒ 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.

Instance Attribute Details

#active_tracing ⇒ Boolean

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.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-synthetics/types.rb', line 534

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

#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].

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.

[1]: docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-synthetics/types.rb', line 534

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

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

# File 'lib/aws-sdk-synthetics/types.rb', line 534

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

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

# File 'lib/aws-sdk-synthetics/types.rb', line 534

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