You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#duration_in_secondsInteger

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)

    How long, in seconds, for the canary to continue making regular runs after it was created.

#expressionString

A rate expression that defines how often the canary is to run. 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.

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

Returns:

  • (String)

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