# EventBridgeSchedulerCreateScheduleTaskProps

Properties for creating an AWS EventBridge Scheduler schedule.

Extends: EventBridgeSchedulerCreateScheduleTaskProps
Extends: TaskStateBaseProps
Used as props by: EventBridgeSchedulerCreateScheduleTask

- Source: [`aws-stepfunctions-tasks/lib/eventbridge-scheduler/create-schedule.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/eventbridge-scheduler/create-schedule.ts#L138)
- Type last changed: v2.168.0 · 20 Nov 2024

## Example

```ts
import * as scheduler from 'aws-cdk-lib/aws-scheduler';
import * as kms from 'aws-cdk-lib/aws-kms';

declare const key: kms.Key;
declare const scheduleGroup: scheduler.CfnScheduleGroup;
declare const targetQueue: sqs.Queue;
declare const deadLetterQueue: sqs.Queue;

const schedulerRole = new iam.Role(this, 'SchedulerRole', {
  assumedBy: new iam.ServicePrincipal('scheduler.amazonaws.com'),
});
// To send the message to the queue
// This policy changes depending on the type of target.
schedulerRole.addToPrincipalPolicy(new iam.PolicyStatement({
  actions: ['sqs:SendMessage'],
  resources: [targetQueue.queueArn],
}));

const createScheduleTask1 = new tasks.EventBridgeSchedulerCreateScheduleTask(this, 'createSchedule', {
  scheduleName: 'TestSchedule',
  actionAfterCompletion: tasks.ActionAfterCompletion.NONE,
  clientToken: 'testToken',
  description: 'TestDescription',
  startDate: new Date(),
  endDate: new Date(new Date().getTime() + 1000 * 60 * 60),
  flexibleTimeWindow: Duration.minutes(5),
  groupName: scheduleGroup.ref,
  kmsKey: key,
  schedule: tasks.Schedule.rate(Duration.minutes(5)),
  timezone: 'UTC',
  enabled: true,
  target: new tasks.EventBridgeSchedulerTarget({
    arn: targetQueue.queueArn,
    role: schedulerRole,
    retryPolicy: {
      maximumRetryAttempts: 2,
      maximumEventAge: Duration.minutes(5),
    },
    deadLetterQueue,
  }),
});
```

## Properties

- `actionAfterCompletion`: [ActionAfterCompletion](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.ActionAfterCompletion.html) = ActionAfterCompletion.NONE — Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

- `assign`: { [key: string]: any } — 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.

- `clientToken`: string — Unique, case-sensitive identifier to ensure the idempotency of the request.

  **Default:** Automatically generated

- `comment`: string — A comment describing this state.

  **Default:** No comment

- `credentials`: [Credentials](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Credentials.html) — 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.

- `description`: string — The description for the schedule.

  **Default:** No description

- `enabled`: boolean = true — Specifies whether the schedule is enabled or disabled.

- `endDate`: date — 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.

- `flexibleTimeWindow`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — 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).

- `groupName`: string — The name of the schedule group to associate with this schedule.

  **Default:** The default schedule group is used.

- `heartbeat`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `heartbeatTimeout`

- `heartbeatTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the heartbeat.

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

- `inputPath`: 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 {}.

- `integrationPattern`: [IntegrationPattern](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.IntegrationPattern.html) — 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.

- `kmsKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt payload.

  **Default:** Use automatically generated KMS key

- `outputPath`: 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 {}.

- `outputs`: any — Used to specify and transform output from the state.

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

  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.

- `queryLanguage`: [QueryLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.QueryLanguage.html) = 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.

- `resultPath`: 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.

- `resultSelector`: { [key: string]: any } = 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.

- `schedule`: [Schedule](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.Schedule.html) (required) — The schedule that defines when the schedule will trigger.

- `scheduleName`: string (required) — Schedule name.

- `startDate`: date — 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.

- `stateName`: string — Optional name for this state.

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

- `target`: [EventBridgeSchedulerTarget](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.EventBridgeSchedulerTarget.html) (required) — The schedule's target.

- `taskTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the task.

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

- `timeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `taskTimeout`

- `timezone`: string = UTC — The timezone in which the scheduling expression is evaluated.