Class EventBridgeSchedulerCreateScheduleTask
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.stepfunctions.State
software.amazon.awscdk.services.stepfunctions.TaskStateBase
software.amazon.awscdk.services.stepfunctions.tasks.EventBridgeSchedulerCreateScheduleTask
- All Implemented Interfaces:
IChainable,INextable,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-13T16:10:15.348Z")
@Stability(Stable)
public class EventBridgeSchedulerCreateScheduleTask
extends TaskStateBase
Create a new AWS EventBridge Scheduler schedule.
Example:
import software.amazon.awscdk.services.scheduler.*;
import software.amazon.awscdk.services.kms.*;
Key key;
CfnScheduleGroup scheduleGroup;
Queue targetQueue;
Queue deadLetterQueue;
Role schedulerRole = Role.Builder.create(this, "SchedulerRole")
.assumedBy(new ServicePrincipal("scheduler.amazonaws.com"))
.build();
// To send the message to the queue
// This policy changes depending on the type of target.
schedulerRole.addToPrincipalPolicy(PolicyStatement.Builder.create()
.actions(List.of("sqs:SendMessage"))
.resources(List.of(targetQueue.getQueueArn()))
.build());
EventBridgeSchedulerCreateScheduleTask createScheduleTask1 = EventBridgeSchedulerCreateScheduleTask.Builder.create(this, "createSchedule")
.scheduleName("TestSchedule")
.actionAfterCompletion(ActionAfterCompletion.NONE)
.clientToken("testToken")
.description("TestDescription")
.startDate(new Date())
.endDate(new Date(new Date().getTime() + 1000 * 60 * 60))
.flexibleTimeWindow(Duration.minutes(5))
.groupName(scheduleGroup.getRef())
.kmsKey(key)
.schedule(Schedule.rate(Duration.minutes(5)))
.timezone("UTC")
.enabled(true)
.target(EventBridgeSchedulerTarget.Builder.create()
.arn(targetQueue.getQueueArn())
.role(schedulerRole)
.retryPolicy(RetryPolicy.builder()
.maximumRetryAttempts(2)
.maximumEventAge(Duration.minutes(5))
.build())
.deadLetterQueue(deadLetterQueue)
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forEventBridgeSchedulerCreateScheduleTask.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable
IChainable.Jsii$DefaultNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable
INextable.Jsii$Default -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedEventBridgeSchedulerCreateScheduleTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedEventBridgeSchedulerCreateScheduleTask(software.amazon.jsii.JsiiObjectRef objRef) EventBridgeSchedulerCreateScheduleTask(software.constructs.Construct scope, String id, EventBridgeSchedulerCreateScheduleTaskProps props) -
Method Summary
Modifier and TypeMethodDescriptionprotected TaskMetricsConfigprotected List<PolicyStatement> jsonata(software.constructs.Construct scope, String id, EventBridgeSchedulerCreateScheduleTaskJsonataProps props) Create an AWS EventBridge Scheduler schedule using JSONata.jsonPath(software.constructs.Construct scope, String id, EventBridgeSchedulerCreateScheduleTaskJsonPathProps props) Create an AWS EventBridge Scheduler schedule using JSONPath.Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase
addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, toStateJson, whenBoundToGraphMethods inherited from class software.amazon.awscdk.services.stepfunctions.State
addBranch, addChoice, addChoice, addItemProcessor, addItemProcessor, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getArguments, getAssign, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getOutputs, getParameters, getProcessor, getProcessorConfig, getProcessorMode, getQueryLanguage, getResultPath, getResultSelector, getStartState, getStateId, getStateName, makeDefault, makeNext, prefixStates, renderAssign, renderAssign, renderBranches, renderChoices, renderChoices, renderInputOutput, renderItemProcessor, renderIterator, renderNextEnd, renderQueryLanguage, renderQueryLanguage, renderResultSelector, renderRetryCatch, renderRetryCatch, setDefaultChoice, setIteration, setProcessor, setProcessorConfig, setProcessorMode, validateStateMethods inherited from class software.constructs.Construct
getNode, isConstruct, toStringMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
EventBridgeSchedulerCreateScheduleTask
protected EventBridgeSchedulerCreateScheduleTask(software.amazon.jsii.JsiiObjectRef objRef) -
EventBridgeSchedulerCreateScheduleTask
protected EventBridgeSchedulerCreateScheduleTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
EventBridgeSchedulerCreateScheduleTask
@Stability(Stable) public EventBridgeSchedulerCreateScheduleTask(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull EventBridgeSchedulerCreateScheduleTaskProps props) - Parameters:
scope- This parameter is required.id- Descriptive identifier for this chainable. This parameter is required.props- This parameter is required.
-
-
Method Details
-
jsonata
@Stability(Stable) @NotNull public static EventBridgeSchedulerCreateScheduleTask jsonata(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull EventBridgeSchedulerCreateScheduleTaskJsonataProps props) Create an AWS EventBridge Scheduler schedule using JSONata.- Parameters:
scope- This parameter is required.id- This parameter is required.props- This parameter is required.
-
jsonPath
@Stability(Stable) @NotNull public static EventBridgeSchedulerCreateScheduleTask jsonPath(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull EventBridgeSchedulerCreateScheduleTaskJsonPathProps props) Create an AWS EventBridge Scheduler schedule using JSONPath.- Parameters:
scope- This parameter is required.id- This parameter is required.props- This parameter is required.
-
getTaskMetrics
- Specified by:
getTaskMetricsin classTaskStateBase
-
getTaskPolicies
- Specified by:
getTaskPoliciesin classTaskStateBase
-