Class CronOptions

Options to configure a cron expression.

Inheritance
System.Object
CronOptions
Implements
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CronOptions : Object, ICronOptions
Syntax (vb)
Public Class CronOptions
    Inherits Object
    Implements ICronOptions
Remarks

All fields are strings so you can use complex expressions. Absence of a field implies '*' or '?', whichever one is appropriate.

See: https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.Events;
using Amazon.CDK.AWS.Events.Targets;

Function fn;

var rule = new Rule(this, "Schedule Rule", new RuleProps {
    Schedule = Schedule.Cron(new CronOptions { Minute = "0", Hour = "4" })
});
rule.AddTarget(new LambdaFunction(fn));

Synopsis

Constructors

CronOptions()

Properties

Day

The day of the month to run this rule at.
Hour

The hour to run this rule at.
Minute

The minute to run this rule at.
Month

The month to run this rule at.
WeekDay

The day of the week to run this rule at.
Year

The year to run this rule at.

Constructors

CronOptions()

public CronOptions()

Properties

Day

The day of the month to run this rule at.

public string Day { get; set; }
Property Value

System.String

Remarks

Default: - Every day of the month

Hour

The hour to run this rule at.

public string Hour { get; set; }
Property Value

System.String

Remarks

Default: - Every hour

Minute

The minute to run this rule at.

public string Minute { get; set; }
Property Value

System.String

Remarks

Default: - Every minute

Month

The month to run this rule at.

public string Month { get; set; }
Property Value

System.String

Remarks

Default: - Every month

WeekDay

The day of the week to run this rule at.

public string WeekDay { get; set; }
Property Value

System.String

Remarks

Default: - Any day of the week

Year

The year to run this rule at.

public string Year { get; set; }
Property Value

System.String

Remarks

Default: - Every year

Implements