Class: Aws::Synthetics::Types::CanaryScheduleInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb

Overview

Note:

When making an API call, you may pass CanaryScheduleInput data as a hash:

{
  expression: "String", # required
  duration_in_seconds: 1,
}

This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#duration_in_secondsInteger

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.

Returns:

  • (Integer)


609
610
611
612
613
614
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 609

class CanaryScheduleInput < Struct.new(
  :expression,
  :duration_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#expressionString

A rate expression or a cron expression that defines how often the canary is to run.

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.

Returns:

  • (String)


609
610
611
612
613
614
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 609

class CanaryScheduleInput < Struct.new(
  :expression,
  :duration_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end