software.amazon.awscdk.services.events

Interface CronOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CronOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:30.851Z")
 @Stability(value=Experimental)
public interface CronOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) 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.core.*;
 import software.amazon.awscdk.core.*;
 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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CronOptions.Builder A builder for CronOptions
static class	CronOptions.Jsii$Proxy An implementation for CronOptions

Method Summary

Modifier and Type	Method and Description
static CronOptions.Builder	builder()
default String	getDay() (experimental) The day of the month to run this rule at.
default String	getHour() (experimental) The hour to run this rule at.
default String	getMinute() (experimental) The minute to run this rule at.
default String	getMonth() (experimental) The month to run this rule at.
default String	getWeekDay() (experimental) The day of the week to run this rule at.
default String	getYear() (experimental) The year to run this rule at.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDay

@Stability(value=Experimental)
 @Nullable
default String getDay()

(experimental) The day of the month to run this rule at.

Default: - Every day of the month

getHour

@Stability(value=Experimental)
 @Nullable
default String getHour()

(experimental) The hour to run this rule at.

Default: - Every hour

getMinute

@Stability(value=Experimental)
 @Nullable
default String getMinute()

(experimental) The minute to run this rule at.

Default: - Every minute

getMonth

@Stability(value=Experimental)
 @Nullable
default String getMonth()

(experimental) The month to run this rule at.

Default: - Every month

getWeekDay

@Stability(value=Experimental)
 @Nullable
default String getWeekDay()

(experimental) The day of the week to run this rule at.

Default: - Any day of the week

getYear

@Stability(value=Experimental)
 @Nullable
default String getYear()

(experimental) The year to run this rule at.

Default: - Every year

builder

@Stability(value=Experimental)
static CronOptions.Builder builder()

Returns:

a CronOptions.Builder of CronOptions