Interface CronOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
CronOptionsWithTimezone
All Known Implementing Classes:
CronOptions.Jsii$Proxy, CronOptionsWithTimezone.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:02.226Z") @Stability(Stable) public interface CronOptions extends software.amazon.jsii.JsiiSerializable
Options to configure a cron expression.

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

Example:

 import software.amazon.awscdk.services.events.*;
 import software.amazon.awscdk.services.events.targets.*;
 Function fn;
 Rule rule = Rule.Builder.create(this, "Schedule Rule")
         .schedule(Schedule.cron(CronOptions.builder().minute("0").hour("4").build()))
         .build();
 rule.addTarget(new LambdaFunction(fn));
 

See Also:
  • Method Details

    • getDay

      @Stability(Stable) @Nullable default String getDay()
      The day of the month to run this rule at.

      Default: - Every day of the month

    • getHour

      @Stability(Stable) @Nullable default String getHour()
      The hour to run this rule at.

      Default: - Every hour

    • getMinute

      @Stability(Stable) @Nullable default String getMinute()
      The minute to run this rule at.

      Default: - Every minute

    • getMonth

      @Stability(Stable) @Nullable default String getMonth()
      The month to run this rule at.

      Default: - Every month

    • getWeekDay

      @Stability(Stable) @Nullable default String getWeekDay()
      The day of the week to run this rule at.

      Default: - Any day of the week

    • getYear

      @Stability(Stable) @Nullable default String getYear()
      The year to run this rule at.

      Default: - Every year

    • builder

      @Stability(Stable) static CronOptions.Builder builder()
      Returns:
      a CronOptions.Builder of CronOptions