AWS CDK Reference

Appearance

v2.274.0

EventBridgeSchedulerCreateScheduleTaskJsonPathProps Struct ​

Properties for creating an AWS EventBridge Scheduler schedule using JSONPath.

Source
aws-stepfunctions-tasks/lib/eventbridge-scheduler/create-schedule.ts
Type last changed
v2.178.0 · 6 Feb 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const eventBridgeSchedulerTarget: stepfunctions_tasks.EventBridgeSchedulerTarget;
declare const key: kms.Key;
declare const resultSelector: any;
declare const schedule: stepfunctions_tasks.Schedule;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const eventBridgeSchedulerCreateScheduleTaskJsonPathProps: stepfunctions_tasks.EventBridgeSchedulerCreateScheduleTaskJsonPathProps = {
  schedule: schedule,
  scheduleName: 'scheduleName',
  target: eventBridgeSchedulerTarget,

  // the properties below are optional
  actionAfterCompletion: stepfunctions_tasks.ActionAfterCompletion.NONE,
  assign: {
    assignKey: assign,
  },
  clientToken: 'clientToken',
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  description: 'description',
  enabled: false,
  endDate: new Date(),
  flexibleTimeWindow: cdk.Duration.minutes(30),
  groupName: 'groupName',
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  kmsKey: key,
  outputPath: 'outputPath',
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  startDate: new Date(),
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
  timezone: 'timezone',
};

Properties ​

actionAfterCompletionoptionalActionAfterCompletionaction_after_completionoptionalActionAfterCompletionactionAfterCompletionoptionalActionAfterCompletionActionAfterCompletionoptionalActionAfterCompletionActionAfterCompletionoptionalActionAfterCompletion= ActionAfterCompletion.NONE#
Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#
Workflow variables to store in this step.

Default: Not assign variables

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

clientTokenoptionalstringclient_tokenoptionalstrclientTokenoptionalStringClientTokenoptionalstringClientTokenoptional*string#
Unique, case-sensitive identifier to ensure the idempotency of the request.

Default: Automatically generated

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#
A comment describing this state.

Default: No comment

credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#
Credentials for an IAM Role that the State Machine assumes for executing the task.

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

This enables cross-account resource invocations.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description for the schedule.

Default: No description

enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#
Specifies whether the schedule is enabled or disabled.
endDateoptionaldateend_dateoptionaldatetimeendDateoptionalInstantEndDateoptionalDateTimeEndDateoptional*time.Time#
The date, in UTC, before which the schedule can invoke its target.

Default: No end date

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.

flexibleTimeWindowoptionalDurationflexible_time_windowoptionalDurationflexibleTimeWindowoptionalDurationFlexibleTimeWindowoptionalDurationFlexibleTimeWindowoptionalDuration#
The maximum time window during which a schedule can be invoked.

Default: Flexible time window is not enabled.

Minimum value is 1 minute. Maximum value is 1440 minutes (1 day).

groupNameoptionalstringgroup_nameoptionalstrgroupNameoptionalStringGroupNameoptionalstringGroupNameoptional*string#
The name of the schedule group to associate with this schedule.

Default: The default schedule group is used.

heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#
use `heartbeatTimeout`
heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout= None#
Timeout for the heartbeat.

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

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*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 {}.

integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern#
AWS Step Functions integrates with services directly in the Amazon States Language.

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

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

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

Default: Use automatically generated KMS key

outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*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 {}.

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSONPath#
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.

resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*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.

resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{}= None#
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.

scheduleSchedulescheduleSchedulescheduleScheduleScheduleScheduleScheduleSchedulerequired#
The schedule that defines when the schedule will trigger.
scheduleNamestringschedule_namestrscheduleNameStringScheduleNamestringScheduleName*stringrequired#
Schedule name.
startDateoptionaldatestart_dateoptionaldatetimestartDateoptionalInstantStartDateoptionalDateTimeStartDateoptional*time.Time#
The date, in UTC, after which the schedule can begin invoking its target.

Default: No start date

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.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#
Optional name for this state.

Default: The construct ID will be used as state name

taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout= None#
Timeout for the task.

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

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Nonedeprecated#
use `taskTimeout`
timezoneoptionalstringtimezoneoptionalstrtimezoneoptionalStringTimezoneoptionalstringTimezoneoptional*string= UTC#
The timezone in which the scheduling expression is evaluated.