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

#include <CanaryScheduleOutput.h>

Public Member Functions

 CanaryScheduleOutput ()
 
 CanaryScheduleOutput (Aws::Utils::Json::JsonView jsonValue)
 
CanaryScheduleOutputoperator= (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)
 
CanaryScheduleOutputWithExpression (const Aws::String &value)
 
CanaryScheduleOutputWithExpression (Aws::String &&value)
 
CanaryScheduleOutputWithExpression (const char *value)
 
long long GetDurationInSeconds () const
 
bool DurationInSecondsHasBeenSet () const
 
void SetDurationInSeconds (long long value)
 
CanaryScheduleOutputWithDurationInSeconds (long long value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 33 of file CanaryScheduleOutput.h.

Constructor & Destructor Documentation

◆ CanaryScheduleOutput() [1/2]

Aws::Synthetics::Model::CanaryScheduleOutput::CanaryScheduleOutput ( )

◆ CanaryScheduleOutput() [2/2]

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

Member Function Documentation

◆ DurationInSecondsHasBeenSet()

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

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.

Definition at line 191 of file CanaryScheduleOutput.h.

◆ ExpressionHasBeenSet()

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

Definition at line 74 of file CanaryScheduleOutput.h.

◆ GetDurationInSeconds()

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

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.

Definition at line 184 of file CanaryScheduleOutput.h.

◆ GetExpression()

const Aws::String& Aws::Synthetics::Model::CanaryScheduleOutput::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. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

Definition at line 57 of file CanaryScheduleOutput.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetDurationInSeconds()

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

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.

Definition at line 198 of file CanaryScheduleOutput.h.

◆ SetExpression() [1/3]

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

Definition at line 108 of file CanaryScheduleOutput.h.

◆ SetExpression() [2/3]

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

Definition at line 91 of file CanaryScheduleOutput.h.

◆ SetExpression() [3/3]

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

Definition at line 125 of file CanaryScheduleOutput.h.

◆ WithDurationInSeconds()

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

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.

Definition at line 205 of file CanaryScheduleOutput.h.

◆ WithExpression() [1/3]

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

Definition at line 159 of file CanaryScheduleOutput.h.

◆ WithExpression() [2/3]

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

Definition at line 142 of file CanaryScheduleOutput.h.

◆ WithExpression() [3/3]

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

Definition at line 176 of file CanaryScheduleOutput.h.


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