Class CfnCanary.RunConfigProperty
A structure that contains input information for a canary run.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Synthetics
Assembly: Amazon.CDK.AWS.Synthetics.dll
Syntax (csharp)
public class RunConfigProperty : Object, CfnCanary.IRunConfigProperty
Syntax (vb)
Public Class RunConfigProperty
Inherits Object
Implements CfnCanary.IRunConfigProperty
Remarks
This structure is required.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Synthetics;
var runConfigProperty = new RunConfigProperty {
ActiveTracing = false,
EnvironmentVariables = new Dictionary<string, string> {
{ "environmentVariablesKey", "environmentVariables" }
},
MemoryInMb = 123,
TimeoutInSeconds = 123
};
Synopsis
Constructors
RunConfigProperty() |
Properties
ActiveTracing | Specifies whether this canary is to use active AWS X-Ray tracing when it runs. |
EnvironmentVariables | Specifies the keys and values to use for any environment variables used in the canary script. |
MemoryInMb | The maximum amount of memory that the canary can use while running. |
TimeoutInSeconds | How long the canary is allowed to run before it must stop. |
Constructors
RunConfigProperty()
public RunConfigProperty()
Properties
ActiveTracing
Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
public object ActiveTracing { get; set; }
Property Value
System.Object
Remarks
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
Specifies the keys and values to use for any environment variables used in the canary script.
public object EnvironmentVariables { get; set; }
Property Value
System.Object
Remarks
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
The maximum amount of memory that the canary can use while running.
public Nullable<double> MemoryInMb { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This value must be a multiple of 64. The range is 960 to 3008.
TimeoutInSeconds
How long the canary is allowed to run before it must stop.
public Nullable<double> TimeoutInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.