software.amazon.awscdk.services.synthetics.alpha

Class Schedule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.synthetics.alpha.Schedule

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-09T02:01:26.363Z")
 @Stability(value=Experimental)
public class Schedule
extends software.amazon.jsii.JsiiObject

(experimental) Schedule for canary runs.

Example:

 Schedule schedule = Schedule.rate(Duration.minutes(5));
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Schedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Schedule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static Schedule	cron(CronOptions options) (experimental) Create a schedule from a set of cron fields.
static Schedule	expression(String expression) (experimental) Construct a schedule from a literal schedule expression.
String	getExpressionString() (experimental) The Schedule expression.
static Schedule	once() (experimental) The canary will be executed once.
static Schedule	rate(Duration interval) (experimental) Construct a schedule from an interval.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Schedule

protected Schedule(software.amazon.jsii.JsiiObjectRef objRef)

Schedule

protected Schedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

cron

@Stability(value=Experimental)
 @NotNull
public static Schedule cron(@NotNull
                                                                     CronOptions options)

(experimental) Create a schedule from a set of cron fields.

Parameters:

options - This parameter is required.

expression

@Stability(value=Experimental)
 @NotNull
public static Schedule expression(@NotNull
                                                                           String expression)

(experimental) Construct a schedule from a literal schedule expression.

The expression must be in a rate(number units) format. For example, Schedule.expression('rate(10 minutes)')

Parameters:

expression - The expression to use. This parameter is required.

once

@Stability(value=Experimental)
 @NotNull
public static Schedule once()

(experimental) The canary will be executed once.

rate

@Stability(value=Experimental)
 @NotNull
public static Schedule rate(@NotNull
                                                                     Duration interval)

(experimental) Construct a schedule from an interval.

Allowed values: 0 (for a single run) or between 1 and 60 minutes. To specify a single run, you can use Schedule.once().

Parameters:

interval - The interval at which to run the canary. This parameter is required.

getExpressionString

@Stability(value=Experimental)
 @NotNull
public String getExpressionString()

(experimental) The Schedule expression.