AWS::Synthetics::Canary RunConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Synthetics::Canary RunConfig

A structure that contains input information for a canary run. This structure is required.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "ActiveTracing" : Boolean,
  "EnvironmentVariables" : {Key: Value, ...},
  "MemoryInMB" : Integer,
  "TimeoutInSeconds" : Integer
}

YAML

  ActiveTracing: Boolean
  EnvironmentVariables: 
    Key: Value
  MemoryInMB: Integer
  TimeoutInSeconds: Integer

Properties

ActiveTracing

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

Required: No

Type: Boolean

Update requires: No interruption

EnvironmentVariables

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.

Required: No

Type: Object of String

Pattern: [a-zA-Z][a-zA-Z0-9_]+

Update requires: No interruption

MemoryInMB

The maximum amount of memory that the canary can use while running. This value must be a multiple of 64. The range is 960 to 3008.

Required: No

Type: Integer

Minimum: 960

Maximum: 3008

Update requires: No interruption

TimeoutInSeconds

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 900 seconds.

Required: No

Type: Integer

Minimum: 3

Maximum: 840

Update requires: No interruption