Interface CfnCanaryPropsMixin.IScheduleProperty
This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.
Namespace: Amazon.CDK.Mixins.Preview.AWS.Synthetics.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public interface CfnCanaryPropsMixin.ISchedulePropertySyntax (vb)
Public Interface CfnCanaryPropsMixin.ISchedulePropertyRemarks
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.Mixins.Preview.AWS.Synthetics.Mixins;
var scheduleProperty = new ScheduleProperty {
DurationInSeconds = "durationInSeconds",
Expression = "expression",
RetryConfig = new RetryConfigProperty {
MaxRetries = 123
}
};Synopsis
Properties
| DurationInSeconds | How long, in seconds, for the canary to continue making regular runs according to the schedule in the |
| Expression | A |
| RetryConfig | The canary's retry configuration information. |
Properties
DurationInSeconds
How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.
string? DurationInSeconds { get; }Property Value
Remarks
If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
Expression
A rate expression or a cron expression that defines how often the canary is to run.
string? Expression { get; }Property Value
Remarks
For a rate expression, The syntax is rate( number unit ) . unit can be minute , minutes , or hour .
For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour) .
Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
Use cron( expression ) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron .
RetryConfig
The canary's retry configuration information.
object? RetryConfig { get; }