Class: Aws::Synthetics::Types::CanaryScheduleOutput

Inherits:

Struct

Object
Struct
Aws::Synthetics::Types::CanaryScheduleOutput

show all

Defined in:: gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb

Overview

How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#duration_in_seconds ⇒ Integer
How long, in seconds, for the canary to continue making regular runs after it was created.
#expression ⇒ String
A rate expression or a cron expression that defines how often the canary is to run.

Instance Attribute Details

#duration_in_seconds ⇒ `Integer`

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.

Returns:

(Integer)

# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 594

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

#expression ⇒ `String`

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. For information about the syntax for cron expressions, see Scheduling canary runs using cron.