software.amazon.awscdk.services.events

Class Schedule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.Schedule

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.314Z")
 @Stability(value=Stable)
public abstract class Schedule
extends software.amazon.jsii.JsiiObject

Schedule for scheduled event rules.

Note that rates cannot be defined in fractions of minutes.

Example:

 Connection connection = Connection.Builder.create(this, "Connection")
         .authorization(Authorization.apiKey("x-api-key", SecretValue.secretsManager("ApiSecretName")))
         .description("Connection with API Key x-api-key")
         .build();
 ApiDestination destination = ApiDestination.Builder.create(this, "Destination")
         .connection(connection)
         .endpoint("https://example.com")
         .description("Calling example.com with API key x-api-key")
         .build();
 Rule rule = Rule.Builder.create(this, "Rule")
         .schedule(Schedule.rate(Duration.minutes(1)))
         .targets(List.of(new ApiDestination(destination)))
         .build();
 

See Also:

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

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()
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) Create a schedule from a set of cron fields.
static Schedule	expression(String expression) Construct a schedule from a literal schedule expression.
abstract String	getExpressionString() Retrieve the expression for this schedule.
static Schedule	rate(Duration duration) Construct a schedule from an interval and a time unit.

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)

Schedule

@Stability(value=Stable)
protected Schedule()

Method Detail

cron

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

Create a schedule from a set of cron fields.

Parameters:

options - This parameter is required.

expression

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

Construct a schedule from a literal schedule expression.

Parameters:

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

rate

@Stability(value=Stable)
 @NotNull
public static Schedule rate(@NotNull
                                                               Duration duration)

Construct a schedule from an interval and a time unit.

Rates may be defined with any unit of time, but when converted into minutes, the duration must be a positive whole number of minutes.

Parameters:

duration - This parameter is required.

getExpressionString

@Stability(value=Stable)
 @NotNull
public abstract String getExpressionString()

Retrieve the expression for this schedule.