Amazonka.Synthetics.Types.CanaryScheduleOutput

Documentation

data CanaryScheduleOutput

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

See: newCanaryScheduleOutput smart constructor.

Constructors

CanaryScheduleOutput'

Fields

• durationInSeconds :: Maybe Natural

  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.

• expression :: Maybe Text

  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.

Instances

FromJSON CanaryScheduleOutput

Defined in Amazonka.Synthetics.Types.CanaryScheduleOutput

Methods

parseJSON :: Value -> Parser CanaryScheduleOutput

parseJSONList :: Value -> Parser [CanaryScheduleOutput]

Generic CanaryScheduleOutput

Defined in Amazonka.Synthetics.Types.CanaryScheduleOutput

Associated Types

type Rep CanaryScheduleOutput :: Type -> Type

Methods

from :: CanaryScheduleOutput -> Rep CanaryScheduleOutput x

to :: Rep CanaryScheduleOutput x -> CanaryScheduleOutput

Read CanaryScheduleOutput

Defined in Amazonka.Synthetics.Types.CanaryScheduleOutput

Methods

readsPrec :: Int -> ReadS CanaryScheduleOutput

readList :: ReadS [CanaryScheduleOutput]

readPrec :: ReadPrec CanaryScheduleOutput

readListPrec :: ReadPrec [CanaryScheduleOutput]

Show CanaryScheduleOutput

Defined in Amazonka.Synthetics.Types.CanaryScheduleOutput

Methods

showsPrec :: Int -> CanaryScheduleOutput -> ShowS

show :: CanaryScheduleOutput -> String

showList :: [CanaryScheduleOutput] -> ShowS

NFData CanaryScheduleOutput

Defined in Amazonka.Synthetics.Types.CanaryScheduleOutput

Methods

rnf :: CanaryScheduleOutput -> ()

Eq CanaryScheduleOutput

Defined in Amazonka.Synthetics.Types.CanaryScheduleOutput

Methods

(==) :: CanaryScheduleOutput -> CanaryScheduleOutput -> Bool

(/=) :: CanaryScheduleOutput -> CanaryScheduleOutput -> Bool

Hashable CanaryScheduleOutput

Defined in Amazonka.Synthetics.Types.CanaryScheduleOutput

Methods

hashWithSalt :: Int -> CanaryScheduleOutput -> Int

hash :: CanaryScheduleOutput -> Int

type Rep CanaryScheduleOutput

Defined in Amazonka.Synthetics.Types.CanaryScheduleOutput

type Rep CanaryScheduleOutput = D1 ('MetaData "CanaryScheduleOutput" "Amazonka.Synthetics.Types.CanaryScheduleOutput" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "CanaryScheduleOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "durationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newCanaryScheduleOutput :: CanaryScheduleOutput

Create a value of CanaryScheduleOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:durationInSeconds:CanaryScheduleOutput', canaryScheduleOutput_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.

$sel:expression:CanaryScheduleOutput', canaryScheduleOutput_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.

canaryScheduleOutput_durationInSeconds :: Lens' CanaryScheduleOutput (Maybe Natural)

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.

canaryScheduleOutput_expression :: Lens' CanaryScheduleOutput (Maybe Text)

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.