AwsEventbridgeSchedulerArgs

interface AwsEventbridgeSchedulerArgs extends Omit<aws.scheduler.ScheduleArgs, 'name' | 'groupName'> {
actionAfterCompletion?: Input<string | undefined>;
description?: Input<string | undefined>;
endDate?: Input<string | undefined>;
flexibleTimeWindow: Input<ScheduleFlexibleTimeWindow>;
groupName?: Input<string>;
kmsKeyArn?: Input<string | undefined>;
name: string;
namePrefix?: Input<string | undefined>;
region?: Input<string | undefined>;
scheduleExpression: Input<string>;
scheduleExpressionTimezone?: Input<string | undefined>;
startDate?: Input<string | undefined>;
state?: Input<string | undefined>;
target: Input<ScheduleTarget>;
}

Input arguments for AwsEventbridgeScheduler.

Remarks

Maps directly to aws.scheduler.ScheduleArgs. Naming is deterministic:

Pulumi logical name: ${environmentCode}-${projectHash}-eventbridge-scheduler-${sanitisedName} from args.name.
AWS provider schedule name: derived explicitly from args.name via the naming-style prefix pattern.

Example

CODE

const schedule = new AwsEventbridgeScheduler({
  name: 'hourlySync',
  scheduleExpression: 'rate(1 hours)',
  flexibleTimeWindow: { mode: 'OFF' },
  target: {
    arn: myQueue.arn,
    roleArn: 'eventbridge-scheduler-role-name',
  },
});

Hierarchy

ScheduleArgs, "name" | "groupName">
AwsEventbridgeSchedulerArgs

Properties

`actionAfterCompletion: Input<string | undefined>`

Inherited from actionAfterCompletion

Action that applies to the schedule after completing invocation of the target. Valid values are NONE and DELETE. Defaults to NONE.

`description: Input<string | undefined>`

Inherited from description

Brief description of the schedule.

`endDate: Input<string | undefined>`

Inherited from endDate

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 end date you specify. EventBridge Scheduler ignores the end date for one-time schedules. Example: 2030-01-01T01:00:00Z.

`flexibleTimeWindow: Input<ScheduleFlexibleTimeWindow>`

Inherited from flexibleTimeWindow

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

`groupName: Input<string>`

Optional existing EventBridge schedule-group name.

Remarks

Use this to attach the schedule to an already-managed group. Create reusable groups with AwsEventbridgeScheduleGroup.

`kmsKeyArn: Input<string | undefined>`

Inherited from kmsKeyArn

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

`name: string`

Required scheduler purpose name used in the AWS naming pattern.

`namePrefix: Input<string | undefined>`

Inherited from namePrefix

Creates a unique name beginning with the specified prefix. Conflicts with name.

`region: Input<string | undefined>`

Inherited from region

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

`scheduleExpression: Input<string>`

Inherited from scheduleExpression

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

`scheduleExpressionTimezone: Input<string | undefined>`

Inherited from scheduleExpressionTimezone

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

`startDate: Input<string | undefined>`

Inherited from startDate

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 start date you specify. EventBridge Scheduler ignores the start date for one-time schedules. Example: 2030-01-01T01:00:00Z.

`state: Input<string | undefined>`

Inherited from state

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

`target: Input<ScheduleTarget>`

Inherited from target

Configures the target of the schedule. Detailed below.

The following arguments are optional: