AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::Synthetics::Model::CanaryScheduleInput Class Reference

#include <CanaryScheduleInput.h>

Public Member Functions

 CanaryScheduleInput ()
 
 CanaryScheduleInput (Aws::Utils::Json::JsonView jsonValue)
 
CanaryScheduleInputoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetExpression () const
 
bool ExpressionHasBeenSet () const
 
void SetExpression (const Aws::String &value)
 
void SetExpression (Aws::String &&value)
 
void SetExpression (const char *value)
 
CanaryScheduleInputWithExpression (const Aws::String &value)
 
CanaryScheduleInputWithExpression (Aws::String &&value)
 
CanaryScheduleInputWithExpression (const char *value)
 
long long GetDurationInSeconds () const
 
bool DurationInSecondsHasBeenSet () const
 
void SetDurationInSeconds (long long value)
 
CanaryScheduleInputWithDurationInSeconds (long long value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 32 of file CanaryScheduleInput.h.

Constructor & Destructor Documentation

◆ CanaryScheduleInput() [1/2]

Aws::Synthetics::Model::CanaryScheduleInput::CanaryScheduleInput ( )

◆ CanaryScheduleInput() [2/2]

Aws::Synthetics::Model::CanaryScheduleInput::CanaryScheduleInput ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DurationInSecondsHasBeenSet()

bool Aws::Synthetics::Model::CanaryScheduleInput::DurationInSecondsHasBeenSet ( ) const
inline

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.

Definition at line 200 of file CanaryScheduleInput.h.

◆ ExpressionHasBeenSet()

bool Aws::Synthetics::Model::CanaryScheduleInput::ExpressionHasBeenSet ( ) const
inline

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.

Definition at line 75 of file CanaryScheduleInput.h.

◆ GetDurationInSeconds()

long long Aws::Synthetics::Model::CanaryScheduleInput::GetDurationInSeconds ( ) const
inline

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.

Definition at line 192 of file CanaryScheduleInput.h.

◆ GetExpression()

const Aws::String& Aws::Synthetics::Model::CanaryScheduleInput::GetExpression ( ) const
inline

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.

Definition at line 57 of file CanaryScheduleInput.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Synthetics::Model::CanaryScheduleInput::Jsonize ( ) const

◆ operator=()

CanaryScheduleInput& Aws::Synthetics::Model::CanaryScheduleInput::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDurationInSeconds()

void Aws::Synthetics::Model::CanaryScheduleInput::SetDurationInSeconds ( long long  value)
inline

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.

Definition at line 208 of file CanaryScheduleInput.h.

◆ SetExpression() [1/3]

void Aws::Synthetics::Model::CanaryScheduleInput::SetExpression ( Aws::String &&  value)
inline

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.

Definition at line 111 of file CanaryScheduleInput.h.

◆ SetExpression() [2/3]

void Aws::Synthetics::Model::CanaryScheduleInput::SetExpression ( const Aws::String value)
inline

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.

Definition at line 93 of file CanaryScheduleInput.h.

◆ SetExpression() [3/3]

void Aws::Synthetics::Model::CanaryScheduleInput::SetExpression ( const char *  value)
inline

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.

Definition at line 129 of file CanaryScheduleInput.h.

◆ WithDurationInSeconds()

CanaryScheduleInput& Aws::Synthetics::Model::CanaryScheduleInput::WithDurationInSeconds ( long long  value)
inline

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.

Definition at line 216 of file CanaryScheduleInput.h.

◆ WithExpression() [1/3]

CanaryScheduleInput& Aws::Synthetics::Model::CanaryScheduleInput::WithExpression ( Aws::String &&  value)
inline

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.

Definition at line 165 of file CanaryScheduleInput.h.

◆ WithExpression() [2/3]

CanaryScheduleInput& Aws::Synthetics::Model::CanaryScheduleInput::WithExpression ( const Aws::String value)
inline

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.

Definition at line 147 of file CanaryScheduleInput.h.

◆ WithExpression() [3/3]

CanaryScheduleInput& Aws::Synthetics::Model::CanaryScheduleInput::WithExpression ( const char *  value)
inline

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.

Definition at line 183 of file CanaryScheduleInput.h.


The documentation for this class was generated from the following file: