NAME

Paws::Synthetics::CanaryScheduleInput

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Synthetics::CanaryScheduleInput object:

  $service_obj->Method(Att1 => { DurationInSeconds => $value, ..., Expression => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Synthetics::CanaryScheduleInput object:

  $result = $service_obj->Method(...);
  $result->Att1->DurationInSeconds

DESCRIPTION

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

ATTRIBUTES

DurationInSeconds => Int

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.

REQUIRED Expression => Str

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.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Synthetics

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues