Interface CfnCanary.ScheduleProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCanary.ScheduleProperty.Jsii$Proxy
- Enclosing class:
CfnCanary
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.synthetics.*; ScheduleProperty scheduleProperty = ScheduleProperty.builder() .expression("expression") // the properties below are optional .durationInSeconds("durationInSeconds") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnCanary.ScheduleProperty
static final class
An implementation forCfnCanary.ScheduleProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getExpression
Arate
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. 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 .- See Also:
-
getDurationInSeconds
How long, in seconds, for the canary to continue making regular runs according to the schedule in theExpression
value.If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
- See Also:
-
builder
- Returns:
- a
CfnCanary.ScheduleProperty.Builder
ofCfnCanary.ScheduleProperty
-