@aws-cdk_aws-synthetics-alpha.Schedule

class Schedule ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Synthetics.Alpha.Schedule
Gogithub.com/aws/aws-cdk-go/awscdksyntheticsalpha/v2#Schedule
Javasoftware.amazon.awscdk.services.synthetics.alpha.Schedule
Pythonaws_cdk.aws_synthetics_alpha.Schedule
TypeScript (source)@aws-cdk/aws-synthetics-alpha ยป Schedule

Schedule for canary runs.

Example

const schedule = synthetics.Schedule.rate(Duration.minutes(5)); // Runs every 5 minutes.

Properties

NameTypeDescription
expressionString๐Ÿ”นstringThe Schedule expression.

expressionString๐Ÿ”น

Type: string

The Schedule expression.

Methods

NameDescription
static cron(options)๐Ÿ”นCreate a schedule from a set of cron fields.
static expression(expression)๐Ÿ”นConstruct a schedule from a literal schedule expression.
static once()๐Ÿ”นThe canary will be executed once.
static rate(interval)๐Ÿ”นConstruct a schedule from an interval.

static cron(options)๐Ÿ”น

public static cron(options: CronOptions): Schedule

Parameters

  • options CronOptions

Returns

  • Schedule

Create a schedule from a set of cron fields.


static expression(expression)๐Ÿ”น

public static expression(expression: string): Schedule

Parameters

  • expression string โ€” The expression to use.

Returns

  • Schedule

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)')


static once()๐Ÿ”น

public static once(): Schedule

Returns

  • Schedule

The canary will be executed once.


static rate(interval)๐Ÿ”น

public static rate(interval: Duration): Schedule

Parameters

  • interval Duration โ€” The interval at which to run the canary.

Returns

  • Schedule

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().