Class Schedule
(experimental) Schedule for canary runs.
Inheritance
Namespace: Amazon.CDK.AWS.Synthetics
Assembly: Amazon.CDK.AWS.Synthetics.dll
Syntax (csharp)
public class Schedule : DeputyBaseSyntax (vb)
Public Class Schedule
Inherits DeputyBaseRemarks
Stability: Experimental
ExampleMetadata: infused
Examples
var schedule = Schedule.Rate(Duration.Minutes(5));Synopsis
Constructors
| Schedule(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| Schedule(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
| ExpressionString | (experimental) The Schedule expression. |
Methods
| Cron(ICronOptions) | (experimental) Create a schedule from a set of cron fields. |
| Expression(String) | (experimental) Construct a schedule from a literal schedule expression. |
| Once() | (experimental) The canary will be executed once. |
| Rate(Duration) | (experimental) Construct a schedule from an interval. |
Constructors
Schedule(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Schedule(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Schedule(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Schedule(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ExpressionString
(experimental) The Schedule expression.
public virtual string ExpressionString { get; }Property Value
System.String
Remarks
Stability: Experimental
Methods
Cron(ICronOptions)
(experimental) Create a schedule from a set of cron fields.
public static Schedule Cron(ICronOptions options)Parameters
- options ICronOptions
Returns
Remarks
Stability: Experimental
Expression(String)
(experimental) Construct a schedule from a literal schedule expression.
public static Schedule Expression(string expression)Parameters
- expression System.String
The expression to use.
Returns
Remarks
The expression must be in a rate(number units) format.
For example, Schedule.expression('rate(10 minutes)')
Stability: Experimental
Once()
(experimental) The canary will be executed once.
public static Schedule Once()Returns
Remarks
Stability: Experimental
Rate(Duration)
(experimental) Construct a schedule from an interval.
public static Schedule Rate(Duration interval)Parameters
- interval Duration
The interval at which to run the canary.
Returns
Remarks
Allowed values: 0 (for a single run) or between 1 and 60 minutes.
To specify a single run, you can use Schedule.once().
Stability: Experimental