AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

EventBridgeSchedulerCreateScheduleTask

Create a new AWS EventBridge Scheduler schedule.

Import

import { EventBridgeSchedulerCreateScheduleTask } from 'aws-cdk-lib/aws-stepfunctions-tasks';

Or use the module namespace:

import * as stepfunctions_tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';
// stepfunctions_tasks.EventBridgeSchedulerCreateScheduleTask

Properties

Configuration passed to the constructor as EventBridgeSchedulerCreateScheduleTaskProps.

scheduleRequired
Schedule

The schedule that defines when the schedule will trigger.

scheduleNameRequired
string

Schedule name.

targetRequired
EventBridgeSchedulerTarget

The schedule's target.

actionAfterCompletionOptional
ActionAfterCompletion

Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

Default: ActionAfterCompletion.NONE

clientTokenOptional
string

Unique, case-sensitive identifier to ensure the idempotency of the request.

Default: - Automatically generated

descriptionOptional
string

The description for the schedule.

Default: - No description

enabledOptional
boolean

Specifies whether the schedule is enabled or disabled.

Default: true

endDateOptional
date

The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

Default: - No end date

flexibleTimeWindowOptional
Duration

The maximum time window during which a schedule can be invoked. Minimum value is 1 minute. Maximum value is 1440 minutes (1 day).

Default: - Flexible time window is not enabled.

groupNameOptional
string

The name of the schedule group to associate with this schedule.

Default: - The default schedule group is used.

kmsKeyOptional
IKey

The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt payload.

Default: - Use automatically generated KMS key

startDateOptional
date

The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

Default: - No start date

timezoneOptional
string

The timezone in which the scheduling expression is evaluated.

Default: - UTC

2 properties inherited from TaskStateBaseProps
resultPathOptionalinherited from TaskStateBaseProps
string

JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Default: $

resultSelectorOptionalinherited from TaskStateBaseProps
{ [key: string]: any }

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Default: - None

3 properties inherited from StateBaseProps
commentOptionalinherited from StateBaseProps
string

A comment describing this state.

Default: No comment

queryLanguageOptionalinherited from StateBaseProps
QueryLanguage

The name of the query language used by the state. If the state does not contain a `queryLanguage` field, then it will use the query language specified in the top-level `queryLanguage` field.

Default: - JSONPath

stateNameOptionalinherited from StateBaseProps
string

Optional name for this state.

Default: - The construct ID will be used as state name

6 properties inherited from TaskStateBaseOptions
credentialsOptionalinherited from TaskStateBaseOptions
Credentials

Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Default: - None (Task is executed using the State Machine's execution role)

heartbeatOptionalDeprecatedinherited from TaskStateBaseOptions
Duration

Timeout for the heartbeat.

Default: - None

Deprecated: use `heartbeatTimeout`

heartbeatTimeoutOptionalinherited from TaskStateBaseOptions
Timeout

Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

integrationPatternOptionalinherited from TaskStateBaseOptions
IntegrationPattern

AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns. Depending on the AWS Service, the Service Integration Pattern availability will vary.

Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

taskTimeoutOptionalinherited from TaskStateBaseOptions
Timeout

Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

timeoutOptionalDeprecatedinherited from TaskStateBaseOptions
Duration

Timeout for the task.

Default: - None

Deprecated: use `taskTimeout`

1 property inherited from AssignableStateOptions
assignOptionalinherited from AssignableStateOptions
{ [key: string]: any }

Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

2 properties inherited from JsonPathCommonOptions
inputPathOptionalinherited from JsonPathCommonOptions
string

JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default: $

outputPathOptionalinherited from JsonPathCommonOptions
string

JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: $

1 property inherited from JsonataCommonOptions
outputsOptionalinherited from JsonataCommonOptions
any

Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL2 (Higher-level)
Moduleaws-stepfunctions-tasks
Properties28

Related Constructs

External Links