class Aws::Synthetics::Types::CanaryScheduleInput

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

@note When making an API call, you may pass CanaryScheduleInput

data as a hash:

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

@!attribute [rw] expression

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][1].

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html
@return [String]

@!attribute [rw] duration_in_seconds

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.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryScheduleInput AWS API Documentation

Constants

SENSITIVE