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

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

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

Overview

Note:

When passing CanaryScheduleInput as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

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)

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

#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. 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.

Returns:

  • (String)

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