Interface CanaryScheduleInput.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CanaryScheduleInput.Builder,
,CanaryScheduleInput> SdkBuilder<CanaryScheduleInput.Builder,
,CanaryScheduleInput> SdkPojo
- Enclosing class:
CanaryScheduleInput
-
Method Summary
Modifier and TypeMethodDescriptiondurationInSeconds
(Long durationInSeconds) How long, in seconds, for the canary to continue making regular runs according to the schedule in theExpression
value.expression
(String expression) Arate
expression or acron
expression that defines how often the canary is to run.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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. 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.- Parameters:
expression
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
durationInSeconds
How long, in seconds, for the canary to continue making regular runs according to the schedule in the
Expression
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.- Parameters:
durationInSeconds
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-