CanaryScheduleOutput
How long, in seconds, for the canary to continue making regular runs according to the schedule in the
Expression
value.
Contents
- DurationInSeconds
-
How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the
Expression
value.Type: Long
Valid Range: Minimum value of 0. Maximum value of 31622400.
Required: No
- Expression
-
A
rate
expression or acron
expression that defines how often the canary is to run.For a rate expression, The syntax is
rate(number unit)
. unit can beminute
,minutes
, orhour
.For example,
rate(1 minute)
runs the canary once a minute,rate(10 minutes)
runs it once every 10 minutes, andrate(1 hour)
runs it once every hour. You can specify a frequency betweenrate(1 minute)
andrate(1 hour)
.Specifying
rate(0 minute)
orrate(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. For information about the syntax for cron expressions, see Scheduling canary runs using cron.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: