interface RunConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Synthetics.CfnCanary.RunConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#CfnCanary_RunConfigProperty`
Java	`software.amazon.awscdk.services.synthetics.CfnCanary.RunConfigProperty`
Python	`aws_cdk.aws_synthetics.CfnCanary.RunConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_synthetics` » `CfnCanary` » `RunConfigProperty`

A structure that contains input information for a canary run.

This structure is required.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_synthetics as synthetics } from 'aws-cdk-lib';
const runConfigProperty: synthetics.CfnCanary.RunConfigProperty = {
  activeTracing: false,
  environmentVariables: {
    environmentVariablesKey: 'environmentVariables',
  },
  memoryInMb: 123,
  timeoutInSeconds: 123,
};

Properties

Name	Type	Description
activeTracing?	`boolean \|` `IResolvable`	Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
environmentVariables?	`{ [string]: string } \|` `IResolvable`	Specifies the keys and values to use for any environment variables used in the canary script.
memoryInMb?	`number`	The maximum amount of memory that the canary can use while running.
timeoutInSeconds?	`number`	How long the canary is allowed to run before it must stop.

activeTracing?

Type: boolean | IResolvable (optional)

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.

environmentVariables?

Type: { [string]: string } | IResolvable (optional)

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 .

memoryInMb?

Type: number (optional)

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.

timeoutInSeconds?

Type: number (optional)

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.