CanaryScheduleOutput - Amazon CloudWatch Synthetics

CanaryScheduleOutput

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

Contents

DurationInSeconds

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.

Type: Long

Valid Range: Minimum value of 0. Maximum value of 31622400.

Required: No

Expression

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: