Package software.amazon.awssdk.services.synthetics.model

Interface CanaryScheduleOutput.Builder

    • Method Detail

      • expression

        CanaryScheduleOutput.Builder expression​(String 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. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

        Parameters:
        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. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • durationInSeconds

        CanaryScheduleOutput.Builder durationInSeconds​(Long 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.